org.apache.hudi.storage

Class StorageConfiguration<T>

java.lang.Object

org.apache.hudi.storage.StorageConfiguration<T>

Type Parameters:

T - type of storage configuration to provide.

All Implemented Interfaces:

Serializable

public abstract class StorageConfiguration<T>
extends Object
implements Serializable

Interface providing the storage configuration in type T.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
StorageConfiguration()

Method Summary

Modifier and Type	Method and Description
static <U> U	castConfiguration(Object conf, Class<U> clazz)
boolean	getBoolean(String key, boolean defaultValue) Gets the boolean value of a property key if present, or the default value if not.
<T extends Enum<T>> T	getEnum(String key, T defaultValue) Gets the Enum value of a property key if present, or the default value if not.
abstract StorageConfiguration<T>	getInline() Gets an inline version of this storage configuration
long	getLong(String key, long defaultValue) Gets the long value of a property key if present, or the default value if not.
abstract Option<String>	getString(String key) Gets the String value of a property key.
String	getString(String key, String defaultValue) Gets the String value of a property key if present, or the default value if not.
abstract StorageConfiguration<T>	newInstance()
abstract void	set(String key, String value) Sets the configuration key-value pair.
void	setIfUnset(String key, String value) Sets a property key with a value in the configuration, if the property key does not already exist.
abstract T	unwrap()
<U> U	unwrapAs(Class<U> clazz)
abstract T	unwrapCopy()
<U> U	unwrapCopyAs(Class<U> clazz)

Methods inherited from class java.lang.Object

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

Constructor Detail

StorageConfiguration

public StorageConfiguration()

Method Detail

newInstance

public abstract StorageConfiguration<T> newInstance()

Returns:

a new StorageConfiguration instance with a new copy of the configuration of type T.

unwrap

public abstract T unwrap()

Returns:

the underlying configuration of type T.

unwrapCopy

public abstract T unwrapCopy()

Returns:

a new copy of the underlying configuration of type T.

set

public abstract void set(String key,
                         String value)

Sets the configuration key-value pair.

Parameters:

key - in String.

value - in String.

getString

public abstract Option<String> getString(String key)

Gets the String value of a property key.

Parameters:

key - property key in String.

Returns:

the property value if present, or Option.empty().

getInline

public abstract StorageConfiguration<T> getInline()

Gets an inline version of this storage configuration

Returns:

copy of this storage configuration that is inline

unwrapAs

public final <U> U unwrapAs(Class<U> clazz)

Type Parameters:

U - type to return.

Parameters:

clazz - class of U, which is assignable from T.

Returns:

the underlying configuration cast to type U.

unwrapCopyAs

public final <U> U unwrapCopyAs(Class<U> clazz)

Type Parameters:

U - type to return.

Parameters:

clazz - class of U, which is assignable from T.

Returns:

a new copy of the underlying configuration cast to type U.

getString

public final String getString(String key,
                              String defaultValue)

Gets the String value of a property key if present, or the default value if not.

Parameters:

key - property key in String.

defaultValue - default value is the property does not exist.

Returns:

the property value if present, or the default value.

getBoolean

public final boolean getBoolean(String key,
                                boolean defaultValue)

Gets the boolean value of a property key if present, or the default value if not.

Parameters:

key - property key in String.

defaultValue - default value is the property does not exist.

Returns:

the property value if present, or the default value.

getLong

public final long getLong(String key,
                          long defaultValue)

Gets the long value of a property key if present, or the default value if not.

Parameters:

key - property key in String.

defaultValue - default value is the property does not exist.

Returns:

the property value if present, or the default value.

getEnum

public <T extends Enum<T>> T getEnum(String key,
                                     T defaultValue)

Gets the Enum value of a property key if present, or the default value if not.

Type Parameters:

T - Enum.

Parameters:

key - property key in String.

defaultValue - default value is the property does not exist.

Returns:

the property value if present, or the default value.

setIfUnset

public final void setIfUnset(String key,
                             String value)

Sets a property key with a value in the configuration, if the property key does not already exist.

Parameters:

key - property key.

value - property value.

castConfiguration

public static <U> U castConfiguration(Object conf,
                                      Class<U> clazz)

Type Parameters:

U - type to return.

Parameters:

conf - configuration object.

clazz - class of U.

Returns:

the configuration cast to type U.