net.sourceforge.plantumldependency.cli.main.option.output

Class PlantUMLDependencyOutputOption

java.lang.Object

net.sourceforge.plantumldependency.commoncli.option.AbstractOption

net.sourceforge.plantumldependency.commoncli.option.AbstractOptionWithArgument<File>

net.sourceforge.plantumldependency.commoncli.option.impl.output.OutputOption

net.sourceforge.plantumldependency.cli.main.option.output.PlantUMLDependencyOutputOption

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.execution.ExecutableOption, net.sourceforge.plantumldependency.commoncli.option.Option, net.sourceforge.plantumldependency.commoncli.option.OptionWithArgument<File>

public class PlantUMLDependencyOutputOption
extends net.sourceforge.plantumldependency.commoncli.option.impl.output.OutputOption
implements net.sourceforge.plantumldependency.commoncli.option.execution.ExecutableOption

The output option, allowing to specify an output file, processing the input source files and generating the plantUML description. Note : no option should have the same main or secondary names.

Since:

1.0.0

Version:

1.4.0

Author:

Benjamin Croizet (See Also:

Serialized Form

Field Summary

Fields inherited from class net.sourceforge.plantumldependency.commoncli.option.impl.output.OutputOption

OPTION_MAIN_SYNOPSIS, OPTION_SYNOPSIS

Constructor Summary

Constructors

Constructor and Description

PlantUMLDependencyOutputOption(net.sourceforge.plantumldependency.commoncli.option.impl.verbose.VerboseLevelOption verboseLvlOpt, PlantUMLDependencyProgrammingLanguageOption programmingLanguageOpt, PlantUMLDependencyIncludeOption includeOpt, PlantUMLDependencyExcludeOption excludeOpt, PlantUMLDependencyDisplayTypeOption displayTypeOpt, PlantUMLDependencyDisplayPackageNameOption displayPackageNameOpt, PlantUMLDependencyDisplayNameOption displayNameOpt, PlantUMLDependencyBaseDirectoryOption baseDirOpt, int optionPriority) Default constructor.

Method Summary

Methods

Modifier and Type	Method and Description
int	getPriority()
net.sourceforge.plantumldependency.commoncli.option.execution.OptionExecution	parseCommandLine(net.sourceforge.plantumldependency.commoncli.command.CommandLine commandLine)

Methods inherited from class net.sourceforge.plantumldependency.commoncli.option.impl.output.OutputOption

getDefaultArgumentAsStringIfOptionNotSpecified, getDefaultArgumentAsStringIfOptionSpecified

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

Constructor Detail

PlantUMLDependencyOutputOption

public PlantUMLDependencyOutputOption(net.sourceforge.plantumldependency.commoncli.option.impl.verbose.VerboseLevelOption verboseLvlOpt,
                              PlantUMLDependencyProgrammingLanguageOption programmingLanguageOpt,
                              PlantUMLDependencyIncludeOption includeOpt,
                              PlantUMLDependencyExcludeOption excludeOpt,
                              PlantUMLDependencyDisplayTypeOption displayTypeOpt,
                              PlantUMLDependencyDisplayPackageNameOption displayPackageNameOpt,
                              PlantUMLDependencyDisplayNameOption displayNameOpt,
                              PlantUMLDependencyBaseDirectoryOption baseDirOpt,
                              int optionPriority)

Default constructor.

Parameters:

verboseLvlOpt - the VerboseLevelOption instance, to display log information, mustn't be null.

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

includeOpt - the PlantUMLDependencyIncludeOption instance, to know input files to include for parsing, mustn't be null.

excludeOpt - the PlantUMLDependencyExcludeOption instance, to know exclude files which mustn't be parsed, mustn't be null.

displayTypeOpt - the PlantUMLDependencyDisplayTypeOption instance, to know which types to display in the plantUML generated file, mustn't be null.

displayPackageNameOpt - the PlantUMLDependencyDisplayTypeOption instance, to know which package name to display in the plantUML generated file, mustn't be null.

displayNameOpt - the PlantUMLDependencyDisplayTypeOption instance, to know which package name to display in the plantUML generated file, mustn't be null.

baseDirOpt - the PlantUMLDependencyBaseDirectoryOption instance, to know the base directory where to look for source files, mustn't be null.

optionPriority - the option priority as an integer. Note : the priority must be unique amongst all options.

Since:

1.0.0

Method Detail

getPriority

public int getPriority()

Specified by:

getPriority in interface net.sourceforge.plantumldependency.commoncli.option.execution.ExecutableOption

Since:

1.0.0

parseCommandLine

public net.sourceforge.plantumldependency.commoncli.option.execution.OptionExecution parseCommandLine(net.sourceforge.plantumldependency.commoncli.command.CommandLine commandLine)
                                                                                               throws net.sourceforge.plantumldependency.commoncli.exception.CommandLineException

Specified by:

parseCommandLine in interface net.sourceforge.plantumldependency.commoncli.option.execution.ExecutableOption

Throws:

net.sourceforge.plantumldependency.commoncli.exception.CommandLineException

Since:

1.0.0