DataTypeImpl.Definition (Helenus Implementation 1.0.14 API)

java.lang.Object
- org.helenus.driver.impl.DataTypeImpl.Definition

All Implemented Interfaces:

CQLDataType

Enclosing class:

DataTypeImpl
```
public static class DataTypeImpl.Definition
extends Object
implements CQLDataType
```
The Definition class provides a data type definition for a CQL data type.

Since:

1.0

Version:

1 - Jan 19, 2015 - paouelle - Creation

Author:

The Helenus Driver Project Authors

Copyright:

2015-2015 The Helenus Driver Project Authors

Constructor Summary

Constructors
Constructor and Description
`Definition(DataType type, DataType... arguments)` Instantiates a new `Definition` object.
`Definition(DataType type, List<CQLDataType> arguments)` Instantiates a new `Definition` object.
`Definition(List<CQLDataType> types)` Instantiates a new `Definition` object.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`<T,PT> Object`	`decode(Object val, Persisted persisted, Persister<T,PT> persister, String fname)` Decodes the specified value using the given persister based on this definition.
`<T,PT> Object`	`encode(Object val, Persisted persisted, Persister<T,PT> persister, String fname)` Encodes the specified value using the given persister based on this definition.
`<T,PT> Object`	`encodeElement(Object val, Persisted persisted, Persister<T,PT> persister, String fname)` Encodes the specified element value using the given persister based on this definition.
`List<CQLDataType>`	`getArgumentTypes()`
`DataDecoder<?>`	`getDecoder(Class<?> clazz)` Gets a decoder for this data type to decode to the specified class.
`DataDecoder<?>`	`getDecoder(Field field, boolean mandatory)` Gets a decoder for this data type to decode to the specified field.
`CQLDataType`	`getElementType()`
`CQLDataType`	`getFirstArgumentType()`
`CQLDataType`	`getMainType()`
`boolean`	`isAlterableTo(CQLDataType to)`
`boolean`	`isCollection()`
`boolean`	`isUserDefined()`
`String`	`name()`
`String`	`toCQL()`
`String`	`toString()`
`java.util.stream.Stream<UDTClassInfoImpl<?>>`	`udts()` Gets all user-defined types this definition is dependent on.

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

- Constructor Detail
  - Definition
```
public Definition(DataType type,
                  DataType... arguments)
```
    Instantiates a new Definition object.
    
    Parameters:
    
    type - the non-null data type for this definition
    
    arguments - the non-null list of arguments' data types if the type represents a collection (may be empty)
  - Definition
```
public Definition(DataType type,
                  List<CQLDataType> arguments)
```
    Instantiates a new Definition object.
    
    Parameters:
    
    type - the non-null data type for this definition
    
    arguments - the non-null list of arguments' data types if the type represents a collection (may be empty)
  - Definition
```
public Definition(List<CQLDataType> types)
```
    Instantiates a new Definition object.
    
    Parameters:
    
    types - the non-null list of data types for this definition (the first one correspond to the data type and the remaining are the argument data types)
- Method Detail
  - name
```
public String name()
```
    Specified by:
    
    name in interface CQLDataType
    
    See Also:
    
    CQLDataType.name()
  - isCollection
```
public boolean isCollection()
```
    Specified by:
    
    isCollection in interface CQLDataType
    
    See Also:
    
    CQLDataType.isCollection()
  - isUserDefined
```
public boolean isUserDefined()
```
    Specified by:
    
    isUserDefined in interface CQLDataType
    
    See Also:
    
    CQLDataType.isUserDefined()
  - getMainType
```
public CQLDataType getMainType()
```
    Specified by:
    
    getMainType in interface CQLDataType
    
    See Also:
    
    CQLDataType.getMainType()
  - getElementType
```
public CQLDataType getElementType()
```
    Specified by:
    
    getElementType in interface CQLDataType
    
    See Also:
    
    CQLDataType.getElementType()
  - getArgumentTypes
```
public List<CQLDataType> getArgumentTypes()
```
    Specified by:
    
    getArgumentTypes in interface CQLDataType
    
    See Also:
    
    CQLDataType.getArgumentTypes()
  - getFirstArgumentType
```
public CQLDataType getFirstArgumentType()
```
    Specified by:
    
    getFirstArgumentType in interface CQLDataType
    
    See Also:
    
    CQLDataType.getFirstArgumentType()
  - isAlterableTo
```
public boolean isAlterableTo(CQLDataType to)
```
    Specified by:
    
    isAlterableTo in interface CQLDataType
    
    See Also:
    
    CQLDataType.isAlterableTo(org.helenus.driver.persistence.CQLDataType)
  - getDecoder
```
public DataDecoder<?> getDecoder(Field field,
                                 boolean mandatory)
```
    Gets a decoder for this data type to decode to the specified field.
    
    Parameters:
    
    field - the field to decode to its declared type
    
    mandatory - if the field is mandatory or represents a primary key
    
    Returns:
    
    a decoder suitable to decode from this data type to the given field
    
    Throws:
    
    NullPointerException - if field is null
    
    IllegalArgumentException - if the combination of field and data types is not supported
  - getDecoder
```
public DataDecoder<?> getDecoder(Class<?> clazz)
```
    Gets a decoder for this data type to decode to the specified class.
    
    Parameters:
    
    clazz - the collection class to decode to its declared super type
    
    Returns:
    
    a decoder suitable to decode from this data type to the given class
    
    Throws:
    
    NullPointerException - if clazz is null
    
    IllegalArgumentException - if the combination of class and data types is not supported
    
    IllegalStateException - if this definition is not representing a collection
  - encode
```
public <T,PT> Object encode(Object val,
                            Persisted persisted,
                            Persister<T,PT> persister,
                            String fname)
                     throws IOException
```
    Encodes the specified value using the given persister based on this definition.
    
    Type Parameters:
    
    T - the decoded type
    
    PT - the persisted type
    
    Parameters:
    
    val - the value to be encoded
    
    persisted - the persisted annotation for the persister
    
    persister - the persister to use
    
    fname - the non-null field name
    
    Returns:
    
    the corresponding decoded value or null if the value was null to start with or no encoding was required
    
    Throws:
    
    IOException - if an encoding error occurs
    
    ClassCastException - if this definition represents a collection and the value cannot be type casted to the expected collection type or the encoded value cannot be type casted to the persisted class
  - encodeElement
```
public <T,PT> Object encodeElement(Object val,
                                   Persisted persisted,
                                   Persister<T,PT> persister,
                                   String fname)
                            throws IOException
```
    Encodes the specified element value using the given persister based on this definition.
    
    Type Parameters:
    
    T - the decoded type
    
    PT - the persisted type
    
    Parameters:
    
    val - the element value to be encoded
    
    persisted - the persisted annotation for the persister
    
    persister - the persister to use
    
    fname - the non-null field name
    
    Returns:
    
    the corresponding decoded value or null if the value was null to start with or no encoding was required
    
    Throws:
    
    IOException - if an encoding error occurs
  - decode
```
public <T,PT> Object decode(Object val,
                            Persisted persisted,
                            Persister<T,PT> persister,
                            String fname)
                     throws IOException
```
    Decodes the specified value using the given persister based on this definition.
    
    Type Parameters:
    
    T - the decoded type
    
    PT - the persisted type
    
    Parameters:
    
    val - the value to be encoded
    
    persisted - the persisted annotation for the persister
    
    persister - the persister to use
    
    fname - the non-null field name
    
    Returns:
    
    the corresponding decoded value or null if the value was null to start with or no decoding was required
    
    Throws:
    
    IOException - if an encoding error occurs
    
    ClassCastException - if this definition represents a collection and the value cannot be type casted to the expected collection type or again the value to decode cannot be type casted to the persisted class
  - toCQL
```
public String toCQL()
```
    Specified by:
    
    toCQL in interface CQLDataType
    
    See Also:
    
    CQLDataType.toCQL()
  - udts
```
public java.util.stream.Stream<UDTClassInfoImpl<?>> udts()
```
    Gets all user-defined types this definition is dependent on.
    
    Returns:
    
    a stream of all class infos for the user-defined types this definition depends on
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
    
    See Also:
    
    Object.toString()

Class DataTypeImpl.Definition

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Definition

Definition

Definition

Method Detail

name

isCollection

isUserDefined

getMainType

getElementType

getArgumentTypes

getFirstArgumentType

isAlterableTo

getDecoder

getDecoder

encode

encodeElement

decode

toCQL

udts

toString