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;
021import static org.tquadrat.foundation.lang.Objects.requireNonNullArgument;
022import static org.tquadrat.foundation.value.Area.SQUARE_METER;
023
024import java.io.Serial;
025import java.math.BigDecimal;
026import java.util.function.BiPredicate;
027
028import org.apiguardian.api.API;
029import org.tquadrat.foundation.annotation.ClassVersion;
030import org.tquadrat.foundation.value.api.ValueBase;
031
032/**
033 *  A value class for areas.
034 *
035 *  @extauthor Thomas Thrien - thomas.thrien@tquadrat.org
036 *  @version $Id: AreaValue.java 1073 2023-10-01 11:08:51Z tquadrat $
037 *  @since 0.1.0
038 *
039 *  @UMLGraph.link
040 */
041@ClassVersion( sourceVersion = "$Id: AreaValue.java 1073 2023-10-01 11:08:51Z tquadrat $" )
042@API( status = STABLE, since = "0.1.0" )
043public final class AreaValue extends ValueBase<Area, AreaValue>
044{
045        /*-----------*\
046    ====** Constants **========================================================
047        \*-----------*/
048    /**
049     *  <p>{@summary The validator for areas.}</p>
050     *  An area may not be less than 0.
051     */
052    private static final BiPredicate<Area, BigDecimal> AREA_VALIDATOR = ( unit, value) -> !(value.signum() < 0);
053
054        /*------------------------*\
055    ====** Static Initialisations **===========================================
056        \*------------------------*/
057    /**
058     *  The serial version UID for objects of this class: {@value}.
059     *
060     *  @hidden
061     */
062    @Serial
063    private static final long serialVersionUID = 1729884766468723788L;
064
065        /*--------------*\
066    ====** Constructors **=====================================================
067        \*--------------*/
068    /**
069     *  Creates a new {@code AreaValue} instance.
070     *
071     *  @param  dimension   The dimension.
072     *  @param  value   The value.
073     */
074    public AreaValue( final Area dimension, final BigDecimal value )
075    {
076        //---* Daddy's performing the null check ... *-------------------------
077        super( dimension, value, AREA_VALIDATOR );
078    }   //  AreaValue()
079
080    /**
081     *  Creates a new {@code AreaValue} instance.
082     *
083     *  @param  dimension   The dimension.
084     *  @param  value   The value; it must be possible to parse the given
085     *      String into a
086     *      {@link BigDecimal}.
087     *  @throws NumberFormatException   The provided value cannot be converted
088     *      into a {@code BigDecimal}.
089     */
090    public AreaValue( final Area dimension, final String value ) throws NumberFormatException
091    {
092        //---* Daddy's performing the null check ... *-------------------------
093        super( dimension, value, AREA_VALIDATOR );
094    }   //  AreaValue()
095
096    /**
097     *  Creates a new {@code AreaValue} instance.
098     *
099     *  @param  <N> The type of {@code value}.
100     *  @param  dimension   The dimension.
101     *  @param  value   The value.
102     */
103    public <N extends Number> AreaValue( final Area dimension, final N value )
104    {
105        //---* Daddy's performing the null check ... *-------------------------
106        super( dimension, value, AREA_VALIDATOR );
107    }   //  AreaValue()
108
109    /**
110     *  <p>{@summary Creates a new {@code AreaValue} instance.} An area can be
111     *  determined by multiplication of length and width.</p>
112     *
113     *  @param  dimension   The dimension.
114     *  @param  length  The length.
115     *  @param  width   The width.
116     */
117    @SuppressWarnings( "UseOfConcreteClass" )
118    public AreaValue( final Area dimension, final LengthValue length, final LengthValue width )
119    {
120        super( SQUARE_METER, requireNonNullArgument( length, "length" ).baseValue().multiply( requireNonNullArgument( width, "width" ).baseValue() ), AREA_VALIDATOR );
121        setUnit( requireNonNullArgument( dimension, "dimension" ) );
122    }   //  AreaValue()
123
124        /*---------*\
125    ====** Methods **==========================================================
126        \*---------*/
127    /**
128     *  {@inheritDoc}
129     */
130    @Override
131    public final AreaValue clone()
132    {
133        @SuppressWarnings( "cast" )
134        final var retValue = super.clone();
135
136        //---* Done *----------------------------------------------------------
137        return retValue;
138    }   //  clone()
139}
140//  class AreaValue
141
142/*
143 *  End of File
144 */