001package biweekly.property;
002
003import java.util.List;
004
005import biweekly.Warning;
006import biweekly.component.ICalComponent;
007
008/*
009 Copyright (c) 2013, Michael Angstadt
010 All rights reserved.
011
012 Redistribution and use in source and binary forms, with or without
013 modification, are permitted provided that the following conditions are met: 
014
015 1. Redistributions of source code must retain the above copyright notice, this
016 list of conditions and the following disclaimer. 
017 2. Redistributions in binary form must reproduce the above copyright notice,
018 this list of conditions and the following disclaimer in the documentation
019 and/or other materials provided with the distribution. 
020
021 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
022 ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
023 WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
024 DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
025 ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
026 (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
027 LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
028 ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
029 (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
030 SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
031 */
032
033/**
034 * <p>
035 * Defines a to-do task's level of completion.
036 * </p>
037 * <p>
038 * <b>Code sample:</b>
039 * 
040 * <pre class="brush:java">
041 * VTodo todo = new VTodo();
042 * 
043 * PercentComplete percentComplete = new PercentComplete(50); //50%
044 * todo.setPercentComplete(percentComplete);
045 * </pre>
046 * 
047 * </p>
048 * @author Michael Angstadt
049 * @see <a href="http://tools.ietf.org/html/rfc5545#page-88">RFC 5545 p.88-9</a>
050 */
051public class PercentComplete extends IntegerProperty {
052        /**
053         * Creates a percent complete property.
054         * @param percent the percentage (e.g. "50" for 50%)
055         */
056        public PercentComplete(Integer percent) {
057                super(percent);
058        }
059
060        @Override
061        protected void validate(List<ICalComponent> components, List<Warning> warnings) {
062                super.validate(components, warnings);
063                if (value != null && (value < 0 || value > 100)) {
064                        warnings.add(Warning.validate(29, value));
065                }
066        }
067}