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.value;
019
020import static org.apiguardian.api.API.Status.STABLE;
021
022import java.io.Serial;
023import java.math.BigDecimal;
024
025import org.apiguardian.api.API;
026import org.tquadrat.foundation.annotation.ClassVersion;
027import org.tquadrat.foundation.value.api.ValueBase;
028
029/**
030 *  A value class for lengths.
031 *
032 *  @extauthor Thomas Thrien - thomas.thrien@tquadrat.org
033 *  @version $Id: LengthValue.java 1072 2023-09-30 20:44:38Z tquadrat $
034 *  @since 0.1.0
035 *
036 *  @UMLGraph.link
037 */
038@ClassVersion( sourceVersion = "$Id: LengthValue.java 1072 2023-09-30 20:44:38Z tquadrat $" )
039@API( status = STABLE, since = "0.1.0" )
040public final class LengthValue extends ValueBase<Length,LengthValue>
041{
042        /*------------------------*\
043    ====** Static Initialisations **===========================================
044        \*------------------------*/
045    /**
046     *  The serial version UID for objects of this class: {@value}.
047     *
048     *  @hidden
049     */
050    @Serial
051    private static final long serialVersionUID = 1729884766468723788L;
052
053        /*--------------*\
054    ====** Constructors **=====================================================
055        \*--------------*/
056    /**
057     *  Creates a new {@code LengthValue} instance.
058     *
059     *  @param  dimension   The dimension.
060     *  @param  value   The value.
061     */
062    public LengthValue( final Length dimension, final BigDecimal value )
063    {
064        //---* Daddy's performing the null check ... *-------------------------
065        //noinspection unchecked
066        super( dimension, value, DEFAULT_VALIDATOR );
067    }   //  LengthValue()
068
069    /**
070     *  Creates a new {@code LengthValue} instance.
071     *
072     *  @param  dimension   The dimension.
073     *  @param  value   The value; it must be possible to parse the given
074     *      String into a
075     *      {@link BigDecimal}.
076     *  @throws NumberFormatException   The provided value cannot be converted
077     *      into a {@code BigDecimal}.
078     */
079    public LengthValue( final Length dimension, final String value ) throws NumberFormatException
080    {
081        //---* Daddy's performing the null check ... *-------------------------
082        //noinspection unchecked
083        super( dimension, value, DEFAULT_VALIDATOR );
084    }   //  LengthValue()
085
086    /**
087     *  Creates a new {@code LengthValue} instance.
088     *
089     *  @param  <N> The type of {@code value}.
090     *  @param  dimension   The dimension.
091     *  @param  value   The value.
092     */
093    public <N extends Number> LengthValue( final Length dimension, final N value )
094    {
095        //---* Daddy's performing the null check ... *-------------------------
096        //noinspection unchecked
097        super( dimension, value, DEFAULT_VALIDATOR );
098    }   //  LengthValue()
099
100        /*---------*\
101    ====** Methods **==========================================================
102        \*---------*/
103    /**
104     *  {@inheritDoc}
105     */
106    @Override
107    public final LengthValue clone()
108    {
109        @SuppressWarnings( "cast" )
110        final var retValue = super.clone();
111
112        //---* Done *----------------------------------------------------------
113        return retValue;
114    }   //  clone()
115}
116//  class LengthValue
117
118/*
119 *  End of File
120 */