Package org.apache.beam.sdk.schemas

Class FieldValueTypeInformation

java.lang.Object

org.apache.beam.sdk.schemas.FieldValueTypeInformation

All Implemented Interfaces:

Serializable

@Internal
public abstract class FieldValueTypeInformation
extends Object
implements 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	Description
static class	FieldValueTypeInformation.Builder

Constructor Summary

Constructors

Constructor	Description
FieldValueTypeInformation()

Method Summary

Modifier and Type	Method	Description
static FieldValueTypeInformation	forField(@Nullable TypeDescriptor<?> typeDescriptor, Field field, int index)
static FieldValueTypeInformation	forGetter(Method method, int index)
static FieldValueTypeInformation	forGetter(@Nullable TypeDescriptor<?> typeDescriptor, Method method, int index)
static FieldValueTypeInformation	forOneOf(String name, boolean nullable, Map<String,FieldValueTypeInformation> oneOfTypes)
static FieldValueTypeInformation	forSetter(Method method)
static FieldValueTypeInformation	forSetter(Method method, String setterPrefix)
static FieldValueTypeInformation	forSetter(@Nullable TypeDescriptor<?> typeDescriptor, Method method)
static FieldValueTypeInformation	forSetter(@Nullable TypeDescriptor<?> typeDescriptor, Method method, String setterPrefix)
abstract @Nullable String	getDescription()	If the field has a description, returns the description for the field.
abstract @Nullable FieldValueTypeInformation	getElementType()	If the field is a container type, returns the element type.
abstract @Nullable Field	getField()
static <T extends AnnotatedElement & Member> @Nullable String	getFieldDescription(T member)
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 Method	getMethod()
abstract String	getName()	Returns the field name.
static <T extends AnnotatedElement & Member> String	getNameOverride(String original, T member)
abstract @Nullable Integer	getNumber()	Optionally returns the field index.
static <T extends AnnotatedElement & Member> int	getNumberOverride(int index, T member)
abstract Map<String,FieldValueTypeInformation>	getOneOfTypes()
abstract 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(String name)

Methods inherited from class java.lang.Object

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

Constructor Details

FieldValueTypeInformation

public FieldValueTypeInformation()

Method Details

getNumber

public abstract @Nullable Integer getNumber()

Optionally returns the field index.

getName

public abstract 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 Class<?> getRawType()

Returns the raw class type.

getField

public abstract @Nullable Field getField()

getMethod

public abstract @Nullable Method getMethod()

getOneOfTypes

public abstract Map<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.

getDescription

public abstract @Nullable String getDescription()

If the field has a description, returns the description for the field.

forOneOf

public static FieldValueTypeInformation forOneOf(String name,
 boolean nullable,
 Map<String,FieldValueTypeInformation> oneOfTypes)

forField

public static FieldValueTypeInformation forField(@Nullable TypeDescriptor<?> typeDescriptor,
 Field field,
 int index)

getNumberOverride

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

getNameOverride

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

getFieldDescription

public static <T extends AnnotatedElement & Member>
@Nullable String getFieldDescription(T member)

forGetter

public static FieldValueTypeInformation forGetter(Method method,
 int index)

forGetter

public static FieldValueTypeInformation forGetter(@Nullable TypeDescriptor<?> typeDescriptor,
 Method method,
 int index)

forSetter

public static FieldValueTypeInformation forSetter(Method method)

forSetter

public static FieldValueTypeInformation forSetter(Method method,
 String setterPrefix)

forSetter

public static FieldValueTypeInformation forSetter(@Nullable TypeDescriptor<?> typeDescriptor,
 Method method)

forSetter

public static FieldValueTypeInformation forSetter(@Nullable TypeDescriptor<?> typeDescriptor,
 Method method,
 String setterPrefix)

withName

public FieldValueTypeInformation withName(String name)