Options (walkmod-core 3.0.1 API)

java.lang.Object
- org.walkmod.Options

```
public class Options
extends Object
```
Helper class to create Walkmos options map Inspired by Asciidoctor's Options

Author:

abelsromero

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`CHAIN_PATH` (String) Selected path value for the reader and writer
`static String`	`CONFIGURATION_FILE_FORMAT` (String) File extension of the walkmod configuration
`static String`	`DYNAMIC_ARGS` (Map) Extra arguments for the executed components
`static String`	`EXCLUDES` (List<String>) Overwrites the exclude rules in the chain's reader
`static String`	`EXECUTION_DIRECTORY` (File) Sets an execution directory.
`static String`	`INCLUDES` (List<String>) Overwrites the include rules in the chain's reader
`static String`	`OFFLINE` (Boolean) Disables/enables remote fetching of plugins
`static String`	`PRINT_ERRORS` (Boolean) Disables/enables error messages in the console
`static String`	`THROW_EXCEPTION` (Boolean) Disables/enables the capture of original exceptions (requires verbose = true)
`static String`	`VERBOSE` (Boolean) Disables/enables info messages in the console

Constructor Summary

Constructors
Constructor and Description

Options()
Creates an empty set of options

Options(Map<String,Object> options)
Creates a set of options with initialized values

Constructors
Constructor and Description
`Options()` Creates an empty set of options
`Options(Map<String,Object> options)` Creates a set of options with initialized values

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Map<String,Object>`	`asMap()` Returns the stored options as a Map<String,Object>
`String`	`getConfigurationFormat()`
`Map<String,Object>`	`getDynamicArgs()`
`List<String>`	`getExcludes()`
`File`	`getExecutionDirectory()`
`List<String>`	`getIncludes()`
`String`	`getPath()`
`boolean`	`isOffline()`
`boolean`	`isPrintErrors()`
`boolean`	`isThrowException()`
`boolean`	`isVerbose()`
`void`	`setConfigurationFormat(String format)`
`void`	`setDynamicArgs(Map<String,Object> dynamicArgs)`
`void`	`setExcludes(String... excludes)`
`void`	`setExecutionDirectory(File executionDirectory)`
`void`	`setIncludes(String... includes)`
`void`	`setOffline(boolean offline)`
`void`	`setPath(String path)`
`void`	`setPrintErrors(boolean printErrors)`
`void`	`setThrowException(boolean throwException)`
`void`	`setVerbose(boolean verbose)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - OFFLINE
```
public static final String OFFLINE
```
    (Boolean) Disables/enables remote fetching of plugins
    
    See Also:
    
    Constant Field Values
  - VERBOSE
```
public static final String VERBOSE
```
    (Boolean) Disables/enables info messages in the console
    
    See Also:
    
    Constant Field Values
  - PRINT_ERRORS
```
public static final String PRINT_ERRORS
```
    (Boolean) Disables/enables error messages in the console
    
    See Also:
    
    Constant Field Values
  - THROW_EXCEPTION
```
public static final String THROW_EXCEPTION
```
    (Boolean) Disables/enables the capture of original exceptions (requires verbose = true)
    
    See Also:
    
    Constant Field Values
  - INCLUDES
```
public static final String INCLUDES
```
    (List<String>) Overwrites the include rules in the chain's reader
    
    See Also:
    
    Constant Field Values
  - EXCLUDES
```
public static final String EXCLUDES
```
    (List<String>) Overwrites the exclude rules in the chain's reader
    
    See Also:
    
    Constant Field Values
  - EXECUTION_DIRECTORY
```
public static final String EXECUTION_DIRECTORY
```
    (File) Sets an execution directory. The default value is the current user.dir
    
    See Also:
    
    Constant Field Values
  - CONFIGURATION_FILE_FORMAT
```
public static final String CONFIGURATION_FILE_FORMAT
```
    (String) File extension of the walkmod configuration
    
    See Also:
    
    Constant Field Values
  - DYNAMIC_ARGS
```
public static final String DYNAMIC_ARGS
```
    (Map) Extra arguments for the executed components
    
    See Also:
    
    Constant Field Values
  - CHAIN_PATH
```
public static final String CHAIN_PATH
```
    (String) Selected path value for the reader and writer
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - Options
```
public Options()
```
    Creates an empty set of options
  - Options
```
public Options(Map<String,Object> options)
```
    Creates a set of options with initialized values
    
    Parameters:
    
    options - Already initialized options
- Method Detail
  - setConfigurationFormat
```
public void setConfigurationFormat(String format)
```
  - getConfigurationFormat
```
public String getConfigurationFormat()
```
  - setOffline
```
public void setOffline(boolean offline)
```
  - isOffline
```
public boolean isOffline()
```
  - getPath
```
public String getPath()
```
  - setPath
```
public void setPath(String path)
```
  - setVerbose
```
public void setVerbose(boolean verbose)
```
  - isVerbose
```
public boolean isVerbose()
```
  - setPrintErrors
```
public void setPrintErrors(boolean printErrors)
```
  - setExecutionDirectory
```
public void setExecutionDirectory(File executionDirectory)
```
  - setDynamicArgs
```
public void setDynamicArgs(Map<String,Object> dynamicArgs)
```
  - getDynamicArgs
```
public Map<String,Object> getDynamicArgs()
```
  - getExecutionDirectory
```
public File getExecutionDirectory()
```
  - isPrintErrors
```
public boolean isPrintErrors()
```
  - setThrowException
```
public void setThrowException(boolean throwException)
```
  - isThrowException
```
public boolean isThrowException()
```
  - setIncludes
```
public void setIncludes(String... includes)
```
  - setExcludes
```
public void setExcludes(String... excludes)
```
  - getExcludes
```
public List<String> getExcludes()
```
  - getIncludes
```
public List<String> getIncludes()
```
  - asMap
```
public Map<String,Object> asMap()
```
    Returns the stored options as a Map<String,Object>
    
    Returns:
    
    map with options

Class Options

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

OFFLINE

VERBOSE

PRINT_ERRORS

THROW_EXCEPTION

INCLUDES

EXCLUDES

EXECUTION_DIRECTORY

CONFIGURATION_FILE_FORMAT

DYNAMIC_ARGS

CHAIN_PATH

Constructor Detail

Options

Options

Method Detail

setConfigurationFormat

getConfigurationFormat

setOffline

isOffline

getPath

setPath

setVerbose

isVerbose

setPrintErrors

setExecutionDirectory

setDynamicArgs

getDynamicArgs

getExecutionDirectory

isPrintErrors

setThrowException

isThrowException

setIncludes

setExcludes

getExcludes

getIncludes

asMap