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.lang.String.format;
021import static java.util.Arrays.stream;
022import static org.apiguardian.api.API.Status.STABLE;
023import static org.tquadrat.foundation.lang.Objects.requireNotEmptyArgument;
024
025import java.math.BigDecimal;
026
027import org.apiguardian.api.API;
028import org.tquadrat.foundation.annotation.ClassVersion;
029import org.tquadrat.foundation.value.api.DimensionWithLinearConversion;
030
031/**
032 *  The various instances of force …
033 *
034 *  @extauthor Thomas Thrien - thomas.thrien@tquadrat.org
035 *  @version $Id: Force.java 1073 2023-10-01 11:08:51Z tquadrat $
036 *  @since 0.3.0
037 *
038 *  @UMLGraph.link
039 */
040@SuppressWarnings( "NewClassNamingConvention" )
041@ClassVersion( sourceVersion = "$Id: Force.java 1073 2023-10-01 11:08:51Z tquadrat $" )
042@API( status = STABLE, since = "0.3.0" )
043public enum Force implements DimensionWithLinearConversion
044{
045        /*------------------*\
046    ====** Enum Declaration **=================================================
047        \*------------------*/
048    /**
049     *  A micro Newton.
050     */
051    MICRONEWTON( new BigDecimal( "1E-6" ), "µN", 1 ),
052
053    /**
054     *  <p>{@summary A dyn.}</p>
055     *  <p>This is the unit of force in the CGS unit system.</p>
056     */
057    DYN( new BigDecimal( "1E-5" ), "dyn", 1 ),
058
059    /**
060     *  A pond
061     */
062    POND( new BigDecimal( "0.00980665" ), "p" ),
063
064    /**
065     *  A Newton.
066     */
067    NEWTON( BigDecimal.ONE, "N", 1 ),
068
069    /**
070     *  A kilo pond
071     */
072    KILOPOND( new BigDecimal( "9.80665" ), "kp" ),
073
074    /**
075     *  A kilo Newton.
076     */
077    KILONEWTON( new BigDecimal( "1000" ), "kN", 1 ),
078
079    /**
080     *  A Mega pond
081     */
082    MEGAPOND( new BigDecimal( "9806.65" ), "Mp" );
083
084        /*------------*\
085    ====** Attributes **=======================================================
086        \*------------*/
087    /**
088     *  The factor.
089     */
090    private final BigDecimal m_Factor;
091
092    /**
093     *  The default precision.
094     */
095    private final int m_Precision;
096
097    /**
098     *  The unit string.
099     */
100    private final String m_UnitSymbol;
101
102        /*--------------*\
103    ====** Constructors **=====================================================
104        \*--------------*/
105    /**
106     *  Creates a new {@code Force} instance, with a default precision of zero
107     *  mantissa digits.
108     *
109     *  @param  factor  The factor.
110     *  @param  unitSymbol    The unit symbol String.
111     */
112    private Force( final BigDecimal factor, final String unitSymbol )
113    {
114        this( factor, unitSymbol, 0 );
115    }   //  Force()
116
117    /**
118     *  Creates a new {@code Force} instance.
119     *
120     *  @param  factor  The factor.
121     *  @param  unitSymbol    The unit symbol String.
122     *  @param  precision   The default precision.
123     */
124    private Force( final BigDecimal factor, final String unitSymbol, final int precision )
125    {
126        m_Factor = factor.stripTrailingZeros();
127        m_UnitSymbol = unitSymbol;
128        m_Precision = precision;
129    }   //  Force()
130
131        /*---------*\
132    ====** Methods **==========================================================
133        \*---------*/
134    /**
135     *  {@inheritDoc}
136     */
137    @Override
138    @SuppressWarnings( "unchecked" )
139    public final Force baseUnit() { return NEWTON; }
140
141    /**
142     *  {@inheritDoc}
143     */
144    @Override
145    public final BigDecimal factor() { return m_Factor; }
146
147    /**
148     *  Returns the {@code Force} instance for the given unit symbol.
149     *
150     *  @param  unitSymbol  The unit symbol.
151     *  @return The respective instance.
152     *  @throws IllegalArgumentException    The given unit is unknown.
153     */
154    public static final Force forUnit( final String unitSymbol ) throws IllegalArgumentException
155    {
156        requireNotEmptyArgument( unitSymbol, "unitSymbol" );
157
158        final var retValue = stream( values() )
159            .filter( v -> v.unitSymbol().equals( unitSymbol ) )
160            .findFirst()
161            .orElseThrow( () -> new IllegalArgumentException( format( MSG_UnknownUnit, unitSymbol ) ) );
162
163        //---* Done *----------------------------------------------------------
164        return retValue;
165    }   //  forUnit()
166
167    /**
168     *  {@inheritDoc}
169     */
170    @Override
171    public final int getPrecision() { return m_Precision; }
172
173    /**
174     *  {@inheritDoc}
175     */
176    @Override
177    public final String unitSymbol() { return m_UnitSymbol; }
178}
179//  enum Force
180
181/*
182 *  End of File
183 */