001/*
002 * ============================================================================
003 * Copyright © 2002-2023 by Thomas Thrien.
004 * All Rights Reserved.
005 * ============================================================================
006 *
007 * Licensed to the public under the agreements of the GNU Lesser General Public
008 * License, version 3.0 (the "License"). You may obtain a copy of the License at
009 *
010 *      http://www.gnu.org/licenses/lgpl.html
011 *
012 * Unless required by applicable law or agreed to in writing, software
013 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
014 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
015 * License for the specific language governing permissions and limitations
016 * under the License.
017 */
018
019package org.tquadrat.foundation.util.stringconverter;
020
021import static org.apiguardian.api.API.Status.STABLE;
022import static org.tquadrat.foundation.lang.Objects.nonNull;
023
024import java.io.Serial;
025import java.util.Currency;
026
027import org.apiguardian.api.API;
028import org.tquadrat.foundation.annotation.ClassVersion;
029import org.tquadrat.foundation.lang.StringConverter;
030
031/**
032 *  <p>{@summary An implementation of
033 *  {@link StringConverter}
034 *  for
035 *  {@link Currency}
036 *  values.}</p>
037 *  <p>The method
038 *  {@link #fromString(CharSequence)}
039 *  will use
040 *  {@link Currency#getInstance(String)}
041 *  to retrieve a {@code Currency} based on the given ISO&nbsp;4217 code.}.</p>
042 *  <p>The method
043 *  {@link #toString(Currency)}
044 *  will use
045 *  {@link Currency#getCurrencyCode()}
046 *  to return the ISO&nbsp;4217 code to the given {@code Currency}
047 *  instance.</p>
048 *
049 *  @extauthor Thomas Thrien - thomas.thrien@tquadrat.org
050 *  @version $Id: CurrencyStringConverter.java 1060 2023-09-24 19:21:40Z tquadrat $
051 *  @since 0.0.6
052 *
053 *  @UMLGraph.link
054 */
055@ClassVersion( sourceVersion = "$Id: CurrencyStringConverter.java 1060 2023-09-24 19:21:40Z tquadrat $" )
056@API( status = STABLE, since = "0.1.0" )
057public final class CurrencyStringConverter implements StringConverter<Currency>
058{
059        /*------------------------*\
060    ====** Static Initialisations **===========================================
061        \*------------------------*/
062    /**
063     *  The serial version UID for objects of this class: {@value}.
064     *
065     *  @hidden
066     */
067    @Serial
068    private static final long serialVersionUID = 1L;
069
070    /**
071     *  An instance of this class.
072     */
073    public static final CurrencyStringConverter INSTANCE = new CurrencyStringConverter();
074
075        /*--------------*\
076    ====** Constructors **=====================================================
077        \*--------------*/
078    /**
079     *  Creates a new instance of {@code CurrencyStringConverter}.
080     */
081    public CurrencyStringConverter() {}
082
083        /*---------*\
084    ====** Methods **==========================================================
085        \*---------*/
086    /**
087     *  {@inheritDoc}
088     */
089    @Override
090    public final Currency fromString( final CharSequence source ) throws IllegalArgumentException
091    {
092        final var retValue = nonNull( source ) ? Currency.getInstance( source.toString() ) : null;
093
094        //---* Done *----------------------------------------------------------
095        return retValue;
096    }   //  fromString()
097
098    /**
099     *  This method is used by the
100     *  {@link java.util.ServiceLoader}
101     *  to obtain the instance for this
102     *  {@link StringConverter}
103     *  implementation.
104     *
105     *  @return The instance for this {@code StringConverter} implementation.
106     */
107    public static final CurrencyStringConverter provider() { return INSTANCE; }
108
109    /**
110     *  {@inheritDoc}
111     */
112    @Override
113    public final String toString( final Currency source )
114    {
115        final var retValue = nonNull( source ) ? source.getCurrencyCode() : null;
116
117        //---* Done *----------------------------------------------------------
118        return retValue;
119    }   //  toString()
120}
121//  class ZoneIdStringConverter
122
123/*
124 *  End of File
125 */