org.apache.parquet.conf

Interface ParquetConfiguration

All Superinterfaces:

Iterable<Map.Entry<String,String>>

All Known Implementing Classes:

PlainParquetConfiguration

public interface ParquetConfiguration
extends Iterable<Map.Entry<String,String>>

Configuration interface with the methods necessary to configure Parquet applications.

Method Summary

Modifier and Type	Method and Description
String	get(String name) Gets the value of the name property.
String	get(String name, String defaultValue) Gets the value of the name property.
boolean	getBoolean(String name, boolean defaultValue) Gets the value of the name property as a boolean.
Class<?>	getClass(String name, Class<?> defaultValue) Gets the value of the name property as a class.
<U> Class<? extends U>	getClass(String name, Class<? extends U> defaultValue, Class<U> xface) Gets the value of the name property as a class implementing the xface interface.
Class<?>	getClassByName(String name) Load a class by name.
int	getInt(String name, int defaultValue) Gets the value of the name property as an integer.
long	getLong(String name, long defaultValue) Gets the value of the name property as a long.
String[]	getStrings(String name, String[] defaultValue) Gets the value of the name property as an array of Strings.
String	getTrimmed(String name) Gets the trimmed value of the name property.
String	getTrimmed(String name, String defaultValue) Gets the trimmed value of the name property as a boolean.
void	set(String name, String value) Sets the value of the name property.
void	setBoolean(String name, boolean value) Sets the value of the name property to a boolean.
void	setClass(String name, Class<?> value, Class<?> xface) Sets the value of the name property to a class.
void	setInt(String name, int value) Sets the value of the name property to an integer.
void	setLong(String name, long value) Sets the value of the name property to a long.
void	setStrings(String name, String... value) Sets the value of the name property to an array of comma delimited values.

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Method Detail

set

void set(String name,
         String value)

Sets the value of the name property.

Parameters:

name - the property to set

value - the value to set the property to

setLong

void setLong(String name,
             long value)

Sets the value of the name property to a long.

Parameters:

name - the property to set

value - the value to set the property to

setInt

void setInt(String name,
            int value)

Sets the value of the name property to an integer.

Parameters:

name - the property to set

value - the value to set the property to

setBoolean

void setBoolean(String name,
                boolean value)

Sets the value of the name property to a boolean.

Parameters:

name - the property to set

value - the value to set the property to

setStrings

void setStrings(String name,
                String... value)

Sets the value of the name property to an array of comma delimited values.

Parameters:

name - the property to set

value - the values to set the property to

setClass

void setClass(String name,
              Class<?> value,
              Class<?> xface)

Sets the value of the name property to a class.

Parameters:

name - the property to set

value - the value to set the property to

xface - the interface implemented by the value

get

String get(String name)

Gets the value of the name property. Returns null if no such value exists.

Parameters:

name - the property to retrieve the value of

Returns:

the value of the property, or null if it does not exist

get

String get(String name,
           String defaultValue)

Gets the value of the name property. Returns the default value if no such value exists.

Parameters:

name - the property to retrieve the value of

defaultValue - the default return if no value is set for the property

Returns:

the value of the property, or the default value if it does not exist

getLong

long getLong(String name,
             long defaultValue)

Gets the value of the name property as a long. Returns the default value if no such value exists.

Parameters:

name - the property to retrieve the value of

defaultValue - the default return if no value is set for the property

Returns:

the value of the property as a long, or the default value if it does not exist

getInt

int getInt(String name,
           int defaultValue)

Gets the value of the name property as an integer. Returns the default value if no such value exists.

Parameters:

name - the property to retrieve the value of

defaultValue - the default return if no value is set for the property

Returns:

the value of the property as an integer, or the default value if it does not exist

getBoolean

boolean getBoolean(String name,
                   boolean defaultValue)

Gets the value of the name property as a boolean. Returns the default value if no such value exists.

Parameters:

name - the property to retrieve the value of

defaultValue - the default return if no value is set for the property

Returns:

the value of the property as a boolean, or the default value if it does not exist

getTrimmed

String getTrimmed(String name)

Gets the trimmed value of the name property. Returns null if no such value exists.

Parameters:

name - the property to retrieve the value of

Returns:

the trimmed value of the property, or null if it does not exist

getTrimmed

String getTrimmed(String name,
                  String defaultValue)

Gets the trimmed value of the name property as a boolean. Returns the default value if no such value exists.

Parameters:

name - the property to retrieve the value of

defaultValue - the default return if no value is set for the property

Returns:

the trimmed value of the property, or the default value if it does not exist

getStrings

String[] getStrings(String name,
                    String[] defaultValue)

Gets the value of the name property as an array of Strings. Returns the default value if no such value exists. Interprets the stored value as a comma delimited array.

Parameters:

name - the property to retrieve the value of

defaultValue - the default return if no value is set for the property

Returns:

the value of the property as an array, or the default value if it does not exist

getClass

Class<?> getClass(String name,
                  Class<?> defaultValue)

Gets the value of the name property as a class. Returns the default value if no such value exists.

Parameters:

name - the property to retrieve the value of

defaultValue - the default return if no value is set for the property

Returns:

the value of the property as a class, or the default value if it does not exist

getClass

<U> Class<? extends U> getClass(String name,
                                Class<? extends U> defaultValue,
                                Class<U> xface)

Gets the value of the name property as a class implementing the xface interface. Returns the default value if no such value exists.

Parameters:

name - the property to retrieve the value of

defaultValue - the default return if no value is set for the property

Returns:

the value of the property as a class, or the default value if it does not exist

getClassByName

Class<?> getClassByName(String name)
                 throws ClassNotFoundException

Load a class by name.

Parameters:

name - the name of the Class to load

Returns:

the loaded class

Throws:

ClassNotFoundException - when the specified class cannot be found