azkaban.utils

Class Props

java.lang.Object

azkaban.utils.Props

public class Props
extends java.lang.Object

Hashmap implementation of a hierarchical properties with helpful converter functions and Exception throwing. This class is not threadsafe.

Constructor Summary

Constructors

Constructor and Description
Props() Constructor for empty props with empty parent.
Props(Props parent) Constructor for empty Props with parent override.
Props(Props parent, java.io.File file) Load props from a file.
Props(Props parent, java.io.InputStream inputStream) Create props from property input streams
Props(Props parent, java.util.Map<java.lang.String,java.lang.String>... props) Create properties from maps of properties
Props(Props parent, java.util.Properties... properties) Create properties from Properties objects
Props(Props parent, Props props) Create a Props object with the contents set to that of props.
Props(Props parent, java.lang.String filepath) Load props from a file.

Method Summary

Modifier and Type	Method and Description
void	clearLocal() Clear the current Props, but leaves the parent untouched.
static Props	clone(Props p) Clones the Props p object and all of its parents.
boolean	containsKey(java.lang.Object k) Check key in current Props then search in parent
boolean	containsValue(java.lang.Object value) Check value in current Props then search in parent
boolean	equals(java.lang.Object o) override object's default equal function
java.lang.String	get(java.lang.Object key) Return value if available in current Props otherwise return from parent
boolean	getBoolean(java.lang.String key) Returns true if the value equals "true".
boolean	getBoolean(java.lang.String key, boolean defaultValue) Returns true if the value equals "true".
java.lang.Class<?>	getClass(java.lang.String key) Attempts to return the Class that corresponds to the Props value.
java.lang.Class<?>	getClass(java.lang.String key, boolean initialize, java.lang.ClassLoader cl)
java.lang.Class<?>	getClass(java.lang.String key, java.lang.Class<?> defaultClass) Gets the class from the Props.
double	getDouble(java.lang.String name) Returns the double representation of the value.
double	getDouble(java.lang.String name, double defaultValue) Returns the double representation of the value.
Props	getEarliestAncestor() Get the Root Props Object
java.util.Map<java.lang.String,java.lang.String>	getFlattened() Returns a new constructed map of all the flattened properties, the item in the returned map is sorted alphabetically by the key value.
static Props	getInstance(Props parent, Props current, java.lang.String source) Create a new Props instance
int	getInt(java.lang.String name) Returns the int representation of the value.
int	getInt(java.lang.String name, int defaultValue) Returns the int representation of the value.
java.util.Set<java.lang.String>	getKeySet() Returns a set of all keys, including the parents
long	getLong(java.lang.String name) Returns the long representation of the value.
long	getLong(java.lang.String name, long defaultValue) Returns the long representation of the value.
java.util.Map<java.lang.String,java.lang.String>	getMapByPrefix(java.lang.String prefix) Get a new de-duplicated map of all the flattened properties by given prefix.
Props	getParent() Get parent Props
java.lang.String	getSource() Get Source information
java.lang.String	getString(java.lang.String key) Gets the string from the Props.
java.lang.String	getString(java.lang.String key, java.lang.String defaultValue) Gets the string from the Props.
java.util.List<java.lang.String>	getStringList(java.lang.String key) Returns a list of strings with the comma as the separator of the value
java.util.List<java.lang.String>	getStringList(java.lang.String key, java.util.List<java.lang.String> defaultValue) Returns a list of strings with the comma as the separator of the value.
java.util.List<java.lang.String>	getStringList(java.lang.String key, java.util.List<java.lang.String> defaultValue, java.lang.String sep) Returns a list of strings with the sep as the separator of the value.
java.util.List<java.lang.String>	getStringList(java.lang.String key, java.lang.String sep) Returns a list of strings with the sep as the separator of the value
java.util.List<java.lang.String>	getStringListFromCluster(java.lang.String key) Returns a list of clusters with the comma as the separator of the value e.g., for input string: "thrift://hcat1:port,thrift://hcat2:port;thrift://hcat3:port,thrift://hcat4:port;" we will get ["thrift://hcat1:port,thrift://hcat2:port", "thrift://hcat3:port,thrift://hcat4:port"] as output
java.net.URI	getUri(java.lang.String name) Returns the uri representation of the value.
java.net.URI	getUri(java.lang.String name, java.lang.Boolean addTrailingSlash)
java.net.URI	getUri(java.lang.String name, java.lang.String defaultValue) Convert a URI-formatted string value to URI object
java.net.URI	getUri(java.lang.String name, java.net.URI defaultValue) Returns the double representation of the value.
java.net.URI	getUri(java.lang.String name, java.net.URI defaultValue, java.lang.Boolean addTrailingSlash)
int	hashCode() override object's default hash code function
Props	local() Returns a copy of only the local values of this props
java.util.Set<java.lang.String>	localKeySet() Get the key set from the current Props
int	localSize() The number of unique keys defined by this Props (keys defined only in parent Props are not counted)
void	logProperties(org.apache.log4j.Logger logger, java.lang.String comment) Logs the property in the given logger
static Props	of(Props parent, java.lang.String... args) Create a Props from a list of key value pairing.
static Props	of(java.lang.String... args) Create a Props with a null parent from a list of key value pairing.
void	put(java.util.Properties properties) Put the given Properties into the Props.
java.lang.String	put(java.lang.String key, java.lang.Double value) Put Double.
java.lang.String	put(java.lang.String key, java.lang.Integer value) Put integer
java.lang.String	put(java.lang.String key, java.lang.Long value) Put Long.
java.lang.String	put(java.lang.String key, java.lang.String value) Put the given string value for the string key.
void	putAll(java.util.Map<? extends java.lang.String,? extends java.lang.String> m) Put everything in the map into the props.
void	putAll(Props p) Put all properties in the props into the current props.
void	putLocal(Props p) Puts only the local props from p into the current properties
java.lang.String	removeLocal(java.lang.Object s) Remove only the local value of key s, and not the parents.
void	setEarliestAncestor(Props parent) Set the Props Object as the root of this Props Object
void	setParent(Props prop)
Props	setSource(java.lang.String source) Set Source information
int	size() The number of unique keys defined by this Props and all parent Props
void	storeFlattened(java.io.File file) Store all properties, those local and also those in parent props
void	storeFlattened(java.io.OutputStream out) Store all properties, those local and also those in parent props
void	storeLocal(java.io.File file) Store only those properties defined at this local level
void	storeLocal(java.io.OutputStream out) Store only those properties defined at this local level
java.util.Properties	toAllProperties() Returns a java.util.Properties file populated with both current and parent properties.
java.util.Properties	toProperties() Returns a java.util.Properties file populated with the current Properties in here.
java.lang.String	toString() override object's default toString function

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Props

public Props()

Constructor for empty props with empty parent.

Props

public Props(Props parent)

Constructor for empty Props with parent override.

Props

public Props(Props parent,
             java.lang.String filepath)
      throws java.io.IOException

Load props from a file.

Throws:

java.io.IOException

Props

public Props(Props parent,
             java.io.File file)
      throws java.io.IOException

Load props from a file.

Throws:

java.io.IOException

Props

public Props(Props parent,
             java.io.InputStream inputStream)
      throws java.io.IOException

Create props from property input streams

Throws:

java.io.IOException

Props

public Props(Props parent,
             java.util.Map<java.lang.String,java.lang.String>... props)

Create properties from maps of properties

Props

public Props(Props parent,
             java.util.Properties... properties)

Create properties from Properties objects

Props

public Props(Props parent,
             Props props)

Create a Props object with the contents set to that of props.

Method Detail

of

public static Props of(java.lang.String... args)

Create a Props with a null parent from a list of key value pairing. i.e. [key1, value1, key2, value2 ...]

of

public static Props of(Props parent,
                       java.lang.String... args)

Create a Props from a list of key value pairing. i.e. [key1, value1, key2, value2 ...]

clone

public static Props clone(Props p)

Clones the Props p object and all of its parents.

getInstance

public static Props getInstance(Props parent,
                                Props current,
                                java.lang.String source)

Create a new Props instance

Parameters:

parent - parent props

current - current props

source - source value

Returns:

new Prop Instance

getEarliestAncestor

public Props getEarliestAncestor()

Get the Root Props Object

Returns:

the root Props Object or this Props itself

setEarliestAncestor

public void setEarliestAncestor(Props parent)

Set the Props Object as the root of this Props Object

Parameters:

parent - the earliest ancestor Props Object

clearLocal

public void clearLocal()

Clear the current Props, but leaves the parent untouched.

containsKey

public boolean containsKey(java.lang.Object k)

Check key in current Props then search in parent

containsValue

public boolean containsValue(java.lang.Object value)

Check value in current Props then search in parent

get

public java.lang.String get(java.lang.Object key)

Return value if available in current Props otherwise return from parent

localKeySet

public java.util.Set<java.lang.String> localKeySet()

Get the key set from the current Props

getParent

public Props getParent()

Get parent Props

setParent

public void setParent(Props prop)

put

public java.lang.String put(java.lang.String key,
                            java.lang.String value)

Put the given string value for the string key. This method performs any variable substitution in the value replacing any occurance of ${name} with the value of get("name").

Parameters:

key - The key to put the value to

value - The value to do substitution on and store

Throws:

java.lang.IllegalArgumentException - If the variable given for substitution is not a valid key in this Props.

put

public void put(java.util.Properties properties)

Put the given Properties into the Props. This method performs any variable substitution in the value replacing any occurrence of ${name} with the value of get("name"). get() is called first on the Props and next on the Properties object.

Parameters:

properties - The properties to put

Throws:

java.lang.IllegalArgumentException - If the variable given for substitution is not a valid key in this Props.

put

public java.lang.String put(java.lang.String key,
                            java.lang.Integer value)

Put integer

put

public java.lang.String put(java.lang.String key,
                            java.lang.Long value)

Put Long. Stores as String.

put

public java.lang.String put(java.lang.String key,
                            java.lang.Double value)

Put Double. Stores as String.

putAll

public void putAll(java.util.Map<? extends java.lang.String,? extends java.lang.String> m)

Put everything in the map into the props.

putAll

public void putAll(Props p)

Put all properties in the props into the current props. Will handle null p.

putLocal

public void putLocal(Props p)

Puts only the local props from p into the current properties

removeLocal

public java.lang.String removeLocal(java.lang.Object s)

Remove only the local value of key s, and not the parents.

size

public int size()

The number of unique keys defined by this Props and all parent Props

localSize

public int localSize()

The number of unique keys defined by this Props (keys defined only in parent Props are not counted)

getClass

public java.lang.Class<?> getClass(java.lang.String key)

Attempts to return the Class that corresponds to the Props value. If the class doesn't exit, an IllegalArgumentException will be thrown.

getClass

public java.lang.Class<?> getClass(java.lang.String key,
                                   boolean initialize,
                                   java.lang.ClassLoader cl)

getClass

public java.lang.Class<?> getClass(java.lang.String key,
                                   java.lang.Class<?> defaultClass)

Gets the class from the Props. If it doesn't exist, it will return the defaultClass

getString

public java.lang.String getString(java.lang.String key,
                                  java.lang.String defaultValue)

Gets the string from the Props. If it doesn't exist, it will return the defaultValue

getString

public java.lang.String getString(java.lang.String key)

Gets the string from the Props. If it doesn't exist, throw and UndefinedPropertiesException

getStringList

public java.util.List<java.lang.String> getStringList(java.lang.String key)

Returns a list of strings with the comma as the separator of the value

getStringListFromCluster

public java.util.List<java.lang.String> getStringListFromCluster(java.lang.String key)

Returns a list of clusters with the comma as the separator of the value e.g., for input string: "thrift://hcat1:port,thrift://hcat2:port;thrift://hcat3:port,thrift://hcat4:port;" we will get ["thrift://hcat1:port,thrift://hcat2:port", "thrift://hcat3:port,thrift://hcat4:port"] as output

getStringList

public java.util.List<java.lang.String> getStringList(java.lang.String key,
                                                      java.lang.String sep)

Returns a list of strings with the sep as the separator of the value

getStringList

public java.util.List<java.lang.String> getStringList(java.lang.String key,
                                                      java.util.List<java.lang.String> defaultValue)

Returns a list of strings with the comma as the separator of the value. If the value is null, it'll return the defaultValue.

getStringList

public java.util.List<java.lang.String> getStringList(java.lang.String key,
                                                      java.util.List<java.lang.String> defaultValue,
                                                      java.lang.String sep)

Returns a list of strings with the sep as the separator of the value. If the value is null, it'll return the defaultValue.

getBoolean

public boolean getBoolean(java.lang.String key,
                          boolean defaultValue)

Returns true if the value equals "true". If the value is null, then the default value is returned.

getBoolean

public boolean getBoolean(java.lang.String key)

Returns true if the value equals "true". If the value is null, then an UndefinedPropertyException is thrown.

getLong

public long getLong(java.lang.String name,
                    long defaultValue)

Returns the long representation of the value. If the value is null, then the default value is returned. If the value isn't a long, then a parse exception will be thrown.

getLong

public long getLong(java.lang.String name)

Returns the long representation of the value. If the value is null, then a UndefinedPropertyException will be thrown. If the value isn't a long, then a parse exception will be thrown.

getInt

public int getInt(java.lang.String name,
                  int defaultValue)

Returns the int representation of the value. If the value is null, then the default value is returned. If the value isn't a int, then a parse exception will be thrown.

getInt

public int getInt(java.lang.String name)

Returns the int representation of the value. If the value is null, then a UndefinedPropertyException will be thrown. If the value isn't a int, then a parse exception will be thrown.

getDouble

public double getDouble(java.lang.String name,
                        double defaultValue)

Returns the double representation of the value. If the value is null, then the default value is returned. If the value isn't a double, then a parse exception will be thrown.

getDouble

public double getDouble(java.lang.String name)

Returns the double representation of the value. If the value is null, then a UndefinedPropertyException will be thrown. If the value isn't a double, then a parse exception will be thrown.

getUri

public java.net.URI getUri(java.lang.String name)

Returns the uri representation of the value. If the value is null, then an UndefinedPropertyException will be thrown. If the value isn't a uri, then an IllegalArgumentException will be thrown. If addTrailingSlash is true and the value isn't null, a trailing forward slash will be added to the URI.

getUri

public java.net.URI getUri(java.lang.String name,
                           java.lang.Boolean addTrailingSlash)

getUri

public java.net.URI getUri(java.lang.String name,
                           java.net.URI defaultValue)

Returns the double representation of the value. If the value is null, then the default value is returned. If the value isn't a uri, then a IllegalArgumentException will be thrown. If addTrailingSlash is true and the value isn't null, a trailing forward slash will be added to the URI.

getUri

public java.net.URI getUri(java.lang.String name,
                           java.net.URI defaultValue,
                           java.lang.Boolean addTrailingSlash)

getUri

public java.net.URI getUri(java.lang.String name,
                           java.lang.String defaultValue)

Convert a URI-formatted string value to URI object

storeLocal

public void storeLocal(java.io.File file)
                throws java.io.IOException

Store only those properties defined at this local level

Parameters:

file - The file to write to

Throws:

java.io.IOException - If the file can't be found or there is an io error

local

public Props local()

Returns a copy of only the local values of this props

storeLocal

public void storeLocal(java.io.OutputStream out)
                throws java.io.IOException

Store only those properties defined at this local level

Parameters:

out - The output stream to write to

Throws:

java.io.IOException - If the file can't be found or there is an io error

toProperties

public java.util.Properties toProperties()

Returns a java.util.Properties file populated with the current Properties in here. Note: if you want to import parent properties (e.g., database credentials), please use toAllProperties

toAllProperties

public java.util.Properties toAllProperties()

Returns a java.util.Properties file populated with both current and parent properties.

storeFlattened

public void storeFlattened(java.io.File file)
                    throws java.io.IOException

Store all properties, those local and also those in parent props

Parameters:

file - The file to store to

Throws:

java.io.IOException - If there is an error writing

storeFlattened

public void storeFlattened(java.io.OutputStream out)
                    throws java.io.IOException

Store all properties, those local and also those in parent props

Parameters:

out - The stream to write to

Throws:

java.io.IOException - If there is an error writing

getFlattened

public java.util.Map<java.lang.String,java.lang.String> getFlattened()

Returns a new constructed map of all the flattened properties, the item in the returned map is sorted alphabetically by the key value.

getMapByPrefix

public java.util.Map<java.lang.String,java.lang.String> getMapByPrefix(java.lang.String prefix)

Get a new de-duplicated map of all the flattened properties by given prefix. The prefix will be removed in the return map's keySet.

Parameters:

prefix - the prefix string

Returns:

a new constructed de-duplicated HashMap of all properties (including parents' properties) with the give prefix

getKeySet

public java.util.Set<java.lang.String> getKeySet()

Returns a set of all keys, including the parents

logProperties

public void logProperties(org.apache.log4j.Logger logger,
                          java.lang.String comment)

Logs the property in the given logger

equals

public boolean equals(java.lang.Object o)

override object's default equal function

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

override object's default hash code function

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

override object's default toString function

Overrides:

toString in class java.lang.Object

getSource

public java.lang.String getSource()

Get Source information

setSource

public Props setSource(java.lang.String source)

Set Source information