org.apache.beam.sdk.options

Class ValueProvider.NestedValueProvider<T,X>

java.lang.Object

org.apache.beam.sdk.options.ValueProvider.NestedValueProvider<T,X>

All Implemented Interfaces:

java.io.Serializable, ValueProvider<T>

Enclosing interface:

ValueProvider<T>

public static class ValueProvider.NestedValueProvider<T,X>
extends java.lang.Object
implements ValueProvider<T>, java.io.Serializable

ValueProvider.NestedValueProvider is an implementation of ValueProvider that allows for wrapping another ValueProvider object.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.beam.sdk.options.ValueProvider

ValueProvider.Deserializer, ValueProvider.NestedValueProvider<T,X>, ValueProvider.RuntimeValueProvider<T>, ValueProvider.Serializer, ValueProvider.StaticValueProvider<T>

Method Summary

Modifier and Type	Method and Description
T	get() Returns the runtime value wrapped by this ValueProvider in case it is ValueProvider.isAccessible(), otherwise fails.
boolean	isAccessible() Whether the contents of this ValueProvider is currently available via ValueProvider.get().
static <T,X> ValueProvider.NestedValueProvider<T,X>	of(ValueProvider<X> value, SerializableFunction<X,T> translator) Creates a ValueProvider.NestedValueProvider that wraps the provided value.
java.lang.String	propertyName() Returns the property name associated with this provider.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

of

public static <T,X> ValueProvider.NestedValueProvider<T,X> of(ValueProvider<X> value,
                                                              SerializableFunction<X,T> translator)

Creates a ValueProvider.NestedValueProvider that wraps the provided value.

get

public T get()

Description copied from interface: ValueProvider

Returns the runtime value wrapped by this ValueProvider in case it is ValueProvider.isAccessible(), otherwise fails.

Specified by:

get in interface ValueProvider<T>

isAccessible

public boolean isAccessible()

Description copied from interface: ValueProvider

Whether the contents of this ValueProvider is currently available via ValueProvider.get().

Specified by:

isAccessible in interface ValueProvider<T>

propertyName

public java.lang.String propertyName()

Returns the property name associated with this provider.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object