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 byte values, as for file sizes, disk capacities or alike.
031 *
032 *  @extauthor Thomas Thrien - thomas.thrien@tquadrat.org
033 *  @version $Id: DataSizeValue.java 1072 2023-09-30 20:44:38Z tquadrat $
034 *  @since 0.1.0
035 *
036 *  @UMLGraph.link
037 */
038@ClassVersion( sourceVersion = "$Id: DataSizeValue.java 1072 2023-09-30 20:44:38Z tquadrat $" )
039@API( status = STABLE, since = "0.1.0" )
040public final class DataSizeValue extends ValueBase<DataSize, DataSizeValue>
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 DataSizeValue} instance.
058     *
059     *  @param  dimension   The dimension.
060     *  @param  value   The value.
061     */
062    public DataSizeValue( final DataSize dimension, final BigDecimal value )
063    {
064        //noinspection unchecked
065        super( dimension, value, DEFAULT_VALIDATOR );
066    }   //  DataSizeValue()
067
068    /**
069     *  Creates a new {@code DataSizeValue} instance.
070     *
071     *  @param  dimension   The dimension.
072     *  @param  value   The value; it must be possible to parse the given
073     *      String into a
074     *      {@link BigDecimal}.
075     *  @throws NumberFormatException   The provided value cannot be converted
076     *      into a {@code BigDecimal}.
077     */
078    public DataSizeValue( final DataSize dimension, final String value ) throws NumberFormatException
079    {
080        //noinspection unchecked
081        super( dimension, value, DEFAULT_VALIDATOR );
082    }   //  DataSizeValue()
083
084    /**
085     *  Creates a new {@code DataSizeValue} instance.
086     *
087     *  @param  <N> The type of {@code value}.
088     *  @param  dimension   The dimension.
089     *  @param  value   The value.
090     */
091    public <N extends Number> DataSizeValue( final DataSize dimension, final N value )
092    {
093        //noinspection unchecked
094        super( dimension, value, DEFAULT_VALIDATOR );
095    }   //  DataSizeValue()
096
097        /*---------*\
098    ====** Methods **==========================================================
099        \*---------*/
100    /**
101     *  {@inheritDoc}
102     */
103    @Override
104    public final DataSizeValue clone()
105    {
106        @SuppressWarnings( "cast" )
107        final var retValue = super.clone();
108
109        //---* Done *----------------------------------------------------------
110        return retValue;
111    }   //  clone()
112}
113//  class DataSizeValue
114
115/*
116 *  End of File
117 */