OSGI-OPT.src.org.kohsuke.args4j.OptionDef Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of closure

The newest version!

package org.kohsuke.args4j;

import org.kohsuke.args4j.spi.OptionHandler;

/**
 * Run-time copy of the Option or Argument annotation. By definition, unnamed options
 * are arguments (and instances of this class). Named options are actually a subclass.
 * 
 * @author Mark Sinke
 */
public class OptionDef {
	private final String usage;
	private final String metaVar;
	private final boolean required;
	private final boolean help;
	private final boolean hidden;
	private final boolean multiValued;
	private final Class handler;

	public OptionDef(Argument a, boolean forceMultiValued) {
		this(a.usage(), a.metaVar(), a.required(), false, a.hidden(), a.handler(), a.multiValued() || forceMultiValued);
	}

	protected OptionDef(String usage, String metaVar, boolean required,
            boolean help, boolean hidden, 
            Class handler,
			boolean multiValued) {
		this.usage = usage;
		this.metaVar = metaVar;
		this.required = required;
        this.help = help;
		this.hidden = hidden;
		this.handler = handler;
		this.multiValued = multiValued;
	}

	public String usage() {
		return usage;
	}

	public String metaVar() {
		return metaVar;
	}

	public boolean required() {
		return required;
	}
    
	public boolean help() {
		return help;
	}

    /**
     * Value from {@link Option#hidden()} or {@link Argument#hidden()}
     */
	public boolean hidden() {
		return hidden;
	}

	public Class handler() {
		return handler;
	}

	public boolean isMultiValued() {
		return multiValued;
	}

	public boolean isArgument() {
		return true;
	}

	@Override
	public String toString() {
		return metaVar() != null ? metaVar() : "ARG";
	}
}