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