DMDirc-Client/src/com/dmdirc/installer/cliparser/BooleanParam.java

/*
 * Copyright (c) 2006-2011 Shane Mc Cormack
 * 
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 * 
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 * 
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */

package com.dmdirc.installer.cliparser;

/**
 * Command Line argument type.
 */
public class BooleanParam extends CLIParam {
    /** The value of this param. */
    private boolean myValue = false;

    /**
     * Create a new BooleanParam.
     * 
     * @param chr
     *            Single Character flag for this param.
     * @param str
     *            String flag for this param.
     * @param desc
     *            Description of this flag.
     */
    public BooleanParam(final char chr, final String str, final String desc) {
        super(chr, str, desc);
    }

    /**
     * Set the value of this param to the value given by a string.
     * 
     * @param value
     *            String taken from command line to use as value.
     * @return true if value was valid, else false.
     */
    @Override
    public boolean setValue(final String value) {
        // if no value, or an empty value is given, toggle the value
        if (value == null || value.isEmpty()) {
            myValue = !myValue;
            return true;
            // Check if value is a word that means "true"
        } else if (value.equals("1") || value.equalsIgnoreCase("true")
                || value.equalsIgnoreCase("yes")) {
            myValue = true;
            return true;
            // Check if value is a word that means "false"
        } else if (value.equals("0") || value.equalsIgnoreCase("false")
                || value.equalsIgnoreCase("no")) {
            myValue = false;
            return true;
            // The value is not a valid boolean value.
        } else {
            return false;
        }
    }

    /**
     * Get the value of this param.
     * 
     * @return Value of this parameter
     */
    public boolean getValue() {
        return myValue;
    }

    /**
     * Return the value of this param as a string.
     * 
     * @return The value of this param as a string.
     */
    @Override
    public String getStringValue() {
        return String.valueOf(getValue());
    }
}