Package io.github.erdos.stencil.standalone

Class StencilArgsParser

java.lang.Object

io.github.erdos.stencil.standalone.StencilArgsParser

public final class StencilArgsParser
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
static final ArgsParser.ParamMarker<File>	JOBS_FILE	A file that contains job data.
static final ArgsParser.ParamMarker<Boolean>	JOBS_FROM_STDIN
static final ArgsParser.ParamMarker<Boolean>	ONLY_INLCUDES	Only evaluate fragment include directives.
static final ArgsParser.ParamMarker<File>	OUTPUT_DIR	Result files are placed in this directory.
static final ArgsParser.ParamMarker<Boolean>	OVERWRITE	Result files will be overwritten when already exist in target directory.
static final ArgsParser	PARSER
static final ArgsParser.ParamMarker<Boolean>	SHOW_HELP	Should display help message.
static final ArgsParser.ParamMarker<Boolean>	SHOW_VERSION	Should display version info.

Method Summary

Modifier and Type	Method	Description
static Boolean	getOnlyIncludes(ArgsParser.ParseResult result)	If specified, only inlclude directives will be evaluated in template.
static File	getOutputDirectory(ArgsParser.ParseResult result)	Finds output directory in parsed parameters or returns current working directory.
static Boolean	getOutputOverwritten(ArgsParser.ParseResult result)	Finds output directory in parsed parameters or returns current working directory.
static ArgsParser.ParseResult	parse(String... args)

Methods inherited from class java.lang.Object

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

Field Details

PARSER

public static final ArgsParser PARSER

OUTPUT_DIR

public static final ArgsParser.ParamMarker<File> OUTPUT_DIR

Result files are placed in this directory.

OVERWRITE

public static final ArgsParser.ParamMarker<Boolean> OVERWRITE

Result files will be overwritten when already exist in target directory.

SHOW_HELP

public static final ArgsParser.ParamMarker<Boolean> SHOW_HELP

Should display help message.

SHOW_VERSION

public static final ArgsParser.ParamMarker<Boolean> SHOW_VERSION

Should display version info.

ONLY_INLCUDES

public static final ArgsParser.ParamMarker<Boolean> ONLY_INLCUDES

Only evaluate fragment include directives.

JOBS_FILE

public static final ArgsParser.ParamMarker<File> JOBS_FILE

A file that contains job data.

JOBS_FROM_STDIN

public static final ArgsParser.ParamMarker<Boolean> JOBS_FROM_STDIN

Method Details

parse

public static ArgsParser.ParseResult parse(String... args)

getOutputDirectory

public static File getOutputDirectory(ArgsParser.ParseResult result)

Finds output directory in parsed parameters or returns current working directory.

Returns:

output directory where rendered files will be put

Throws:

NullPointerException - if param is null

IllegalArgumentException - if output file path does not exist or is not a directory

getOutputOverwritten

public static Boolean getOutputOverwritten(ArgsParser.ParseResult result)

Finds output directory in parsed parameters or returns current working directory.

Returns:

should resulting files override existing files?

Throws:

NullPointerException - if param is null

getOnlyIncludes

public static Boolean getOnlyIncludes(ArgsParser.ParseResult result)

If specified, only inlclude directives will be evaluated in template.

Returns:

default false

Throws:

NullPointerException - if param is null