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 power …
033 *
034 *  @extauthor Thomas Thrien - thomas.thrien@tquadrat.org
035 *  @version $Id: Power.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: Power.java 1073 2023-10-01 11:08:51Z tquadrat $" )
042@API( status = STABLE, since = "0.3.0" )
043public enum Power implements DimensionWithLinearConversion
044{
045        /*------------------*\
046    ====** Enum Declaration **=================================================
047        \*------------------*/
048    /**
049     *  <p>{@summary An erg per second.}</p>
050     *  <p>This is the unit of power in the CGS unit system.</p>
051     */
052    ERG_PER_SECOND( new BigDecimal( "1E-7" ), "erg/s" ),
053
054    /**
055     *  A micro Watt.
056     */
057    MICROWATT( new BigDecimal( "1E-6" ), "µW" ),
058
059    /**
060     *  A milli Watt.
061     */
062    MILLIWATT( new BigDecimal( "1E-3" ), "mW" ),
063
064    /**
065     *  A Watt.
066     */
067    WATT( BigDecimal.ONE, "W", 1 ),
068
069    /**
070     *  A 'horsepower'.
071     */
072    HORSE_POWER( new BigDecimal( "735.49875" ), "HP" ),
073
074    /**
075     *  A kilo Watt.
076     */
077    KILOWATT( new BigDecimal( "1000" ), "kW", 1 ),
078
079    /**
080     *  A kilo Watt.
081     */
082    MEGAWATT( new BigDecimal( "1E+6" ), "MW", 1 ),
083
084    /**
085     *  A giga Watt.
086     */
087    GIGAWATT( new BigDecimal( "1E+9" ), "GW", 1 ),
088
089    /**
090     *  A Tera Watt.
091     */
092    TERAWATT( new BigDecimal( "1E+12" ), "TW", 1 );
093
094        /*------------*\
095    ====** Attributes **=======================================================
096        \*------------*/
097    /**
098     *  The factor.
099     */
100    private final BigDecimal m_Factor;
101
102    /**
103     *  The default precision.
104     */
105    private final int m_Precision;
106
107    /**
108     *  The unit string.
109     */
110    private final String m_UnitSymbol;
111
112        /*--------------*\
113    ====** Constructors **=====================================================
114        \*--------------*/
115    /**
116     *  Creates a new {@code Power} instance, with a default precision of zero
117     *  mantissa digits.
118     *
119     *  @param  factor  The factor.
120     *  @param  unitSymbol    The unit symbol String.
121     */
122    private Power( final BigDecimal factor, final String unitSymbol )
123    {
124        this( factor, unitSymbol, 0 );
125    }   //  Power()
126
127    /**
128     *  Creates a new {@code Power} instance.
129     *
130     *  @param  factor  The factor.
131     *  @param  unitSymbol    The unit symbol String.
132     *  @param  precision   The default precision.
133     */
134    private Power( final BigDecimal factor, final String unitSymbol, final int precision )
135    {
136        m_Factor = factor.stripTrailingZeros();
137        m_UnitSymbol = unitSymbol;
138        m_Precision = precision;
139    }   //  Power()
140
141        /*---------*\
142    ====** Methods **==========================================================
143        \*---------*/
144    /**
145     *  {@inheritDoc}
146     */
147    @Override
148    @SuppressWarnings( "unchecked" )
149    public final Power baseUnit() { return WATT; }
150
151    /**
152     *  {@inheritDoc}
153     */
154    @Override
155    public final BigDecimal factor() { return m_Factor; }
156
157    /**
158     *  Returns the {@code Power} instance for the given unit symbol.
159     *
160     *  @param  unitSymbol  The unit symbol.
161     *  @return The respective instance.
162     *  @throws IllegalArgumentException    The given unit is unknown.
163     */
164    public static final Power forUnit( final String unitSymbol ) throws IllegalArgumentException
165    {
166        requireNotEmptyArgument( unitSymbol, "unitSymbol" );
167
168        final var retValue = stream( values() )
169            .filter( v -> v.unitSymbol().equals( unitSymbol ) )
170            .findFirst()
171            .orElseThrow( () -> new IllegalArgumentException( format( MSG_UnknownUnit, unitSymbol ) ) );
172
173        //---* Done *----------------------------------------------------------
174        return retValue;
175    }   //  forUnit()
176
177    /**
178     *  {@inheritDoc}
179     */
180    @Override
181    public final int getPrecision() { return m_Precision; }
182
183    /**
184     *  {@inheritDoc}
185     */
186    @Override
187    public final String unitSymbol() { return m_UnitSymbol; }
188}
189//  enum Power
190
191/*
192 *  End of File
193 */