Package net.sourceforge.plantuml.cli
Enum Class CliFlag
- All Implemented Interfaces:
Serializable,Comparable<CliFlag>,Constable
-
Nested Class Summary
Nested classes/interfaces inherited from class java.lang.Enum
Enum.EnumDesc<E extends Enum<E>> -
Enum Constant Summary
Enum ConstantsEnum ConstantDescription -
Method Summary
-
Enum Constant Details
-
HELP
-
HELP_MORE
@CliFlagDoc(value="Show extended help (advanced options)", level=0) public static final CliFlag HELP_MORE -
VERSION
-
AUTHOR
@CliFlagDoc(value="Show information about PlantUML authors", level=0) public static final CliFlag AUTHOR -
GUI
-
DARK_MODE
-
VERBOSE
-
DURATION
-
PROGRESS
-
SPLASH
@CliFlagDoc(value="Show splash screen with progress bar", level=0) public static final CliFlag SPLASH -
TEST_DOT
-
PICOWEB
@CliFlagDoc(value="Start internal HTTP server for rendering (default port : 4242)", usage="--http-server[:<port>]", level=0) public static final CliFlag PICOWEB -
EXCLUDE
-
PIPE
@CliFlagDoc(value="Read source from stdin, write result to stdout", level=0) public static final CliFlag PIPE -
PIPEMAP
-
PIPEDELIMITOR
-
PIPENOSTDERR
-
PIPE_IMAGE_INDEX
@CliFlagDoc("Generate the Nth image with pipe option") @CliDefaultValue("0") public static final CliFlag PIPE_IMAGE_INDEX -
DEFINE
@CliFlagDoc(value="Define a preprocessing variable (equivalent to \'!define <var> <value>\')", usage="-D<var>=<value>,\n--define <VAR>=<value>", level=0) public static final CliFlag DEFINE -
DEFINE_LONG
-
INCLUDE
@CliFlagDoc(value="Include external file (as with \'!include <file>\')", usage="-I<file>,\n--include <file>", level=1) public static final CliFlag INCLUDE -
INCLUDE_LONG
-
PRAGMA
@CliFlagDoc(value="Set pragma (equivalent to \'!pragma <key> <value>\')", usage="-P<key>=<value>,\n--pragma <key>=<value>", level=1) public static final CliFlag PRAGMA -
PRAGMA_LONG
-
SKINPARAM
@CliFlagDoc(value="Set skin parameter (equivalent to \'skinparam <key> <value>\')", usage="-S<key>=<value>,\n--skinparam <key>=<value>", level=1) public static final CliFlag SKINPARAM -
SKINPARAM_LONG
-
THEME
@CliFlagDoc(value="Apply a theme", usage="--theme <name>", level=1) public static final CliFlag THEME -
CONFIG
@CliFlagDoc(value="Specify configuration file", usage="--config <file>", level=1) public static final CliFlag CONFIG -
CHARSET
@CliFlagDoc(value="Use a specific input charset", usage="--charset <name>", level=1) @CliDefaultValue("UTF-8") public static final CliFlag CHARSET -
CHECK_ONLY
@CliFlagDoc(value="Check diagram syntax without generating images", level=0, newGroup="Execution control") public static final CliFlag CHECK_ONLY -
FAIL_FAST
-
FAIL_FAST2
@CliFlagDoc(value="Pre-check syntax of all inputs and stop faster on error", level=0) public static final CliFlag FAIL_FAST2 -
NO_ERROR_IMAGE
@CliFlagDoc(value="Do not generate error images for diagrams with syntax errors", level=0) public static final CliFlag NO_ERROR_IMAGE -
TIMEOUT
@CliFlagDoc(value="Set Graphviz processing timeout (in seconds)", usage="--graphviz-timeout <seconds>", level=1) public static final CliFlag TIMEOUT -
NB_THREAD
@CliFlagDoc(value="Use <n> threads for processing (auto = available processors)", usage="--threads <n|auto>", level=1) public static final CliFlag NB_THREAD -
RETRIEVE_METADATA
@CliFlagDoc(value="Extract embedded PlantUML source from PNG or SVG metadata", level=0, newGroup="Metadata & assets") public static final CliFlag RETRIEVE_METADATA -
NO_METADATA
@CliFlagDoc(value="Do not include metadata in generated files", level=1) public static final CliFlag NO_METADATA -
CHECK_METADATA
@CliFlagDoc(value="Skip PNG/SVG files that are already up-to-date (using metadata)", level=0) public static final CliFlag CHECK_METADATA -
ENCODE_SPRITE
@CliFlagDoc(value="Encode a sprite definition from an image file", usage="--sprite <4|8|16[z]> <file>", level=0) public static final CliFlag ENCODE_SPRITE -
COMPUTE_URL
@CliFlagDoc(value="Generate an encoded PlantUML URL from a source file", level=1) public static final CliFlag COMPUTE_URL -
DECODE_URL
@CliFlagDoc(value="Decode a PlantUML encoded URL back to its source", usage="--decode-url <string>", level=1) public static final CliFlag DECODE_URL -
LANGUAGE
@CliFlagDoc(value="Print the list of PlantUML language keywords", level=1) public static final CliFlag LANGUAGE -
GRAPHVIZ_DOT
@CliFlagDoc(value="Specify the path to the Graphviz \'dot\' executable", usage="--dot-path <path-to-dot-exe>", level=1) public static final CliFlag GRAPHVIZ_DOT -
FTP
@CliFlagDoc(value="Start a local FTP server for diagram rendering (rarely used)", level=1) public static final CliFlag FTP -
OUTPUT_DIR
-
OVERWRITE
@CliFlagDoc(value="Allow overwriting of read-only output files", level=1) public static final CliFlag OVERWRITE -
CLIPBOARD
-
CLIPBOARDLOOP
-
DEBUG_SVEK
-
FILE_DIR
@CliFlagDoc("Pretend input files are located in given directory") public static final CliFlag FILE_DIR -
FILENAME
-
HEADLESS
-
PRINT_FONTS
-
STD_LIB
-
STDRPT
-
SYNTAX
@CliFlagDoc("Report syntax errors from stdin without generating images") public static final CliFlag SYNTAX -
LICENSE
-
WORD
-
USE_SEPARATOR_MINUS
-
FORMAT
-
T_EPS
@CliFlagDoc(value="Generate images in EPS format", level=0, newGroup="Available formats") public static final CliFlag T_EPS -
T_EPS_TEXT
-
T_HTML
@CliFlagDoc(value="Generate HTML files for class diagrams", level=1) public static final CliFlag T_HTML -
T_LATEX
-
T_LATEX_NOPREAMBLE
@CliFlagDoc(value="Generate LaTeX/TikZ output without preamble", level=1) public static final CliFlag T_LATEX_NOPREAMBLE -
OBFUSCATE
@CliFlagDoc(value="Replace text in diagrams with obfuscated strings to share diagrams safely", level=0) public static final CliFlag OBFUSCATE -
T_PDF
-
T_PNG
-
PREPROCESS
@CliFlagDoc(value="Generate the preprocessed source after applying !include, !define... (no rendering)", level=0) public static final CliFlag PREPROCESS -
T_SCXML
@CliFlagDoc(value="Generate SCXML files for state diagrams", level=1) public static final CliFlag T_SCXML -
T_SVG
-
T_TXT
-
T_UTXT
@CliFlagDoc(value="Generate ASCII art diagrams using Unicode characters", level=0) public static final CliFlag T_UTXT -
T_VDX
-
T_XMI
@CliFlagDoc(value="Generate XMI files for class diagrams", level=1) public static final CliFlag T_XMI -
T_XMI_ARGO
-
T_XMI_CUSTOM
-
T_XMI_SCRIPT
-
T_XMI_STAR
-
T_BASE64
-
T_BRAILLE
-
DISABLE_STATS
@CliFlagDoc(value="Disable statistics collection (default behavior)", level=1, newGroup="Statistics") public static final CliFlag DISABLE_STATS -
ENABLE_STATS
-
DUMPHTMLSTATS
@CliFlagDoc(value="Export collected statistics to an HTML report and exit", level=1) public static final CliFlag DUMPHTMLSTATS -
DUMPSTATS
@CliFlagDoc(value="Export collected statistics to a text report and exit", level=1) public static final CliFlag DUMPSTATS -
HTML_STATS
@CliFlagDoc(value="Output general statistics in HTML format", level=1) public static final CliFlag HTML_STATS -
XML_STATS
@CliFlagDoc(value="Output general statistics in XML format", level=1) public static final CliFlag XML_STATS -
REALTIME_STATS
@CliFlagDoc(value="Generate statistics in real time during processing", level=1) public static final CliFlag REALTIME_STATS -
LOOP_STATS
@CliFlagDoc(value="Continuously print usage statistics during execution", level=1) public static final CliFlag LOOP_STATS
-
-
Method Details
-
values
Returns an array containing the constants of this enum class, in the order they are declared.- Returns:
- an array containing the constants of this enum class, in the order they are declared
-
valueOf
Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)- Parameters:
name- the name of the enum constant to be returned.- Returns:
- the enum constant with the specified name
- Throws:
IllegalArgumentException- if this enum class has no constant with the specified nameNullPointerException- if the argument is null
-
getFlag
-
getAliases
-
getType
-
getFlagDoc
-
getNewgroup
-
getUsage
-
getFlagLevel
public int getFlagLevel() -
getDefaultValue
-
getFoo
-