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

Class PlantUMLDependencyOutputOptionExecution

java.lang.Object

net.sourceforge.plantumldependency.commoncli.option.execution.AbstractOptionExecution

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

All Implemented Interfaces:

Serializable, Cloneable, Comparable<net.sourceforge.plantumldependency.commoncli.option.execution.OptionExecution>, net.sourceforge.plantumldependency.common.clone.DeepCloneable<net.sourceforge.plantumldependency.commoncli.option.execution.OptionExecution>, net.sourceforge.plantumldependency.commoncli.option.execution.OptionExecution

public class PlantUMLDependencyOutputOptionExecution
extends net.sourceforge.plantumldependency.commoncli.option.execution.AbstractOptionExecution

The default option execution associated to the "-o" option, allowing to specify an output file, processing the input source files and generating the plantUML description.

Since:

1.0.0

Version:

1.4.0

Author:

Benjamin Croizet (See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
PlantUMLDependencyOutputOptionExecution(File file, ProgrammingLanguage language, org.apache.tools.ant.types.FileSet includeExcludeFiles, Set<DisplayType> displayTypesOpts, Pattern displayPackageNamePatternOpt, Pattern displayNamePatternOpt, int optionPriority) Default constructor.

Method Summary

Methods

Modifier and Type	Method and Description
net.sourceforge.plantumldependency.commoncli.option.execution.OptionExecution	deepClone()
void	execute()

Methods inherited from class net.sourceforge.plantumldependency.commoncli.option.execution.AbstractOptionExecution

compareTo, equals, getPriority, hashCode, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

PlantUMLDependencyOutputOptionExecution

public PlantUMLDependencyOutputOptionExecution(File file,
                                       ProgrammingLanguage language,
                                       org.apache.tools.ant.types.FileSet includeExcludeFiles,
                                       Set<DisplayType> displayTypesOpts,
                                       Pattern displayPackageNamePatternOpt,
                                       Pattern displayNamePatternOpt,
                                       int optionPriority)

Default constructor.

Parameters:

file - the output file where to generate the plantUML description, mustn't be null.

language - The programming language to parse, mustn't be null.

includeExcludeFiles - the FileSet describing all files to include or exclude and also the base directory where to look for, mustn't be null.

displayTypesOpts - the Set of display types options which filter type to appear in the plantUML description, mustn't be null.

displayPackageNamePatternOpt - the Pattern which filter package name to appear in the plantUML description, mustn't be null.

displayNamePatternOpt - the Pattern which filter name to appear in the plantUML description, 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

deepClone

public net.sourceforge.plantumldependency.commoncli.option.execution.OptionExecution deepClone()

Specified by:

deepClone in interface net.sourceforge.plantumldependency.common.clone.DeepCloneable<net.sourceforge.plantumldependency.commoncli.option.execution.OptionExecution>

Overrides:

deepClone in class net.sourceforge.plantumldependency.commoncli.option.execution.AbstractOptionExecution

Since:

1.0.0

execute

public void execute()
             throws net.sourceforge.plantumldependency.commoncli.exception.CommandLineException

Throws:

net.sourceforge.plantumldependency.commoncli.exception.CommandLineException

Since:

1.0.0