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