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.config.cli;
019
020import static org.apiguardian.api.API.Status.INTERNAL;
021import static org.tquadrat.foundation.config.CmdLineException.MSGKEY_InvalidFileName;
022import static org.tquadrat.foundation.config.CmdLineException.MSG_InvalidFileName;
023import static org.tquadrat.foundation.lang.Objects.requireNonNullArgument;
024
025import javax.imageio.ImageIO;
026import java.awt.image.BufferedImage;
027import java.io.IOException;
028import java.util.Collection;
029import java.util.List;
030import java.util.function.BiConsumer;
031
032import org.apiguardian.api.API;
033import org.tquadrat.foundation.annotation.ClassVersion;
034import org.tquadrat.foundation.config.CmdLineException;
035import org.tquadrat.foundation.config.spi.CLIDefinition;
036import org.tquadrat.foundation.config.spi.Parameters;
037import org.tquadrat.foundation.i18n.Message;
038import org.tquadrat.foundation.i18n.Translation;
039import org.tquadrat.foundation.util.stringconverter.FileStringConverter;
040
041/**
042 *  <p>{@summary An implementation of
043 *  {@link CmdLineValueHandler}
044 *  for
045 *  {@link BufferedImage}
046 *  values.}</p>
047 *  <p>The image will be identified by the name of the respective
048 *  {@link java.io.File}
049 *  object that of course has to exist and needs to be accessible.</p>
050 *
051 *  @extauthor Thomas Thrien - thomas.thrien@tquadrat.org
052 *  @version $Id: ImageValueHandler.java 1061 2023-09-25 16:32:43Z tquadrat $
053 *  @since 0.0.1
054 *
055 *  @UMLGraph.link
056 */
057@ClassVersion( sourceVersion = "$Id: ImageValueHandler.java 1061 2023-09-25 16:32:43Z tquadrat $" )
058@API( status = INTERNAL, since = "0.0.1" )
059public final class ImageValueHandler extends CmdLineValueHandler<BufferedImage>
060{
061        /*-----------*\
062    ====** Constants **========================================================
063        \*-----------*/
064    /**
065     *  The error message for a failed read attempt for the image: {@value}.
066     */
067    public static final String MSG_ReadFailed = "Reading of the image file '%1$s' failed";
068
069    /**
070     *  The resource bundle key for the message about a failed read attempt for
071     *  the image.
072     */
073    @Message
074    (
075        description = "The error message about a failed read attempt for the image file.",
076        translations =
077        {
078            @Translation( language = "en", text = MSG_ReadFailed ),
079            @Translation( language = "de", text = "Die Bilddatei '%1$s' kann nicht gelesen werden" )
080        }
081    )
082    public static final int MSGKEY_ReadFailed = 28;
083
084        /*--------------*\
085    ====** Constructors **=====================================================
086        \*--------------*/
087    /**
088     *  Creates a new {@code ImageValueHandler} instance.
089     *
090     *  @param  context The CLI definition that provides the context for this
091     *      value handler.
092     *  @param  valueSetter The function that places the translated value to
093     *      the property.
094     */
095    public ImageValueHandler( final CLIDefinition context, final BiConsumer<String,BufferedImage> valueSetter )
096    {
097        //---* Daddy will do the null check *----------------------------------
098        super( context, valueSetter );
099    }   //  ImageValueHandler()
100
101    /**
102     *  Creates a new {@code ImageValueHandler} instance.
103     *
104     *  @param  valueSetter The function that places the translated value to
105     *      the property.
106     */
107    public ImageValueHandler( final BiConsumer<String,BufferedImage> valueSetter )
108    {
109        //---* Daddy will do the null check *----------------------------------
110        super( valueSetter );
111    }   //  ImageValueHandler()
112
113        /*---------*\
114    ====** Methods **==========================================================
115        \*---------*/
116    /**
117     *  {@inheritDoc}
118     */
119    @Override
120    protected final Collection<BufferedImage> translate( final Parameters params ) throws CmdLineException
121    {
122        Collection<BufferedImage> retValue = List.of();
123        var fileName = requireNonNullArgument( params, "params" ).getParameter( 0 );
124        try
125        {
126            final var imageFile = FileStringConverter.INSTANCE.fromString( fileName ).getCanonicalFile().getAbsoluteFile();
127            fileName = imageFile.getAbsolutePath();
128            final var image = ImageIO.read( imageFile );
129            retValue = List.of( image );
130        }
131        catch( final IllegalArgumentException e )
132        {
133            throw new CmdLineException( MSG_InvalidFileName, e, MSGKEY_InvalidFileName, fileName );
134        }
135        catch( final IOException e )
136        {
137            throw new CmdLineException( MSG_ReadFailed, e, MSGKEY_ReadFailed, fileName );
138        }
139
140        //---* Done *----------------------------------------------------------
141        return retValue;
142    }   //  translate()
143}
144//  class ImageValueHandler
145
146/*
147 *  End of File
148 */