org.dishevelled.commandline.argument.CharacterArgument Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of dsh-commandline Show documentation

Command line parser based on typed arguments.

There is a newer version: 1.2

/*

    dsh-commandline  Command line parser based on typed arguments.
    Copyright (c) 2004-2014 held jointly by the individual authors.

    This library is free software; you can redistribute it and/or modify it
    under the terms of the GNU Lesser General Public License as published
    by the Free Software Foundation; either version 3 of the License, or (at
    your option) any later version.

    This library is distributed in the hope that it will be useful, but WITHOUT
    ANY WARRANTY; with out even the implied warranty of MERCHANTABILITY or
    FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public
    License for more details.

    You should have received a copy of the GNU Lesser General Public License
    along with this library;  if not, write to the Free Software Foundation,
    Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307  USA.

    > http://www.fsf.org/licensing/licenses/lgpl.html
    > http://www.opensource.org/licenses/lgpl-license.php

*/
package org.dishevelled.commandline.argument;

/**
 * A character argument.
 *
 * @author  Michael Heuer
 */
public final class CharacterArgument
    extends AbstractArgument
{

    /**
     * Create a new character argument.
     *
     * @param shortName short argument name
     * @param longName long argument name
     * @param description argument description
     * @param required true if this argument is required
     */
    public CharacterArgument(final String shortName,
                             final String longName,
                             final String description,
                             final boolean required)
    {
        super(shortName, longName, description, required);
    }


    /** {@inheritDoc} */
    protected Character convert(final String s)
        throws Exception
    {
        if (s.length() == 1)
        {
            return new Character(s.charAt(0));
        }
        else
        {
            throw new Exception("could not parse " + s + " into a Character");
        }
    }
}