001/*
002 * ============================================================================
003 * Copyright © 2002-2020 by Thomas Thrien.
004 * All Rights Reserved.
005 * ============================================================================
006 *
007 * Licensed to the public under the agreements of the GNU Lesser General Public
008 * License, version 3.0 (the "License"). You may obtain a copy of the License at
009 *
010 *      http://www.gnu.org/licenses/lgpl.html
011 *
012 * Unless required by applicable law or agreed to in writing, software
013 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
014 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
015 * License for the specific language governing permissions and limitations
016 * under the License.
017 */
018
019package org.tquadrat.foundation.util.stringconverter;
020
021import static org.apiguardian.api.API.Status.STABLE;
022
023import java.io.Serial;
024
025import org.apiguardian.api.API;
026import org.tquadrat.foundation.annotation.ClassVersion;
027import org.tquadrat.foundation.lang.StringConverter;
028import org.tquadrat.foundation.lang.internal.DefaultEnumStringConverter;
029
030/**
031 *  An implementation of
032 *  {@link StringConverter}
033 *  for types that are derived from
034 *  {@link Enum}.
035 *  This class can be used as is, or as base class for the implementation of
036 *  {@code StringConverter} for a specific {@code enum}. A sample for the
037 *  latter are the {@code StringConverter} implementations for
038 *  {@link java.time.DayOfWeek}
039 *  ({@link DayOfWeekStringConverter})
040 *  and
041 *  {@link java.time.Month}
042 *  ({@link MonthStringConverter}).
043 *
044 *  @param  <T> The concrete data type that is handled by this String converter
045 *      implementation.
046 *
047 *  @extauthor Thomas Thrien - thomas.thrien@tquadrat.org
048 *  @version $Id: EnumStringConverter.java 820 2020-12-29 20:34:22Z tquadrat $
049 *  @since 0.0.6
050 *
051 *  @UMLGraph.link
052 */
053@ClassVersion( sourceVersion = "$Id: EnumStringConverter.java 820 2020-12-29 20:34:22Z tquadrat $" )
054@API( status = STABLE, since = "0.0.6" )
055public class EnumStringConverter<T extends Enum<T>> extends DefaultEnumStringConverter<T>
056{
057        /*------------------------*\
058    ====** Static Initialisations **===========================================
059        \*------------------------*/
060    /**
061     *  The serial version UID for objects of this class: {@value}.
062     *
063     *  @hidden
064     */
065    @Serial
066    private static final long serialVersionUID = 1L;
067
068        /*--------------*\
069    ====** Constructors **=====================================================
070        \*--------------*/
071    /**
072     *  Creates a new {@code EnumValueHandler} instance.
073     *
074     *  @param  enumType    The data type for the property.
075     */
076    public EnumStringConverter( final Class<T> enumType ) { super( enumType ); }
077}
078//  class EnumStringConverter
079
080/*
081 *  End of File
082 */