001/*
002 * ============================================================================
003 *  Copyright © 2002-2024 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.fx.css;
019
020import static org.apiguardian.api.API.Status.INTERNAL;
021import static org.apiguardian.api.API.Status.STABLE;
022import static org.tquadrat.foundation.util.DateTimeUtils.getZoneIdAliasMap;
023import static org.tquadrat.foundation.util.DateTimeUtils.retrieveCachedZoneId;
024
025import java.time.ZoneId;
026
027import org.apiguardian.api.API;
028import org.tquadrat.foundation.annotation.ClassVersion;
029import org.tquadrat.foundation.annotation.UtilityClass;
030import org.tquadrat.foundation.exception.PrivateConstructorForStaticClassCalledError;
031import javafx.css.ParsedValue;
032import javafx.css.StyleConverter;
033import javafx.scene.text.Font;
034
035/**
036 *  An implementation of
037 *  {@link javafx.css.StyleConverter}
038 *  for time zones (more precise, for
039 *  {@link ZoneId}s).
040 *
041 *  @extauthor Thomas Thrien - thomas.thrien@tquadrat.org
042 *  @version $Id: TimeZoneConverter.java 1116 2024-03-13 15:44:33Z tquadrat $
043 *  @since 0.4.6
044 *
045 *  @UMLGraph.link
046 */
047@ClassVersion( sourceVersion = "$Id: TimeZoneConverter.java 1116 2024-03-13 15:44:33Z tquadrat $" )
048@API( status = STABLE, since = "0.4.6" )
049public final class TimeZoneConverter extends StyleConverter<String,ZoneId>
050{
051        /*---------------*\
052    ====** Inner Classes **====================================================
053        \*---------------*/
054    /**
055     *  The instance holder for this class.
056     *
057     *  @extauthor Thomas Thrien - thomas.thrien@tquadrat.org
058     *  @version $Id: TimeZoneConverter.java 1116 2024-03-13 15:44:33Z tquadrat $
059     *  @since 0.4.6
060     */
061    @ClassVersion( sourceVersion = "$Id: TimeZoneConverter.java 1116 2024-03-13 15:44:33Z tquadrat $" )
062    @API( status = INTERNAL, since = "0.4.6" )
063    @UtilityClass
064    private static final class Holder
065    {
066            /*------------------------*\
067        ====** Static Initialisations **===========================================
068            \*------------------------*/
069        /**
070         *  The one and only instance of
071         *  {@link TimeZoneConverter}.
072         */
073        static final TimeZoneConverter INSTANCE = new TimeZoneConverter();
074
075            /*--------------*\
076        ====** Constructors **=====================================================
077            \*--------------*/
078        /**
079         *  No instance allowed for this class!
080         */
081        private Holder() { throw new PrivateConstructorForStaticClassCalledError( Holder.class ); }
082    }
083    //  class Holder
084
085        /*--------------*\
086    ====** Constructors **=====================================================
087        \*--------------*/
088    /**
089     *  Creates a new instance of {@code TimeZoneConverter}.
090     */
091    private TimeZoneConverter() { /* Just exists */ }
092
093        /*---------*\
094    ====** Methods **==========================================================
095        \*---------*/
096    /**
097     *  {@inheritDoc}
098     */
099    @Override
100    public final ZoneId convert( final ParsedValue<String,ZoneId> value, final Font font )
101    {
102        final var retValue = retrieveCachedZoneId( (String) value.getValue(), getZoneIdAliasMap() );
103
104        //---* Done *----------------------------------------------------------
105        return retValue;
106    }   //  convert()
107
108    /**
109     *  Returns a reference to the one and only instance of
110     *   {@code TimeZoneConverter}.
111     *
112     *  @return The time zone converter.
113     */
114    public static final StyleConverter<String,ZoneId> getInstance() { return Holder.INSTANCE; }
115
116    /**
117     *  {@inheritDoc}
118     */
119    @Override
120    public final String toString() { return "TimeZoneConverter";  }
121}
122//  class TimeZoneConverter
123
124/*
125 *  End of File
126 */