001/*
002 * ============================================================================
003 * Copyright © 2002-2024 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;
024import java.time.MonthDay;
025import java.time.format.DateTimeFormatter;
026import java.time.format.DateTimeParseException;
027import java.util.Optional;
028
029import org.apiguardian.api.API;
030import org.tquadrat.foundation.annotation.ClassVersion;
031
032/**
033 *  The implementation of
034 *  {@link TimeDateStringConverter}
035 *  for {@code java.time.MonthDay}.
036 *
037 *  @extauthor Thomas Thrien - thomas.thrien@tquadrat.org
038 *  @version $Id: MonthDayStringConverter.java 1130 2024-05-05 16:16:09Z tquadrat $
039 *  @since 0.4.6
040 *
041 *  @UMLGraph.link
042 */
043@ClassVersion( sourceVersion = "$Id: MonthDayStringConverter.java 1130 2024-05-05 16:16:09Z tquadrat $" )
044@API( status = STABLE, since = "0.4.6" )
045public class MonthDayStringConverter extends TimeDateStringConverter<MonthDay>
046{
047        /*------------------------*\
048    ====** Static Initialisations **===========================================
049        \*------------------------*/
050    /**
051     *  The serial version UID for objects of this class: {@value}.
052     *
053     *  @hidden
054     */
055    @Serial
056    private static final long serialVersionUID = 1L;
057
058    /**
059     *  An instance of this class.
060     */
061    public static final MonthDayStringConverter INSTANCE = new MonthDayStringConverter();
062
063        /*--------------*\
064    ====** Constructors **=====================================================
065        \*--------------*/
066    /**
067     *  Creates a new {@code MonthDayStringConverter} instance.
068     */
069    public MonthDayStringConverter() { super( MonthDay.class ); }
070
071    /**
072     *  Creates a new {@code MonthDayStringConverter} instance.
073     *
074     *  @note The formatter may not drop neither month nor day, otherwise
075     *      {@code fromString()} may fail. This means that the formatter is
076     *      only allowed to re-order the temporal fields.
077     *
078     *  @param  formatter   The formatter for the temporal accessor.
079     */
080    public MonthDayStringConverter( final DateTimeFormatter formatter )
081    {
082        super( MonthDay.class, formatter );
083    }   //  MonthDayStringConverter()
084
085        /*---------*\
086    ====** Methods **==========================================================
087        \*---------*/
088    /**
089     *  {@inheritDoc}
090     */
091    @Override
092    protected final MonthDay parseDateTime( final CharSequence source, final Optional<DateTimeFormatter> formatter ) throws DateTimeParseException
093    {
094        final var retValue = formatter.map( dateTimeFormatter -> MonthDay.parse( source, dateTimeFormatter ) ).orElse( MonthDay.parse( source ) );
095
096        //---* Done *----------------------------------------------------------
097        return retValue;
098    }   //  parseDateTime()
099
100    /**
101     *  This method is used by the
102     *  {@link java.util.ServiceLoader}
103     *  to obtain the instance for this
104     *  {@link org.tquadrat.foundation.lang.StringConverter}
105     *  implementation.
106     *
107     *  @return The instance for this {@code StringConverter} implementation.
108     */
109    public static final MonthDayStringConverter provider() { return INSTANCE; }
110}
111//  class MonthDayStringConverter
112
113/*
114 *  End of File
115 */