org.teiid.modeshape.sequencer

Class Options

java.lang.Object

org.teiid.modeshape.sequencer.Options

public class Options
extends Object

A collection of Exporter.execute(Node, Options) options. If an option is not found, the default value will be used.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Options.PropertyFilter Filters the properties that will be exported.

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_INDENT_AMOUNT The default option value for the number of spaces for each indent level of the output.
static boolean	DEFAULT_PRETTY_PRINT The default option value for if pretty printing the output is desired.
static Options.PropertyFilter	DEFAULT_PROPERTY_FILTER A default property filter that filters out properties of these namespaces:
static String	INDENT_AMOUNT_PROPERTY The option name for the number of spaces for each indent level of the output.
static String	PRETTY_PRINT_PROPERTY The option name for if pretty printing the output is desired.
static String	PROPERTY_FILTER_PROPERTY The option name for the properties filter.

Constructor Summary

Constructors

Constructor and Description
Options()

Method Summary

Modifier and Type	Method and Description
Object	get(String name)
Object	get(String name, Object defaultValue)
Object	set(String name, Object value) Removes the named option if the value is null or an empty String.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_INDENT_AMOUNT

public static final int DEFAULT_INDENT_AMOUNT

The default option value for the number of spaces for each indent level of the output. Value is 4.

See Also:

Constant Field Values

DEFAULT_PRETTY_PRINT

public static final boolean DEFAULT_PRETTY_PRINT

The default option value for if pretty printing the output is desired. Value is true.

See Also:

Constant Field Values

DEFAULT_PROPERTY_FILTER

public static final Options.PropertyFilter DEFAULT_PROPERTY_FILTER

A default property filter that filters out properties of these namespaces:

• jcr
• jdbc
• med
• mix
• mmcore
• mode
• nt
• relational
• transformation
• vdb
• xmi

See Also:

Options.PropertyFilter

INDENT_AMOUNT_PROPERTY

public static final String INDENT_AMOUNT_PROPERTY

The option name for the number of spaces for each indent level of the output.

See Also:

Constant Field Values

PRETTY_PRINT_PROPERTY

public static final String PRETTY_PRINT_PROPERTY

The option name for if pretty printing the output is desired.

See Also:

Constant Field Values

PROPERTY_FILTER_PROPERTY

public static final String PROPERTY_FILTER_PROPERTY

The option name for the properties filter.

See Also:

Options.PropertyFilter, Constant Field Values

Constructor Detail

Options

public Options()

Method Detail

get

public Object get(String name)
           throws RuntimeException

Parameters:

name - the option name (cannot be null or empty)

Returns:

the value (can be null if not found)

Throws:

RuntimeException - if option name is null or empty

get

public Object get(String name,
                  Object defaultValue)
           throws RuntimeException

Parameters:

name - the option name (cannot be null or empty)

defaultValue - the value to return if the option is not found (cannot be null)

Returns:

the value (never null)

Throws:

RuntimeException - if option name or default value is null or empty

set

public Object set(String name,
                  Object value)

Removes the named option if the value is null or an empty String.

Parameters:

name - the option name (cannot be null or empty)

value - the current value (can be null)

Returns:

the previous value of the option (can be null)

toString

public String toString()

Overrides:

toString in class Object

See Also:

Object.toString()