OptionTypeInfo (flink 1.2-SNAPSHOT API)

java.lang.Object
- org.apache.flink.api.common.typeinfo.TypeInformation<T>
- - org.apache.flink.api.scala.typeutils.OptionTypeInfo<A,T>

All Implemented Interfaces:: Serializable, AtomicType<T>

public class OptionTypeInfo<A,T extends scala.Option<A>>
extends TypeInformation<T>
implements AtomicType<T>

TypeInformation for Option.

See Also:: Serialized Form

Constructor Summary

Constructors
Constructor and Description

OptionTypeInfo(TypeInformation<A> elemTypeInfo)

Constructors
Constructor and Description
`OptionTypeInfo(TypeInformation<A> elemTypeInfo)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`canEqual(Object obj)` Returns true if the given object can be equaled with this object.
`TypeComparator<T>`	`createComparator(boolean ascending, ExecutionConfig executionConfig)` Creates a comparator for this type.
`TypeSerializer<T>`	`createSerializer(ExecutionConfig executionConfig)` Creates a serializer for the type.
`boolean`	`equals(Object obj)`
`int`	`getArity()` Gets the arity of this type - the number of fields without nesting.
`Map<String,TypeInformation<?>>`	`getGenericParameters()` Optional method for giving Flink's type extraction system information about the mapping of a generic type parameter to the type information of a subtype.
`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
isSortKeyType, of, of

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - OptionTypeInfo
```
public OptionTypeInfo(TypeInformation<A> elemTypeInfo)
```
- Method Detail
  - isBasicType
```
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 extends scala.Option<A>>
    
    Returns:
    
    True, if this type information describes a basic type, false otherwise.
  - isTupleType
```
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 extends scala.Option<A>>
    
    Returns:
    
    True, if this type information describes a tuple type, false otherwise.
  - isKeyType
```
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 extends scala.Option<A>>
    
    Returns:
    
    True, if the type can be used as a key, false otherwise.
  - getTotalFields
```
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 below, the OuterType type has three fields in total.
    
    Specified by:
    
    getTotalFields in class TypeInformation<T extends scala.Option<A>>
    
    Returns:
    
    The number of fields in this type, including its sub-fields (for composite types)
  - getArity
```
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 extends scala.Option<A>>
    
    Returns:
    
    Gets the number of fields in this type without nesting.
  - getTypeClass
```
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 extends scala.Option<A>>
    
    Returns:
    
    The class of the type represented by this type information.
  - getGenericParameters
```
public Map<String,TypeInformation<?>> getGenericParameters()
```
    Description copied from class: TypeInformation
    
    Optional method for giving Flink's type extraction system information about the mapping of a generic type parameter to the type information of a subtype. This information is necessary in cases where type information should be deduced from an input type. For instance, a method for a Tuple2 would look like this: Map m = new HashMap(); m.put("T0", this.getTypeAt(0)); m.put("T1", this.getTypeAt(1)); return m;
    
    Overrides:
    
    getGenericParameters in class TypeInformation<T extends scala.Option<A>>
    
    Returns:
    
    map of inferred subtypes; it does not have to contain all generic parameters as key; values may be null if type could not be inferred
  - createComparator
```
public TypeComparator<T> createComparator(boolean ascending,
                                          ExecutionConfig executionConfig)
```
    Description copied from interface: AtomicType
    
    Creates a comparator for this type.
    
    Specified by:
    
    createComparator in interface AtomicType<T extends scala.Option<A>>
    
    Parameters:
    
    ascending - True, if the comparator should define the order to be ascending, false, if the comparator should define the order to be descending.
    
    executionConfig - The config from which the comparator will be parameterized. Parameterization includes for example registration of class tags for frameworks like Kryo.
    
    Returns:
    
    A comparator for this type.
  - createSerializer
```
public TypeSerializer<T> createSerializer(ExecutionConfig executionConfig)
```
    Description copied from class: TypeInformation
    
    Creates a serializer for the type. The serializer may use the ExecutionConfig for parameterization.
    
    Specified by:
    
    createSerializer in class TypeInformation<T extends scala.Option<A>>
    
    Parameters:
    
    executionConfig - The config used to parameterize the serializer.
    
    Returns:
    
    A serializer for this type.
  - toString
```
public String toString()
```
    Specified by:
    
    toString in class TypeInformation<T extends scala.Option<A>>
  - equals
```
public boolean equals(Object obj)
```
    Specified by:
    
    equals in class TypeInformation<T extends scala.Option<A>>
  - 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 extends scala.Option<A>>
    
    Parameters:
    
    obj - Object which wants to take part in the equality relation
    
    Returns:
    
    true if obj can be equaled with this, otherwise false
  - hashCode
```
public int hashCode()
```
    Specified by:
    
    hashCode in class TypeInformation<T extends scala.Option<A>>

Back to Flink Website

Class OptionTypeInfo<A,T extends scala.Option<A>>

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Constructor Detail

OptionTypeInfo

Method Detail

isBasicType

isTupleType

isKeyType

getTotalFields

getArity

getTypeClass

getGenericParameters

createComparator

createSerializer

toString

equals

canEqual

hashCode

Back to Flink Website