001/*
002 * ============================================================================
003 *  Copyright © 2002-2021 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.config.cli;
019
020import static org.apiguardian.api.API.Status.INTERNAL;
021
022import java.time.Year;
023import java.util.Optional;
024import java.util.function.BiConsumer;
025
026import org.apiguardian.api.API;
027import org.tquadrat.foundation.annotation.ClassVersion;
028import org.tquadrat.foundation.config.spi.CLIDefinition;
029import org.tquadrat.foundation.util.stringconverter.TimeDateStringConverter;
030import org.tquadrat.foundation.util.stringconverter.YearStringConverter;
031
032/**
033 *  The implementation of
034 *  {@link TimeValueHandler}
035 *  for
036 *  {@link java.time.Year}.
037 *
038 *  @extauthor Thomas Thrien - thomas.thrien@tquadrat.org
039 *  @version $Id: YearValueHandler.java 896 2021-04-05 20:25:33Z tquadrat $
040 *  @since 0.0.1
041 *
042 *  @UMLGraph.link
043 */
044@ClassVersion( sourceVersion = "$Id: YearValueHandler.java 896 2021-04-05 20:25:33Z tquadrat $" )
045@API( status = INTERNAL, since = "0.0.1" )
046public final class YearValueHandler extends TimeValueHandler<Year>
047{
048        /*--------------*\
049    ====** Constructors **=====================================================
050        \*--------------*/
051    /**
052     *  Creates a new {@code YearValueHandler} instance.
053     *
054     *  @param  context The CLI definition that provides the context for this
055     *      value handler.
056     *  @param  valueSetter The
057     *      {@link BiConsumer Consumer}
058     *      that places the translated value to the property.
059     */
060    public YearValueHandler( final CLIDefinition context, final BiConsumer<String,Year> valueSetter )
061    {
062        super( context, valueSetter, YearStringConverter.INSTANCE );
063    }   //  YearValueHandler()
064
065    /**
066     *  Creates a new {@code YearValueHandler} instance.
067     *
068     *  @param  valueSetter The
069     *      {@link BiConsumer Consumer}
070     *      that places the translated value to the property.
071     */
072    public YearValueHandler( final BiConsumer<String,Year> valueSetter )
073    {
074        super( valueSetter, YearStringConverter.INSTANCE );
075    }   //  YearValueHandler()
076
077        /*---------*\
078    ====** Methods **==========================================================
079        \*---------*/
080    /**
081     *  {@inheritDoc}
082     */
083    @Override
084    protected Optional<TimeDateStringConverter<Year>> createCustomStringConverter()
085    {
086        final Optional<TimeDateStringConverter<Year>> retValue = getFormatter().map( YearStringConverter::new );
087
088        //---* Done *----------------------------------------------------------
089        return retValue;
090    }   //  createCustomerConverter()
091
092    /**
093     *  {@inheritDoc}
094     */
095    @Override
096    protected final Year getNow() { return Year.now(); }
097}
098//  class YearValueHandler
099
100/*
101 *  End of File
102 */