001: /*
002: * Copyright (c) 2001-2007, Jean Tessier
003: * All rights reserved.
004: *
005: * Redistribution and use in source and binary forms, with or without
006: * modification, are permitted provided that the following conditions
007: * are met:
008: *
009: * * Redistributions of source code must retain the above copyright
010: * notice, this list of conditions and the following disclaimer.
011: *
012: * * Redistributions in binary form must reproduce the above copyright
013: * notice, this list of conditions and the following disclaimer in the
014: * documentation and/or other materials provided with the distribution.
015: *
016: * * Neither the name of Jean Tessier nor the names of his contributors
017: * may be used to endorse or promote products derived from this software
018: * without specific prior written permission.
019: *
020: * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
021: * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
022: * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
023: * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR
024: * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
025: * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
026: * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
027: * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
028: * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
029: * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
030: * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
031: */
032:
033: package com.jeantessier.commandline;
034:
035: /**
036: * Base class for implenting the <code>CommandLineSwitch</code> interface.
037: */
038: public abstract class CommandLineSwitchBase implements
039: CommandLineSwitch {
040: private String name;
041: private Object defaultValue;
042: protected Object value;
043: private boolean present;
044: private boolean mandatory;
045:
046: public CommandLineSwitchBase(String name) {
047: this (name, null, false);
048: }
049:
050: public CommandLineSwitchBase(String name, Object defaultValue) {
051: this (name, defaultValue, false);
052: }
053:
054: public CommandLineSwitchBase(String name, boolean mandatory) {
055: this (name, null, mandatory);
056: }
057:
058: public CommandLineSwitchBase(String name, Object defaultValue,
059: boolean mandatory) {
060: this .name = name;
061: this .defaultValue = defaultValue;
062: this .mandatory = mandatory;
063:
064: this .value = null;
065:
066: isPresent(false);
067: }
068:
069: public String getName() {
070: return name;
071: }
072:
073: public Object getDefaultValue() {
074: return defaultValue;
075: }
076:
077: public Object getValue() {
078: Object result = defaultValue;
079:
080: if (value != null) {
081: result = value;
082: }
083:
084: return result;
085: }
086:
087: public void setValue(Object value) {
088: this .value = value;
089:
090: isPresent(true);
091: }
092:
093: public boolean isPresent() {
094: return present;
095: }
096:
097: protected void isPresent(boolean present) {
098: this .present = present;
099: }
100:
101: public boolean isMandatory() {
102: return mandatory;
103: }
104:
105: public void validate() throws CommandLineException {
106: if (isMandatory() && !isPresent()) {
107: throw new CommandLineException(
108: "Missing mandatory switch \"" + getName() + "\"");
109: }
110: }
111:
112: public String toString() {
113: return getValue().toString();
114: }
115: }
|