001/*
002 * ============================================================================
003 * Copyright © 2002-2022 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.isNull;
023
024import java.io.Serial;
025
026import org.apiguardian.api.API;
027import org.tquadrat.foundation.annotation.ClassVersion;
028import org.tquadrat.foundation.lang.StringConverter;
029import org.tquadrat.foundation.util.Hash;
030
031/**
032 *  <p>{@summary The implementation of
033 *  {@link StringConverter}
034 *  for
035 *  {@link String}
036 *  values representing a hash value.} Here it does not matter whether that
037 *  hash was produced by MD5, SHA or any other tool.</p>
038 *  <p>The hash value is a byte array.</p>
039 *
040 *  @extauthor Thomas Thrien - thomas.thrien@tquadrat.org
041 *  @version $Id: HashStringConverter.java 1045 2023-02-07 23:09:17Z tquadrat $
042 *  @since 0.1.1
043 *
044 *  @UMLGraph.link
045 */
046@ClassVersion( sourceVersion = "$Id: HashStringConverter.java 1045 2023-02-07 23:09:17Z tquadrat $" )
047@API( status = STABLE, since = "0.1.1" )
048public final class HashStringConverter implements StringConverter<Hash>
049{
050        /*------------------------*\
051    ====** Static Initialisations **===========================================
052        \*------------------------*/
053    /**
054     *  An instance of this class.
055     */
056    public static final HashStringConverter INSTANCE = new HashStringConverter();
057
058    /**
059     *  The serial version UID for objects of this class: {@value}.
060     *
061     *  @hidden
062     */
063    @Serial
064    private static final long serialVersionUID = 1L;
065
066        /*--------------*\
067    ====** Constructors **=====================================================
068        \*--------------*/
069    /**
070     *  Creates a new instance of {@code HashStringConverter}.
071     */
072    public HashStringConverter() { /* Just exists */ }
073
074        /*---------*\
075    ====** Methods **==========================================================
076        \*---------*/
077    /**
078     *  {@inheritDoc}
079     */
080    @Override
081    public final Hash fromString( final CharSequence source ) throws IllegalArgumentException
082    {
083        final var retValue = isNull( source ) ? null : Hash.from( source );
084
085        //---* Done *----------------------------------------------------------
086        return retValue;
087    }   //  fromString()
088
089    /**
090     *  This method is used by the
091     *  {@link java.util.ServiceLoader}
092     *  to obtain the instance for this
093     *  {@link org.tquadrat.foundation.lang.StringConverter}
094     *  implementation.
095     *
096     *  @return The instance for this {@code StringConverter} implementation.
097     */
098    public static final HashStringConverter provider() { return INSTANCE; }
099}
100//  class HashStringConverter
101
102/*
103 *  End of File
104 */