net.sf.xdc.processing
Class XdcOption

java.lang.Object
  org.apache.commons.cli.Option
      net.sf.xdc.processing.XdcOption

All Implemented Interfaces:

java.lang.Cloneable

public class XdcOption

extends org.apache.commons.cli.Option

This class represents a command line option of the XDC application.

Since:

0.5

Version:

0.5

Author:

Jens Voß

Field Summary

Fields inherited from class org.apache.commons.cli.Option

UNINITIALIZED, UNLIMITED_VALUES

Constructor Summary

XdcOption(java.lang.String opt, java.lang.String description, boolean xslParam)
Public constructor.

XdcOption(java.lang.String opt, java.lang.String argName, java.lang.String description, boolean xslParam)
Public constructor.

Method Summary

java.lang.String	getOpt()
boolean	isXslParam() Getter method for this XdcOption's xslParam field which determines whether or not this command line option is passed to the processing XSLT stylesheet via a stylesheet parameter.

Methods inherited from class org.apache.commons.cli.Option

addValue, clone, getArgName, getArgs, getDescription, getId, getLongOpt, getType, getValue, getValue, getValue, getValues, getValueSeparator, getValuesList, hasArg, hasArgName, hasArgs, hasLongOpt, hasOptionalArg, isRequired, setArgName, setArgs, setLongOpt, setOptionalArg, setRequired, setType, setValueSeparator, toString

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

XdcOption

public XdcOption(java.lang.String opt,
                 java.lang.String description,
                 boolean xslParam)
          throws java.lang.IllegalArgumentException

Public constructor.

Parameters:

opt - The command line option string

description - A description of this XdcOption

xslParam - Specifies whether this option is to be passed to the processing XSLT stylesheet via a stylesheet parameter

Throws:

java.lang.IllegalArgumentException

XdcOption

public XdcOption(java.lang.String opt,
                 java.lang.String argName,
                 java.lang.String description,
                 boolean xslParam)
          throws java.lang.IllegalArgumentException

Public constructor. Allows the specification of an additional argument.

Parameters:

opt - The command line option string

argName - The name of an additional argument

description - A description of this XdcOption

xslParam - Specifies whether this option is to be passed to the processing XSLT stylesheet via a stylesheet parameter

Throws:

java.lang.IllegalArgumentException

Method Detail

isXslParam

public boolean isXslParam()

Getter method for this XdcOption's xslParam field which determines whether or not this command line option is passed to the processing XSLT stylesheet via a stylesheet parameter.

Returns:

true if this command line option is to be passed to the respective XSLT stylesheet for processing; false otherwise

getOpt

public java.lang.String getOpt()