org.apache.gobblin.configuration

Class State

java.lang.Object

org.apache.gobblin.configuration.State

All Implemented Interfaces:

WritableShim

Direct Known Subclasses:

CheckpointableWatermarkState, Extract, SourceState, State, WorkUnit, WorkUnitState

public class State
extends Object
implements WritableShim

A serializable wrapper class that can be persisted for Properties.

Constructor Summary

Constructors

Constructor and Description
State()
State(Properties properties)
State(State otherState)

Method Summary

Modifier and Type	Method and Description
void	addAll(Properties properties) Populates this instance with values of a Properties instance.
void	addAll(State otherState) Populates this instance with properties of the other instance.
void	addAllIfNotExist(Properties properties) Add properties in a Properties instance that are not in the current instance.
void	addAllIfNotExist(State otherState) Add properties in a State instance that are not in the current instance.
void	appendToListProp(String key, String value) Appends the input value to a list property that can be retrieved with getPropAsList(java.lang.String).
void	appendToSetProp(String key, String value) Appends the input value to a set property that can be retrieved with getPropAsSet(java.lang.String).
boolean	contains(String key) Check if a property is set.
String	getId() Get the id of this instance.
String	getProp(String key) Get the value of a property.
String	getProp(String key, String def) Get the value of a property, using the given default value if the property is not set.
boolean	getPropAsBoolean(String key) Get the value of a property as a boolean.
boolean	getPropAsBoolean(String key, boolean def) Get the value of a property as a boolean, using the given default value if the property is not set.
Set<String>	getPropAsCaseInsensitiveSet(String key) Get the value of a property as a case insensitive Set of strings.
Set<String>	getPropAsCaseInsensitiveSet(String key, String def) Get the value of a property as a case insensitive Set of strings, using the given default value if the property is not set.
double	getPropAsDouble(String key) Get the value of a property as a double.
double	getPropAsDouble(String key, double def) Get the value of a property as a double, using the given default value if the property is not set.
int	getPropAsInt(String key) Get the value of a property as an integer.
int	getPropAsInt(String key, int def) Get the value of a property as an integer, using the given default value if the property is not set.
com.google.gson.JsonArray	getPropAsJsonArray(String key) Get the value of a property as a JsonArray.
List<String>	getPropAsList(String key) Get the value of a comma separated property as a List of strings.
List<String>	getPropAsList(String key, String def) Get the value of a property as a list of strings, using the given default value if the property is not set.
long	getPropAsLong(String key) Get the value of a property as a long integer.
long	getPropAsLong(String key, long def) Get the value of a property as a long integer, using the given default value if the property is not set.
Set<String>	getPropAsSet(String key) Get the value of a comma separated property as a Set of strings.
Set<String>	getPropAsSet(String key, String def) Get the value of a comma separated property as a Set of strings.
short	getPropAsShort(String key) Get the value of a property as a short.
short	getPropAsShort(String key, short def) Get the value of a property as an short, using the given default value if the property is not set.
short	getPropAsShortWithRadix(String key, int radix) Get the value of a property as a short.
short	getPropAsShortWithRadix(String key, short def, int radix) Get the value of a property as an short, using the given default value if the property is not set.
Properties	getProperties() Return a copy of the underlying Properties object.
protected String	getProperty(String key) Deprecated. Use getProp(String)
protected String	getProperty(String key, String def) Deprecated. Use getProp(String, String)
Set<String>	getPropertyNames() Get the names of all the properties set in a Set.
void	overrideWith(Properties properties) Add properties in a Properties instance that are in the current instance.
void	overrideWith(State otherState) Add properties in a State instance that are in the current instance.
void	readFields(DataInput in)
void	removeProp(String key) Remove a property if it exists.
void	removePropsWithPrefix(String prefix) Remove all properties with a certain keyPrefix
void	setId(String id) Set the id used for state persistence and logging.
void	setProp(String key, Object value) Set a property.
void	setProps(Properties commonProperties, Properties specProperties) Override existing commonProperties and specProperties.
String	toString()
void	write(DataOutput out)

Methods inherited from class java.lang.Object

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

Constructor Detail

State

public State()

State

public State(Properties properties)

State

public State(State otherState)

Method Detail

getProperties

public Properties getProperties()

Return a copy of the underlying Properties object.

Returns:

A copy of the underlying Properties object.

addAll

public void addAll(State otherState)

Populates this instance with properties of the other instance.

Parameters:

otherState - the other State instance

addAll

public void addAll(Properties properties)

Populates this instance with values of a Properties instance.

Parameters:

properties - a Properties instance

addAllIfNotExist

public void addAllIfNotExist(State otherState)

Add properties in a State instance that are not in the current instance.

Parameters:

otherState - a State instance

addAllIfNotExist

public void addAllIfNotExist(Properties properties)

Add properties in a Properties instance that are not in the current instance.

Parameters:

properties - a Properties instance

overrideWith

public void overrideWith(State otherState)

Add properties in a State instance that are in the current instance.

Parameters:

otherState - a State instance

overrideWith

public void overrideWith(Properties properties)

Add properties in a Properties instance that are in the current instance.

Parameters:

properties - a Properties instance

setId

public void setId(String id)

Set the id used for state persistence and logging.

Parameters:

id - id of this instance

getId

public String getId()

Get the id of this instance.

Returns:

id of this instance

setProp

public void setProp(String key,
                    Object value)

Set a property.

Both key and value are stored as strings.

Parameters:

key - property key

value - property value

setProps

public void setProps(Properties commonProperties,
                     Properties specProperties)

Override existing commonProperties and specProperties.

Parameters:

commonProperties -

specProperties -

appendToListProp

public void appendToListProp(String key,
                             String value)

Appends the input value to a list property that can be retrieved with getPropAsList(java.lang.String).

List properties are internally stored as comma separated strings. Adding a value that contains commas (for example "a,b,c") will essentially add multiple values to the property ("a", "b", and "c"). This is similar to the way that Configuration works.

Parameters:

key - property key

value - property value (if it includes commas, it will be split by the commas).

appendToSetProp

public void appendToSetProp(String key,
                            String value)

Appends the input value to a set property that can be retrieved with getPropAsSet(java.lang.String).

Set properties are internally stored as comma separated strings. Adding a value that contains commas (for example "a,b,c") will essentially add multiple values to the property ("a", "b", and "c"). This is similar to the way that Configuration works.

Parameters:

key - property key

value - property value (if it includes commas, it will be split by the commas).

getProp

public String getProp(String key)

Get the value of a property.

Parameters:

key - property key

Returns:

value associated with the key as a string or null if the property is not set

getProp

public String getProp(String key,
                      String def)

Get the value of a property, using the given default value if the property is not set.

Parameters:

key - property key

def - default value

Returns:

value associated with the key or the default value if the property is not set

getPropAsList

public List<String> getPropAsList(String key)

Get the value of a comma separated property as a List of strings.

Parameters:

key - property key

Returns:

value associated with the key as a List of strings

getPropAsList

public List<String> getPropAsList(String key,
                                  String def)

Get the value of a property as a list of strings, using the given default value if the property is not set.

Parameters:

key - property key

def - default value

Returns:

value (the default value if the property is not set) associated with the key as a list of strings

getPropAsSet

public Set<String> getPropAsSet(String key)

Get the value of a comma separated property as a Set of strings.

Parameters:

key - property key

Returns:

value associated with the key as a Set of strings

getPropAsSet

public Set<String> getPropAsSet(String key,
                                String def)

Get the value of a comma separated property as a Set of strings.

Parameters:

key - property key

def - default value

Returns:

value (the default value if the property is not set) associated with the key as a Set of strings

getPropAsCaseInsensitiveSet

public Set<String> getPropAsCaseInsensitiveSet(String key)

Get the value of a property as a case insensitive Set of strings.

Parameters:

key - property key

Returns:

value associated with the key as a case insensitive Set of strings

getPropAsCaseInsensitiveSet

public Set<String> getPropAsCaseInsensitiveSet(String key,
                                               String def)

Get the value of a property as a case insensitive Set of strings, using the given default value if the property is not set.

Parameters:

key - property key

def - default value

Returns:

value associated with the key as a case insensitive Set of strings

getPropAsLong

public long getPropAsLong(String key)

Get the value of a property as a long integer.

Parameters:

key - property key

Returns:

long integer value associated with the key

getPropAsLong

public long getPropAsLong(String key,
                          long def)

Get the value of a property as a long integer, using the given default value if the property is not set.

Parameters:

key - property key

def - default value

Returns:

long integer value associated with the key or the default value if the property is not set

getPropAsInt

public int getPropAsInt(String key)

Get the value of a property as an integer.

Parameters:

key - property key

Returns:

integer value associated with the key

getPropAsInt

public int getPropAsInt(String key,
                        int def)

Get the value of a property as an integer, using the given default value if the property is not set.

Parameters:

key - property key

def - default value

Returns:

integer value associated with the key or the default value if the property is not set

getPropAsShort

public short getPropAsShort(String key)

Get the value of a property as a short.

Parameters:

key - property key

Returns:

short value associated with the key

getPropAsShortWithRadix

public short getPropAsShortWithRadix(String key,
                                     int radix)

Get the value of a property as a short.

Parameters:

key - property key

radix - radix used to parse the value

Returns:

short value associated with the key

getPropAsShort

public short getPropAsShort(String key,
                            short def)

Get the value of a property as an short, using the given default value if the property is not set.

Parameters:

key - property key

def - default value

Returns:

short value associated with the key or the default value if the property is not set

getPropAsShortWithRadix

public short getPropAsShortWithRadix(String key,
                                     short def,
                                     int radix)

Get the value of a property as an short, using the given default value if the property is not set.

Parameters:

key - property key

def - default value

radix - radix used to parse the value

Returns:

short value associated with the key or the default value if the property is not set

getPropAsDouble

public double getPropAsDouble(String key)

Get the value of a property as a double.

Parameters:

key - property key

Returns:

double value associated with the key

getPropAsDouble

public double getPropAsDouble(String key,
                              double def)

Get the value of a property as a double, using the given default value if the property is not set.

Parameters:

key - property key

def - default value

Returns:

double value associated with the key or the default value if the property is not set

getPropAsBoolean

public boolean getPropAsBoolean(String key)

Get the value of a property as a boolean.

Parameters:

key - property key

Returns:

boolean value associated with the key

getPropAsBoolean

public boolean getPropAsBoolean(String key,
                                boolean def)

Get the value of a property as a boolean, using the given default value if the property is not set.

Parameters:

key - property key

def - default value

Returns:

boolean value associated with the key or the default value if the property is not set

getPropAsJsonArray

public com.google.gson.JsonArray getPropAsJsonArray(String key)

Get the value of a property as a JsonArray.

Parameters:

key - property key

Returns:

JsonArray value associated with the key

removeProp

public void removeProp(String key)

Remove a property if it exists.

Parameters:

key - property key

removePropsWithPrefix

public void removePropsWithPrefix(String prefix)

Remove all properties with a certain keyPrefix

Parameters:

prefix - key prefix

getProperty

@Deprecated
protected String getProperty(String key)

Deprecated. Use getProp(String)

getProperty

@Deprecated
protected String getProperty(String key,
                                         String def)

Deprecated. Use getProp(String, String)

getPropertyNames

public Set<String> getPropertyNames()

Get the names of all the properties set in a Set.

Returns:

names of all the properties set in a Set

contains

public boolean contains(String key)

Check if a property is set.

Parameters:

key - property key

Returns:

true if the property is set or false otherwise

readFields

public void readFields(DataInput in)
                throws IOException

Specified by:

readFields in interface WritableShim

Throws:

IOException

write

public void write(DataOutput out)
           throws IOException

Specified by:

write in interface WritableShim

Throws:

IOException

toString

public String toString()

Overrides:

toString in class Object