org.apache.flink.api.common.typeinfo

Class BasicArrayTypeInfo<T,C>

java.lang.Object

org.apache.flink.api.common.typeinfo.TypeInformation<T>

org.apache.flink.api.common.typeinfo.BasicArrayTypeInfo<T,C>

Type Parameters:

T - The type (class) of the array itself.

C - The type (class) of the array component.

All Implemented Interfaces:

Serializable

@Public
public final class BasicArrayTypeInfo<T,C>
extends TypeInformation<T>

Type information for arrays boxed primitive types.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static BasicArrayTypeInfo<Boolean[],Boolean>	BOOLEAN_ARRAY_TYPE_INFO
static BasicArrayTypeInfo<Byte[],Byte>	BYTE_ARRAY_TYPE_INFO
static BasicArrayTypeInfo<Character[],Character>	CHAR_ARRAY_TYPE_INFO
static BasicArrayTypeInfo<Double[],Double>	DOUBLE_ARRAY_TYPE_INFO
static BasicArrayTypeInfo<Float[],Float>	FLOAT_ARRAY_TYPE_INFO
static BasicArrayTypeInfo<Integer[],Integer>	INT_ARRAY_TYPE_INFO
static BasicArrayTypeInfo<Long[],Long>	LONG_ARRAY_TYPE_INFO
static BasicArrayTypeInfo<Short[],Short>	SHORT_ARRAY_TYPE_INFO
static BasicArrayTypeInfo<String[],String>	STRING_ARRAY_TYPE_INFO

Method Summary

Modifier and Type	Method and Description
boolean	canEqual(Object obj) Returns true if the given object can be equaled with this object.
TypeSerializer<T>	createSerializer(ExecutionConfig config) Deprecated.
TypeSerializer<T>	createSerializer(SerializerConfig serializerConfig) Creates a serializer for the type.
boolean	equals(Object obj)
int	getArity() Gets the arity of this type - the number of fields without nesting.
TypeInformation<C>	getComponentInfo()
Class<C>	getComponentTypeClass()
static <X,C> BasicArrayTypeInfo<X,C>	getInfoFor(Class<X> type)
int	getTotalFields() Gets the number of logical fields in this type.
Class<T>	getTypeClass() Gets the class of the type represented by this type information.
int	hashCode()
boolean	isBasicType() Checks if this type information represents a basic type.
boolean	isKeyType() Checks whether this type can be used as a key.
boolean	isTupleType() Checks if this type information represents a Tuple type.
String	toString()

Methods inherited from class org.apache.flink.api.common.typeinfo.TypeInformation

getGenericParameters, isSortKeyType, of, of

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

STRING_ARRAY_TYPE_INFO

public static final BasicArrayTypeInfo<String[],String> STRING_ARRAY_TYPE_INFO

BOOLEAN_ARRAY_TYPE_INFO

public static final BasicArrayTypeInfo<Boolean[],Boolean> BOOLEAN_ARRAY_TYPE_INFO

BYTE_ARRAY_TYPE_INFO

public static final BasicArrayTypeInfo<Byte[],Byte> BYTE_ARRAY_TYPE_INFO

SHORT_ARRAY_TYPE_INFO

public static final BasicArrayTypeInfo<Short[],Short> SHORT_ARRAY_TYPE_INFO

INT_ARRAY_TYPE_INFO

public static final BasicArrayTypeInfo<Integer[],Integer> INT_ARRAY_TYPE_INFO

LONG_ARRAY_TYPE_INFO

public static final BasicArrayTypeInfo<Long[],Long> LONG_ARRAY_TYPE_INFO

FLOAT_ARRAY_TYPE_INFO

public static final BasicArrayTypeInfo<Float[],Float> FLOAT_ARRAY_TYPE_INFO

DOUBLE_ARRAY_TYPE_INFO

public static final BasicArrayTypeInfo<Double[],Double> DOUBLE_ARRAY_TYPE_INFO

CHAR_ARRAY_TYPE_INFO

public static final BasicArrayTypeInfo<Character[],Character> CHAR_ARRAY_TYPE_INFO

Method Detail

isBasicType

@PublicEvolving
public boolean isBasicType()

Description copied from class: TypeInformation

Checks if this type information represents a basic type. Basic types are defined in BasicTypeInfo and are primitives, their boxing types, Strings, Date, Void, ...

Specified by:

isBasicType in class TypeInformation<T>

Returns:

True, if this type information describes a basic type, false otherwise.

isTupleType

@PublicEvolving
public boolean isTupleType()

Description copied from class: TypeInformation

Checks if this type information represents a Tuple type. Tuple types are subclasses of the Java API tuples.

Specified by:

isTupleType in class TypeInformation<T>

Returns:

True, if this type information describes a tuple type, false otherwise.

getArity

@PublicEvolving
public int getArity()

Description copied from class: TypeInformation

Gets the arity of this type - the number of fields without nesting.

Specified by:

getArity in class TypeInformation<T>

Returns:

Gets the number of fields in this type without nesting.

getTotalFields

@PublicEvolving
public int getTotalFields()

Description copied from class: TypeInformation

Gets the number of logical fields in this type. This includes its nested and transitively nested fields, in the case of composite types. In the example above, the OuterType type has three fields in total.

The total number of fields must be at least 1.

Specified by:

getTotalFields in class TypeInformation<T>

Returns:

The number of fields in this type, including its sub-fields (for composite types)

getTypeClass

@PublicEvolving
public Class<T> getTypeClass()

Description copied from class: TypeInformation

Gets the class of the type represented by this type information.

Specified by:

getTypeClass in class TypeInformation<T>

Returns:

The class of the type represented by this type information.

getComponentTypeClass

@PublicEvolving
public Class<C> getComponentTypeClass()

getComponentInfo

@PublicEvolving
public TypeInformation<C> getComponentInfo()

isKeyType

@PublicEvolving
public boolean isKeyType()

Description copied from class: TypeInformation

Checks whether this type can be used as a key. As a bare minimum, types have to be hashable and comparable to be keys.

Specified by:

isKeyType in class TypeInformation<T>

Returns:

True, if the type can be used as a key, false otherwise.

createSerializer

@PublicEvolving
public TypeSerializer<T> createSerializer(SerializerConfig serializerConfig)

Description copied from class: TypeInformation

Creates a serializer for the type. The serializer may use the ExecutionConfig for parameterization.

Overrides:

createSerializer in class TypeInformation<T>

Parameters:

serializerConfig - The config used to parameterize the serializer.

Returns:

A serializer for this type.

createSerializer

@Deprecated
 @PublicEvolving
public TypeSerializer<T> createSerializer(ExecutionConfig config)

Deprecated.

Description copied from class: TypeInformation

Create TypeSerializer for this type.

Specified by:

createSerializer in class TypeInformation<T>

Parameters:

config - the configuration of this job execution

equals

public boolean equals(Object obj)

Specified by:

equals in class TypeInformation<T>

hashCode

public int hashCode()

Specified by:

hashCode in class TypeInformation<T>

canEqual

public boolean canEqual(Object obj)

Description copied from class: TypeInformation

Returns true if the given object can be equaled with this object. If not, it returns false.

Specified by:

canEqual in class TypeInformation<T>

Parameters:

obj - Object which wants to take part in the equality relation

Returns:

true if obj can be equaled with this, otherwise false

toString

public String toString()

Specified by:

toString in class TypeInformation<T>

getInfoFor

@PublicEvolving
public static <X,C> BasicArrayTypeInfo<X,C> getInfoFor(Class<X> type)