001    package biweekly.property;
002    
003    import biweekly.util.UtcOffset;
004    
005    /*
006     Copyright (c) 2013, Michael Angstadt
007     All rights reserved.
008    
009     Redistribution and use in source and binary forms, with or without
010     modification, are permitted provided that the following conditions are met: 
011    
012     1. Redistributions of source code must retain the above copyright notice, this
013     list of conditions and the following disclaimer. 
014     2. Redistributions in binary form must reproduce the above copyright notice,
015     this list of conditions and the following disclaimer in the documentation
016     and/or other materials provided with the distribution. 
017    
018     THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
019     ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
020     WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
021     DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
022     ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
023     (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
024     LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
025     ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
026     (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
027     SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
028     */
029    
030    /**
031     * <p>
032     * Defines the timezone offset that is currently in use in a timezone
033     * observance.
034     * </p>
035     * <p>
036     * <b>Examples:</b>
037     * 
038     * <pre class="brush:java">
039     * //creating a new property
040     * TimezoneOffsetTo tzname = new TimezoneOffsetTo(-4, 0);
041     * 
042     * //usage in a VTIMEZONE component
043     * VTimezone timezone = ...
044     * StandardTime standard = new StandardTime();
045     * standard.setTimezoneOffsetTo(-4, 0);
046     * ...
047     * timezone.addStandardTime(standard);
048     * </pre>
049     * 
050     * </p>
051     * @author Michael Angstadt
052     * @rfc 5545 p.105-6
053     */
054    public class TimezoneOffsetTo extends UtcOffsetProperty {
055            /**
056             * Creates a new timezone offset to property.
057             * @param hourOffset the hour offset (e.g. "-5")
058             * @param minuteOffset the minute offset (e.g. "0")
059             */
060            public TimezoneOffsetTo(int hourOffset, int minuteOffset) {
061                    super(hourOffset, minuteOffset);
062            }
063    
064            /**
065             * Creates a new timezone offset to property.
066             * @param offset the UTC offset
067             */
068            public TimezoneOffsetTo(UtcOffset offset) {
069                    super(offset);
070            }
071    }