001    package biweekly.property;
002    
003    import java.util.Collection;
004    import java.util.List;
005    
006    import biweekly.Warning;
007    import biweekly.component.ICalComponent;
008    
009    /*
010     Copyright (c) 2013, 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     * Parent class for properties that have a defined set of acceptable values (for
036     * example, {@link Action}).
037     * @author Michael Angstadt
038     */
039    public abstract class EnumProperty extends TextProperty {
040            /**
041             * Creates an enum property.
042             * @param value the property value
043             */
044            public EnumProperty(String value) {
045                    super(value);
046            }
047    
048            /**
049             * Compares the property's value with a given string (case-insensitive).
050             * @param value the string
051             * @return true if it's equal, false if not
052             */
053            protected boolean is(String value) {
054                    return value.equalsIgnoreCase(this.value);
055            }
056    
057            /**
058             * Gets the list of acceptable values for this property.
059             * @return the list of acceptable values
060             */
061            protected abstract Collection<String> getStandardValues();
062    
063            @Override
064            protected void validate(List<ICalComponent> components, List<Warning> warnings) {
065                    super.validate(components, warnings);
066                    if (value == null) {
067                            return;
068                    }
069    
070                    Collection<String> standardValues = getStandardValues();
071                    for (String standardValue : standardValues) {
072                            if (value.equalsIgnoreCase(standardValue)) {
073                                    //found, value is OK
074                                    return;
075                            }
076                    }
077    
078                    warnings.add(Warning.validate(28, value, standardValues));
079            }
080    }