org.walkmod

Class OptionsBuilder

java.lang.Object

org.walkmod.OptionsBuilder

public class OptionsBuilder
extends Object

Helper class to create Walkmod options map. Usage: OptionsBuilder.options().offline(true).includes("src/main","src/test").asMap() or OptionsBuilder.options().offline(true).includes("src/main","src/test").build()

Author:

abelsromero

Method Summary

Modifier and Type	Method and Description
Map<String,Object>	asMap() Returns the stored options as a Map<String,Object>
Options	build()
OptionsBuilder	configurationFormat(String configurationFormat) Sets the configuration format (xml or yml)
OptionsBuilder	dynamicArgs(Map<String,Object> dynamicArgs) Seths the dynamic arguments
OptionsBuilder	excludes(String... excludes) Sets the excludes
OptionsBuilder	executionDirectory(File executionDirectory) Sets the execution directory
OptionsBuilder	includes(String... includes) Sets the includes option
OptionsBuilder	offline(boolean offline) Sets the offline option
static OptionsBuilder	options() Creates an OptionBuilder instance with the default options: offline = false verbose = true printErrors = false throwException = false
static OptionsBuilder	options(Map<String,Object> options) Creates an OptionBuilder instance with the default options:
OptionsBuilder	path(String path) Sets the path option
OptionsBuilder	printErrors(boolean printErrors) Sets the printErrors option
OptionsBuilder	throwException(boolean throwException) Sets the printErrors option
OptionsBuilder	verbose(boolean verbose) Sets the verbose option

Methods inherited from class java.lang.Object

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

Method Detail

options

public static OptionsBuilder options()

Creates an OptionBuilder instance with the default options:

• offline = false
• verbose = true
• printErrors = false
• throwException = false

Returns:

options builder instance

options

public static OptionsBuilder options(Map<String,Object> options)

Creates an OptionBuilder instance with the default options:

Parameters:

options - Map of starting options. See Options for available keys

Returns:

options builder instance

offline

public OptionsBuilder offline(boolean offline)

Sets the offline option

Parameters:

offline - true to disable resolution of plugin from remote repositories

Returns:

updated OptionBuilder instance

See Also:

Options.OFFLINE

verbose

public OptionsBuilder verbose(boolean verbose)

Sets the verbose option

Parameters:

verbose - true to enable info messages in the console

Returns:

updated OptionBuilder instance

See Also:

Options.VERBOSE

path

public OptionsBuilder path(String path)

Sets the path option

Parameters:

path - directory to read and write from

Returns:

updated OptionBuilder instance

See Also:

Options.VERBOSE

printErrors

public OptionsBuilder printErrors(boolean printErrors)

Sets the printErrors option

Parameters:

printErrors - true to enable error messages in the console

Returns:

updated OptionBuilder instance

See Also:

Options.PRINT_ERRORS

throwException

public OptionsBuilder throwException(boolean throwException)

Sets the printErrors option

Parameters:

throwException - true to enable exception throwing

Returns:

updated OptionBuilder instance

See Also:

Options.PRINT_ERRORS

includes

public OptionsBuilder includes(String... includes)

Sets the includes option

Parameters:

includes - List of included paths

Returns:

updated OptionBuilder instance

See Also:

Options.INCLUDES

excludes

public OptionsBuilder excludes(String... excludes)

Sets the excludes

Parameters:

excludes - List of excluded paths

Returns:

updated OptionBuilder instance

See Also:

Options.EXCLUDES

dynamicArgs

public OptionsBuilder dynamicArgs(Map<String,Object> dynamicArgs)

Seths the dynamic arguments

Parameters:

dynamicArgs - Map of dynamic arguments

Returns:

Options#DYNAMIC_ARGS

executionDirectory

public OptionsBuilder executionDirectory(File executionDirectory)

Sets the execution directory

Parameters:

executionDirectory - execution directory

Returns:

updated OptionBuilder instance

See Also:

Options.EXECUTION_DIRECTORY

configurationFormat

public OptionsBuilder configurationFormat(String configurationFormat)

Sets the configuration format (xml or yml)

Parameters:

configurationFormat - configuration format (file extension)

Returns:

updated OptionBuilder instance

See Also:

Options.CONFIGURATION_FILE_FORMAT

build

public Options build()

Returns:

the current built options

asMap

public Map<String,Object> asMap()

Returns the stored options as a Map<String,Object>

Returns:

map with options