001/*
002 * ============================================================================
003 * Copyright © 2002-2023 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;
027
028/**
029 *  The implementation of
030 *  {@link NumberStringConverter}
031 *  for {@code float}
032 *  and
033 *  {@link java.lang.Float}.<br>
034 *  <br>The {@code float} literals are expected in the format as they are
035 *  emitted by
036 *  {@link Float#toString(float)};
037 *  in particular, it expects decimal points instead of decimal commas for each
038 *  locale.
039 *
040 *  @extauthor Thomas Thrien - thomas.thrien@tquadrat.org
041 *  @version $Id: FloatStringConverter.java 1060 2023-09-24 19:21:40Z tquadrat $
042 *  @since 0.0.6
043 *
044 *  @UMLGraph.link
045 */
046@ClassVersion( sourceVersion = "$Id: FloatStringConverter.java 1060 2023-09-24 19:21:40Z tquadrat $" )
047@API( status = STABLE, since = "0.0.6" )
048public final class FloatStringConverter extends NumberStringConverter<Float>
049{
050        /*------------------------*\
051    ====** Static Initialisations **===========================================
052        \*------------------------*/
053    /**
054     *  The serial version UID for objects of this class: {@value}.
055     *
056     *  @hidden
057     */
058    @Serial
059    private static final long serialVersionUID = 1L;
060
061    /**
062     *  An instance of this class.
063     */
064    public static final FloatStringConverter INSTANCE = new FloatStringConverter();
065
066        /*--------------*\
067    ====** Constructors **=====================================================
068        \*--------------*/
069    /**
070     *  Creates a new instance of {@code FloatStringConverter}.
071     */
072    public FloatStringConverter() { super( float.class, Float.class ); }
073
074        /*---------*\
075    ====** Methods **==========================================================
076        \*---------*/
077    /**
078     *  {@inheritDoc}
079     */
080    @Override
081    protected final Float parseNumber( final String value ) throws NumberFormatException
082    {
083        return Float.valueOf( value );
084    }   //  parseNumber()
085
086    /**
087     *  This method is used by the
088     *  {@link java.util.ServiceLoader}
089     *  to obtain the instance for this
090     *  {@link org.tquadrat.foundation.lang.StringConverter}
091     *  implementation.
092     *
093     *  @return The instance for this {@code StringConverter} implementation.
094     */
095    public static final FloatStringConverter provider() { return INSTANCE; }
096}
097//  class FloatStringConverter
098
099/*
100 *  End of File
101 */