001package biweekly.property;
002
003/*
004 Copyright (c) 2013-2015, Michael Angstadt
005 All rights reserved.
006
007 Redistribution and use in source and binary forms, with or without
008 modification, are permitted provided that the following conditions are met: 
009
010 1. Redistributions of source code must retain the above copyright notice, this
011 list of conditions and the following disclaimer. 
012 2. Redistributions in binary form must reproduce the above copyright notice,
013 this list of conditions and the following disclaimer in the documentation
014 and/or other materials provided with the distribution. 
015
016 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
017 ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
018 WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
019 DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
020 ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
021 (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
022 LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
023 ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
024 (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
025 SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
026 */
027
028/**
029 * <p>
030 * Defines the number of times an alarm should be repeated after its initial
031 * trigger. Used in conjunction with {@link DurationProperty}, which defines the
032 * length of the pause between repeats.
033 * </p>
034 * <p>
035 * <b>Code sample:</b>
036 * 
037 * <pre class="brush:java">
038 * //repeat 5 more times after the first time
039 * VAlarm alarm = ...;
040 * alarm.setRepeat(5);
041 * </pre>
042 * 
043 * </p>
044 * @author Michael Angstadt
045 * @see <a href="http://tools.ietf.org/html/rfc5545#page-133">RFC 5545 p.133</a>
046 * @see <a href="http://tools.ietf.org/html/rfc2445#page-126">RFC 2445
047 * p.126-7</a>
048 */
049public class Repeat extends IntegerProperty {
050        /**
051         * Creates a repeat property.
052         * @param count the number of times to repeat the alarm (e.g. "2" to repeat
053         * it two more times after it was initially triggered, for a total of three
054         * times)
055         */
056        public Repeat(Integer count) {
057                super(count);
058        }
059}