org.apache.beam.sdk.schemas

Class FieldValueTypeInformation

java.lang.Object

org.apache.beam.sdk.schemas.FieldValueTypeInformation

All Implemented Interfaces:

java.io.Serializable

public abstract class FieldValueTypeInformation
extends java.lang.Object
implements java.io.Serializable

Represents type information for a Java type that will be used to infer a Schema type.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FieldValueTypeInformation.Builder

Constructor Summary

Constructors

Constructor and Description
FieldValueTypeInformation()

Method Summary

Modifier and Type	Method and Description
static FieldValueTypeInformation	forField(java.lang.reflect.Field field, int index)
static FieldValueTypeInformation	forGetter(java.lang.reflect.Method method, int index)
static FieldValueTypeInformation	forOneOf(java.lang.String name, boolean nullable, java.util.Map<java.lang.String,FieldValueTypeInformation> oneOfTypes)
static FieldValueTypeInformation	forSetter(java.lang.reflect.Method method)
static FieldValueTypeInformation	forSetter(java.lang.reflect.Method method, java.lang.String setterPrefix)
abstract @Nullable FieldValueTypeInformation	getElementType() If the field is a container type, returns the element type.
abstract @Nullable java.lang.reflect.Field	getField()
abstract @Nullable FieldValueTypeInformation	getMapKeyType() If the field is a map type, returns the key type.
abstract @Nullable FieldValueTypeInformation	getMapValueType() If the field is a map type, returns the key type.
abstract @Nullable java.lang.reflect.Method	getMethod()
abstract java.lang.String	getName() Returns the field name.
static <T extends java.lang.reflect.AnnotatedElement & java.lang.reflect.Member> java.lang.String	getNameOverride(java.lang.String original, T member)
abstract @Nullable java.lang.Integer	getNumber() Optionally returns the field index.
static <T extends java.lang.reflect.AnnotatedElement & java.lang.reflect.Member> int	getNumberOverride(int index, T member)
abstract java.util.Map<java.lang.String,FieldValueTypeInformation>	getOneOfTypes()
abstract java.lang.Class	getRawType() Returns the raw class type.
abstract TypeDescriptor	getType() Returns the field type.
abstract boolean	isNullable() Returns whether the field is nullable.
FieldValueTypeInformation	withName(java.lang.String name)

Methods inherited from class java.lang.Object

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

Constructor Detail

FieldValueTypeInformation

public FieldValueTypeInformation()

Method Detail

getNumber

public abstract @Nullable java.lang.Integer getNumber()

Optionally returns the field index.

getName

public abstract java.lang.String getName()

Returns the field name.

isNullable

public abstract boolean isNullable()

Returns whether the field is nullable.

getType

public abstract TypeDescriptor getType()

Returns the field type.

getRawType

public abstract java.lang.Class getRawType()

Returns the raw class type.

getField

public abstract @Nullable java.lang.reflect.Field getField()

getMethod

public abstract @Nullable java.lang.reflect.Method getMethod()

getOneOfTypes

public abstract java.util.Map<java.lang.String,FieldValueTypeInformation> getOneOfTypes()

getElementType

public abstract @Nullable FieldValueTypeInformation getElementType()

If the field is a container type, returns the element type.

getMapKeyType

public abstract @Nullable FieldValueTypeInformation getMapKeyType()

If the field is a map type, returns the key type.

getMapValueType

public abstract @Nullable FieldValueTypeInformation getMapValueType()

If the field is a map type, returns the key type.

forOneOf

public static FieldValueTypeInformation forOneOf(java.lang.String name,
                                                 boolean nullable,
                                                 java.util.Map<java.lang.String,FieldValueTypeInformation> oneOfTypes)

forField

public static FieldValueTypeInformation forField(java.lang.reflect.Field field,
                                                 int index)

getNumberOverride

public static <T extends java.lang.reflect.AnnotatedElement & java.lang.reflect.Member> int getNumberOverride(int index,
                                                                                                              T member)

getNameOverride

public static <T extends java.lang.reflect.AnnotatedElement & java.lang.reflect.Member> java.lang.String getNameOverride(java.lang.String original,
                                                                                                                         T member)

forGetter

public static FieldValueTypeInformation forGetter(java.lang.reflect.Method method,
                                                  int index)

forSetter

public static FieldValueTypeInformation forSetter(java.lang.reflect.Method method)

forSetter

public static FieldValueTypeInformation forSetter(java.lang.reflect.Method method,
                                                  java.lang.String setterPrefix)

withName

public FieldValueTypeInformation withName(java.lang.String name)