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.config.spi;
019
020import org.apiguardian.api.API;
021import org.tquadrat.foundation.annotation.ClassVersion;
022import org.tquadrat.foundation.config.cli.CmdLineValueHandler;
023
024import java.util.Collection;
025import java.util.List;
026
027import static java.util.stream.Collectors.joining;
028import static org.apiguardian.api.API.Status.STABLE;
029import static org.tquadrat.foundation.lang.CommonConstants.EMPTY_STRING;
030import static org.tquadrat.foundation.lang.Objects.isNull;
031import static org.tquadrat.foundation.util.StringUtils.isNotEmpty;
032
033/**
034 *  Run-time copy of the
035 *  {@link org.tquadrat.foundation.config.Option}
036 *  annotation. By definition, named options are <i>real</i> options (and
037 *  instances of this class). Unnamed options are arguments and actually
038 *  another subclass of
039 *  {@link CLIDefinition}.
040 *
041 *  @see CLIArgumentDefinition
042 *
043 *  @extauthor Thomas Thrien - thomas.thrien@tquadrat.org
044 *  @thanks Mark Sinke
045 *  @version $Id: CLIOptionDefinition.java 1120 2024-03-16 09:48:00Z tquadrat $
046 *  @since 0.0.1
047 *
048 *  @UMLGraph.link
049 */
050@ClassVersion( sourceVersion = "$Id: CLIOptionDefinition.java 1120 2024-03-16 09:48:00Z tquadrat $" )
051@API( status = STABLE, since = "0.0.1" )
052public class CLIOptionDefinition extends CLIDefinition
053{
054        /*------------*\
055    ====** Attributes **=======================================================
056        \*------------*/
057    /**
058     *  The aliases for the option name.
059     */
060    private final List<String> m_Aliases;
061
062    /**
063     *  The option name.
064     */
065    private final String m_Name;
066
067        /*--------------*\
068    ====** Constructors **=====================================================
069        \*--------------*/
070    /**
071     *  Creates a new {@code CLIOptionDefinition} instance.
072     *
073     *  @param  property    The name of the property.
074     *  @param  names   The names for the option.
075     *  @param  usage   The usage text.
076     *  @param  usageKey    The resource bundle key for the usage text.
077     *  @param  metaVar The meta variable name; can be {@code null}.
078     *  @param  required    {@code true} if the argument or option is
079     *      mandatory.
080     *  @param  handler The handler for the option or argument value.
081     *  @param  multiValued {@code true} if the option or argument allows
082     *      more than one value.
083     *  @param  format  The optional format.
084     */
085    @SuppressWarnings( "BooleanParameter" )
086    public CLIOptionDefinition( final String property, final List<String> names, final String usage, final String usageKey, final String metaVar, final boolean required, final CmdLineValueHandler<?> handler, final boolean multiValued, final String format )
087    {
088        super( property, false, usage, usageKey, isNull( metaVar ) ? EMPTY_STRING : metaVar, required, handler, multiValued, format );
089
090        m_Name = names.getFirst();
091        m_Aliases = names.size() > 1 ? List.copyOf( names.subList( 1, names.size() ) ) : List.of();
092    }   //  CLIOptionDefinition()
093
094        /*---------*\
095    ====** Methods **==========================================================
096        \*---------*/
097    /**
098     *  Returns the aliases.
099     *
100     *  @return The aliases; may be empty, but will never be {@code null}.
101     */
102    public final Collection<String> aliases() { return m_Aliases; }
103
104    /**
105     *  {@inheritDoc}
106     */
107    @Override
108    public final String getSortKey() { return m_Name; }
109
110    /**
111     *  Returns the name of the option.
112     *
113     *  @return The option's name.
114     */
115    public final String name() { return m_Name; }
116
117    /**
118     *  {@inheritDoc}
119     */
120    @Override
121    public final String toString()
122    {
123        final var buffer = new StringBuilder();
124        if( !required() ) buffer.append( '[' );
125        buffer.append( name() );
126        if( !aliases().isEmpty() )
127        {
128            buffer.append( aliases().stream().collect( joining( ", ", " (", ")" ) ) );
129        }
130        if( isNotEmpty( metaVar() ) ) buffer.append( ' ' ).append( metaVar() );
131        if( !required() ) buffer.append( ']' );
132        final var retValue = buffer.toString();
133
134        //---* Done *----------------------------------------------------------
135        return retValue;
136    }   //  toString()
137}
138//  class CLIOptionDefinition
139
140/*
141 *  End of File
142 */