001    package biweekly.parameter;
002    
003    /*
004     Copyright (c) 2013, Michael Angstadt
005     All rights reserved.
006    
007     Redistribution and use in source and binary forms, with or without
008     modification, are permitted provided that the following conditions are met: 
009    
010     1. Redistributions of source code must retain the above copyright notice, this
011     list of conditions and the following disclaimer. 
012     2. Redistributions in binary form must reproduce the above copyright notice,
013     this list of conditions and the following disclaimer in the documentation
014     and/or other materials provided with the distribution. 
015    
016     THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
017     ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
018     WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
019     DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
020     ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
021     (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
022     LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
023     ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
024     (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
025     SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
026     */
027    
028    /**
029     * Represents a value from a parameter that has a list of pre-defined values
030     * (for example, the VALUE or ACTION parameters).
031     * @author Michael Angstadt
032     */
033    public class EnumParameterValue {
034            /**
035             * The value (for example, "text").
036             */
037            protected final String value;
038    
039            /**
040             * @param value the value (e.g. "text")
041             */
042            protected EnumParameterValue(String value) {
043                    this.value = value;
044            }
045    
046            /**
047             * Gets the value of the parameter.
048             * @return the value of the parameter (e.g. "text")
049             */
050            public String getValue() {
051                    return value;
052            }
053    
054            @Override
055            public int hashCode() {
056                    final int prime = 31;
057                    int result = 1;
058                    result = prime * result + ((value == null) ? 0 : value.hashCode());
059                    return result;
060            }
061    
062            @Override
063            public boolean equals(Object obj) {
064                    if (this == obj)
065                            return true;
066                    if (obj == null)
067                            return false;
068                    if (getClass() != obj.getClass())
069                            return false;
070                    EnumParameterValue other = (EnumParameterValue) obj;
071                    if (value == null) {
072                            if (other.value != null)
073                                    return false;
074                    } else if (!value.equals(other.value))
075                            return false;
076                    return true;
077            }
078    }