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