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.value;
020
021import static org.apiguardian.api.API.Status.STABLE;
022
023import java.io.Serial;
024import java.math.BigDecimal;
025
026import org.apiguardian.api.API;
027import org.tquadrat.foundation.annotation.ClassVersion;
028import org.tquadrat.foundation.value.api.DimensionedValueStringConverter;
029
030/**
031 *  The implementation of
032 *  {@link org.tquadrat.foundation.lang.StringConverter}
033 *  for
034 *  {@link VolumeValue}
035 *  instances.
036 *
037 *  @extauthor Thomas Thrien - thomas.thrien@tquadrat.org
038 *  @version $Id: VolumeValueStringConverter.java 1073 2023-10-01 11:08:51Z tquadrat $
039 *  @since 0.1.0
040 *
041 *  @UMLGraph.link
042 */
043@ClassVersion( sourceVersion = "$Id: VolumeValueStringConverter.java 1073 2023-10-01 11:08:51Z tquadrat $" )
044@API( status = STABLE, since = "0.1.0" )
045public class VolumeValueStringConverter extends DimensionedValueStringConverter<Volume,VolumeValue>
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 VolumeValueStringConverter INSTANCE = new VolumeValueStringConverter();
062
063        /*--------------*\
064    ====** Constructors **=====================================================
065        \*--------------*/
066    /**
067     *  Creates a new instance of {@code VolumeValueStringConverter}.
068     */
069    public VolumeValueStringConverter() { super( VolumeValue.class ); }
070
071        /*---------*\
072    ====** Methods **==========================================================
073        \*---------*/
074    /**
075     *  {@inheritDoc}
076     */
077    @Override
078    protected final VolumeValue createValue( final BigDecimal number, final Volume dimension )
079    {
080        return new VolumeValue( dimension, number );
081    }   //  createValue()
082
083    /**
084     *  This method is used by the
085     *  {@link java.util.ServiceLoader}
086     *  to obtain the instance for this
087     *  {@link org.tquadrat.foundation.lang.StringConverter}
088     *  implementation.
089     *
090     *  @return The instance for this {@code StringConverter} implementation.
091     */
092    public static final VolumeValueStringConverter provider() { return INSTANCE; }
093
094    /**
095     *  {@inheritDoc}
096     */
097    @Override
098    protected Volume unitFromSymbol( final String symbol )
099    {
100        return Volume.forUnit( symbol );
101    }   //  dimensionFromUnit()
102}
103//  class VolumeValueStringConverter
104
105/*
106 *  End of File
107 */