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 * Represents a property whose data model consists of a single Java object (such
036 * as a String).
037 * @author Michael Angstadt
038 * @param <T> the value type (e.g. String)
039 */
040public class ValuedProperty<T> extends ICalProperty {
041        protected T value;
042
043        /**
044         * Creates a new valued property.
045         * @param value the property's value
046         */
047        public ValuedProperty(T value) {
048                setValue(value);
049        }
050
051        /**
052         * Gets the value of this property.
053         * @return the value
054         */
055        public T getValue() {
056                return value;
057        }
058
059        /**
060         * Sets the value of this property.
061         * @param value the value
062         */
063        public void setValue(T value) {
064                this.value = value;
065        }
066
067        @Override
068        protected void validate(List<ICalComponent> components, ICalVersion version, List<Warning> warnings) {
069                if (value == null) {
070                        warnings.add(Warning.validate(26));
071                }
072        }
073
074        /**
075         * Gets the value of a {@link ValuedProperty}.
076         * @param property the property
077         * @return the property value (may be null) or null if the property is null
078         */
079        public static <T> T getValue(ValuedProperty<T> property) {
080                return (property == null) ? null : property.getValue();
081        }
082}