1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118
|
/*
* Copyright (C) 2001-2013 Michael Fuchs
*
* This file is part of herold.
*
* herold is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* herold is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with herold. If not, see <http://www.gnu.org/licenses/>.
*/
package org.dbdoclet.option;
/**
* <div lang="en">
* The class <code>BooleanOption</code> implements a flag option with no
* argument.
*
* If the flag is present on the command line, the value of the option will be
* true, otherwise it will be false.
*
* </div>
*
* <div lang="de"> Die Klasse <code>BooleanOption</code> realisiert die
* Standardoption ohne Argument.
*
* Wird die Option auf der Kommandozeile gesetzt, so erhält die Option den Wert
* "wahr". Andernfalls den Wert "falsch". Der Standardwert kann bei Aufruf der
* Methode <code>getFlag()</code> überschrieben werden.
*
* </div>
*
* <div id="example_BooleanOption"
* title="BooleanOption">
* <pre>
OptionList options = new OptionList(args);
Option option = new BooleanOption("help","h");
options.add(option);
if ( options.getFlag("help",false) ) {
printUsage();
return;
}
* </pre>
* </div>
*
* @author <a href="mailto:mfuchs@unico-consulting.com">Michael Fuchs</a>
* @version 1.0
*/
public class BooleanOption extends Option<Boolean> {
/**
* Creates a new <code>BooleanOption</code> instance.
*/
public BooleanOption() {
super();
setDefault(false);
}
public BooleanOption(String longName) {
super(longName);
setDefault(false);
}
/**
* <div lang="en">
* Creates a new <code>BooleanOption</code> instance.
* </div>
*
* <div lang="de">
* Erzeugt eine neue Instanz der Klasse <code>BooleanOption</code>.
* </div>
*
* @param longName a <code>String</code> value
* @param shortName a <code>String</code> value
*/
public BooleanOption(String longName, String shortName) {
super(longName, shortName);
setDefault(false);
}
@Override
public void addValueFromString(String value) {
addValue(Boolean.valueOf(value));
}
@Override
public void setValueFromString(String value) {
boolean flag = false;
if (value.equals("1")
|| value.equalsIgnoreCase("on")
|| value.equalsIgnoreCase("yes")
|| value.equalsIgnoreCase("true")
|| value.equalsIgnoreCase("ja")
|| value.equalsIgnoreCase("wahr")) {
flag = true;
}
setValue(flag);
}
@Override
public OptionType getType() {
return OptionType.BOOLEAN;
}
}
|