net.sf.jcmdlineparser.options.AbstractSingleOption Maven / Gradle / Ivy

Go to download
/**********************************************************************
Copyright (c) 2009-2010 Alexander Kerner. All rights reserved.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
 *******************************************************************/

package net.sf.jcmdlineparser.options;


/**
 * An abstract prototype implementation for {@link AbstractOption}.
 * 
 * 
 * This command line option
 * can have only one value.
 * 
 * 
 * @author Alexander Kerner
 * @version 2010-11-24
 * 
 */
public abstract class AbstractSingleOption extends AbstractOption {

	private volatile T value = null;

	protected AbstractSingleOption(Class returnType, char identifierShort,
			String identifierLong, String description, boolean required) {
		super(returnType, identifierShort, identifierLong, description,
				required);
	}

	protected AbstractSingleOption(Class returnType, char identifierShort,
			String identifierLong, String description, boolean required,
			T initValue) {
		super(returnType, identifierShort, identifierLong, description,
				required);
		setValue(initValue);
	}

	/**
	 * Get value.
	 * 
	 * @throws OptionNotSetException
	 *             if this {@link AbstractOption} was not provided on the
	 *             command line
	 */
	public final T getValue() {
		if (this.isSet())
			return value;
		throw new OptionNotSetException("option \"" + this + "\" not set");
	}

	/**
	 * Set value.
	 * 
	 * @param value to set
	 */
	public final void setValue(T value) {
		this.value = value;
		this.setSet(true);
	}

}