net.sourceforge.plantumldependency.cli.main.option.include

Class PlantUMLDependencyIncludeOption

java.lang.Object

net.sourceforge.plantumldependency.commoncli.option.AbstractOption

net.sourceforge.plantumldependency.commoncli.option.AbstractOptionWithArgument<org.apache.tools.ant.types.FileSet>

net.sourceforge.plantumldependency.cli.main.option.include.PlantUMLDependencyIncludeOption

All Implemented Interfaces:

Serializable, Cloneable, Comparable<net.sourceforge.plantumldependency.commoncli.option.Option>, net.sourceforge.plantumldependency.common.clone.DeepCloneable<net.sourceforge.plantumldependency.commoncli.option.Option>, net.sourceforge.plantumldependency.commoncli.option.Option, net.sourceforge.plantumldependency.commoncli.option.OptionWithArgument<org.apache.tools.ant.types.FileSet>

public class PlantUMLDependencyIncludeOption
extends net.sourceforge.plantumldependency.commoncli.option.AbstractOptionWithArgument<org.apache.tools.ant.types.FileSet>

The include option, allowing to specify an include file pattern, like ANT. Note : no option should have the same main or secondary names.

Since:

1.0.0

Version:

1.3.0

Author:

Benjamin Croizet (See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	OPTION_MAIN_SYNOPSIS Option main synopsis.
static Set<String>	OPTION_SYNOPSIS Option synopsis alias.

Constructor Summary

Constructors

Constructor and Description
PlantUMLDependencyIncludeOption(PlantUMLDependencyProgrammingLanguageOption programmingLanguageOpt) Default constructor.

Method Summary

Methods

Modifier and Type	Method and Description
String	getDefaultArgumentAsStringIfOptionNotSpecified(net.sourceforge.plantumldependency.commoncli.command.CommandLine commandLine)
String	getDefaultArgumentAsStringIfOptionSpecified(net.sourceforge.plantumldependency.commoncli.command.CommandLine commandLine)

Methods inherited from class net.sourceforge.plantumldependency.commoncli.option.AbstractOptionWithArgument

deepClone, findAndParseArgumentAsStringOrGetDefaultArgument, findAndParseArgumentOrGetDefaultArgument, getDefaultArgumentIfOptionNotSpecified, getDefaultArgumentIfOptionSpecified, getFullUsageAdditions, getFullUsageDescriptionAdditions, getMainUsageAdditions, getOptionArgument, getValueSeparator, toString

Methods inherited from class net.sourceforge.plantumldependency.commoncli.option.AbstractOption

compareTo, equals, getAllNames, getFullUsage, getMainUsage, getName, getSecondaryNames, getStatus, hashCode, isMandatory

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface net.sourceforge.plantumldependency.commoncli.option.Option

getAllNames, getFullUsage, getMainUsage, getName, getSecondaryNames, getStatus, isMandatory

Methods inherited from interface java.lang.Comparable

compareTo

Field Detail

OPTION_MAIN_SYNOPSIS

public static final String OPTION_MAIN_SYNOPSIS

Option main synopsis.

See Also:

Constant Field Values

OPTION_SYNOPSIS

public static final Set<String> OPTION_SYNOPSIS

Option synopsis alias.

Constructor Detail

PlantUMLDependencyIncludeOption

public PlantUMLDependencyIncludeOption(PlantUMLDependencyProgrammingLanguageOption programmingLanguageOpt)

Default constructor.

Parameters:

programmingLanguageOpt - the PlantUMLDependencyProgrammingLanguageOption instance, to know what is the programming language to parse, mustn't be null.

Since:

1.0.0

Method Detail

getDefaultArgumentAsStringIfOptionNotSpecified

public String getDefaultArgumentAsStringIfOptionNotSpecified(net.sourceforge.plantumldependency.commoncli.command.CommandLine commandLine)
                                                      throws net.sourceforge.plantumldependency.commoncli.exception.CommandLineException

Throws:

net.sourceforge.plantumldependency.commoncli.exception.CommandLineException

Since:

1.0.0

getDefaultArgumentAsStringIfOptionSpecified

public String getDefaultArgumentAsStringIfOptionSpecified(net.sourceforge.plantumldependency.commoncli.command.CommandLine commandLine)
                                                   throws net.sourceforge.plantumldependency.commoncli.exception.CommandLineException

Throws:

net.sourceforge.plantumldependency.commoncli.exception.CommandLineException

Since:

1.0.0