org.dishevelled.commandline.Switch 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;

/**
 * Switch.
 *
 * @author  Michael Heuer
 */
public final class Switch
    implements Argument
{
    /** Short name. */
    private final String shortName;

    /** Long name. */
    private final String longName;

    /** Description. */
    private final String description;

    /** True if this switch was found. */
    private boolean found;


    /**
     * Create a new switch.
     *
     * @param shortName short switch name
     * @param longName long switch name
     * @param description switch description
     */
    public Switch(final String shortName,
                  final String longName,
                  final String description)
    {
        this.shortName = shortName;
        this.longName = longName;
        this.description = description;
        this.found = false;
    }


    /** {@inheritDoc} */
    public void visit(final String current, final CommandLine commandLine)
        throws Exception
    {
        if (("-" + getShortName()).equals(current) || ("--" + getLongName()).equals(current))
        {
            found = true;
        }
    }

    /** {@inheritDoc} */
    public String getShortName()
    {
        return shortName;
    }

    /** {@inheritDoc} */
    public String getLongName()
    {
        return longName;
    }

    /** {@inheritDoc} */
    public String getDescription()
    {
        return description;
    }

    /** {@inheritDoc} */
    public boolean isRequired()
    {
        return false;
    }

    /** {@inheritDoc} */
    public boolean wasFound()
    {
        return found;
    }

    /** {@inheritDoc} */
    public Boolean getValue()
    {
        return Boolean.valueOf(found);
    }

    /** {@inheritDoc} */
    public Boolean getValue(final Boolean defaultValue)
    {
        return found ? Boolean.TRUE : defaultValue;
    }
}