001    /*
002     * Jpkg - Java library and tools for operating system package creation.
003     *
004     * Copyright (c) 2007-2008 Three Rings Design, Inc.
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
009     * are met:
010     * 1. Redistributions of source code must retain the above copyright
011     *    notice, this list of conditions and the following disclaimer.
012     * 2. Redistributions in binary form must reproduce the above copyright
013     *    notice, this list of conditions and the following disclaimer in the
014     *    documentation and/or other materials provided with the distribution.
015     * 3. Neither the name of the copyright owner nor the names of contributors
016     *    may be used to endorse or promote products derived from this software
017     *    without specific prior written permission.
018     *
019     * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
020     * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
021     * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
022     * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
023     * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
024     * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
025     * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
026     * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
027     * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
028     * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
029     * POSSIBILITY OF SUCH DAMAGE.
030     */
031    package com.threerings.antidote.field.text;
032    
033    import com.threerings.antidote.property.EnumProperty;
034    
035    import static com.threerings.antidote.MutabilityHelper.requiresValidation;
036    
037    
038    public abstract class EnumTextField<T extends Enum<T>> extends SingleLineTextField
039    {
040        public EnumTextField (Class<T> enumClass)
041        {
042            _enumClass = enumClass;
043        }
044    
045        /**
046         * Returns the user data converted into an enum. Cannot be called before validate().
047         */
048        public T getEnum ()
049        {
050            requiresValidation(_enum);
051            return _enum;
052        }
053    
054        @Override // from SingleLineTextField
055        protected final void validateTextField ()
056        {
057            // store the text data in an enum property for validation.
058            // TODO: the InvalidEnumViolation mentions properties. Revisit this.
059            final EnumProperty<T> property = new EnumProperty<T>("text field", this, _enumClass);
060            property.setValue(getText());
061    
062            switch (validateProperties(property)) {
063                case ALL_INVALID:
064                case SOME_INVALID:
065                    return;
066    
067                case ALL_VALID:
068                    _enum = property.getValue();
069                    return;
070            }
071        }
072    
073        /** The enum after it has been validated. */
074        private T _enum;
075    
076        /** The class for the enum expected in this text field. */
077        private final Class<T> _enumClass;
078    }