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