LocalTimeTypeInfo (Flink : 1.17-SNAPSHOT API)

java.lang.Object
- org.apache.flink.api.common.typeinfo.TypeInformation<T>
- - org.apache.flink.api.common.typeinfo.LocalTimeTypeInfo<T>

All Implemented Interfaces:

Serializable, AtomicType<T>

Direct Known Subclasses:

LegacyLocalDateTimeTypeInfo
```
@PublicEvolving
public class LocalTimeTypeInfo<T extends java.time.temporal.Temporal>
extends TypeInformation<T>
implements AtomicType<T>
```
Type information for Java LocalDate/LocalTime/LocalDateTime.

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static LocalTimeTypeInfo<java.time.LocalDate>`	`LOCAL_DATE`
`static LocalTimeTypeInfo<java.time.LocalDateTime>`	`LOCAL_DATE_TIME`
`static LocalTimeTypeInfo<java.time.LocalTime>`	`LOCAL_TIME`

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`LocalTimeTypeInfo(Class<T> clazz, TypeSerializer<T> serializer, Class<? extends TypeComparator<T>> comparatorClass)`

Method Summary

All Methods Static 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 sortOrderAscending, 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.
`static LocalTimeTypeInfo`	`getInfoFor(Class 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
  - LOCAL_DATE
```
public static final LocalTimeTypeInfo<java.time.LocalDate> LOCAL_DATE
```
  - LOCAL_TIME
```
public static final LocalTimeTypeInfo<java.time.LocalTime> LOCAL_TIME
```
  - LOCAL_DATE_TIME
```
public static final LocalTimeTypeInfo<java.time.LocalDateTime> LOCAL_DATE_TIME
```
- Constructor Detail
  - LocalTimeTypeInfo
```
protected LocalTimeTypeInfo(Class<T> clazz,
                            TypeSerializer<T> serializer,
                            Class<? extends TypeComparator<T>> comparatorClass)
```
- 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 java.time.temporal.Temporal>
    
    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 java.time.temporal.Temporal>
    
    Returns:
    
    True, if this type information describes a tuple type, false otherwise.
  - 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 java.time.temporal.Temporal>
    
    Returns:
    
    Gets the number of fields in this type without nesting.
  - 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 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 extends java.time.temporal.Temporal>
    
    Returns:
    
    The number of fields in this type, including its sub-fields (for composite types)
  - 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 java.time.temporal.Temporal>
    
    Returns:
    
    The class of the type represented by this type information.
  - 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 java.time.temporal.Temporal>
    
    Returns:
    
    True, if the type can be used as a key, false otherwise.
  - 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 java.time.temporal.Temporal>
    
    Parameters:
    
    executionConfig - The config used to parameterize the serializer.
    
    Returns:
    
    A serializer for this type.
  - createComparator
```
public TypeComparator<T> createComparator(boolean sortOrderAscending,
                                          ExecutionConfig executionConfig)
```
    Description copied from interface: AtomicType
    
    Creates a comparator for this type.
    
    Specified by:
    
    createComparator in interface AtomicType<T extends java.time.temporal.Temporal>
    
    Parameters:
    
    sortOrderAscending - 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 parametrized. Parametrization includes for example registration of class tags for frameworks like Kryo.
    
    Returns:
    
    A comparator for this type.
  - hashCode
```
public int hashCode()
```
    Specified by:
    
    hashCode in class TypeInformation<T extends java.time.temporal.Temporal>
  - 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 java.time.temporal.Temporal>
    
    Parameters:
    
    obj - Object which wants to take part in the equality relation
    
    Returns:
    
    true if obj can be equaled with this, otherwise false
  - equals
```
public boolean equals(Object obj)
```
    Specified by:
    
    equals in class TypeInformation<T extends java.time.temporal.Temporal>
  - toString
```
public String toString()
```
    Specified by:
    
    toString in class TypeInformation<T extends java.time.temporal.Temporal>
  - getInfoFor
```
public static LocalTimeTypeInfo getInfoFor(Class type)
```

Back to Flink Website

Class LocalTimeTypeInfo<T extends java.time.temporal.Temporal>

Field Summary

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Field Detail

LOCAL_DATE

LOCAL_TIME

LOCAL_DATE_TIME

Constructor Detail

LocalTimeTypeInfo

Method Detail

isBasicType

isTupleType

getArity

getTotalFields

getTypeClass

isKeyType

createSerializer

createComparator

hashCode

canEqual

equals

toString

getInfoFor

Back to Flink Website