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