org.apache.olingo.server.tecsvc.processor.queryoptions.expression.primitive

Class EdmNull

java.lang.Object

org.apache.olingo.server.tecsvc.processor.queryoptions.expression.primitive.EdmNull

All Implemented Interfaces:

EdmNamed, EdmPrimitiveType, EdmType

public final class EdmNull
extends Object
implements EdmPrimitiveType

Field Summary

Fields inherited from interface org.apache.olingo.commons.api.edm.EdmPrimitiveType

EDM_NAMESPACE, SYSTEM_NAMESPACE

Constructor Summary

Constructors

Constructor and Description
EdmNull()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	fromUriLiteral(String literal) Converts URI literal representation to default literal representation.
Class<?>	getDefaultType() Returns the default Java type for this EDM primitive type as described in the documentation of EdmPrimitiveType.
FullQualifiedName	getFullQualifiedName()
static EdmNull	getInstance()
EdmTypeKind	getKind()
String	getName()
String	getNamespace() Namespace of this EdmType.
int	hashCode()
boolean	isCompatible(EdmPrimitiveType primitiveType) Checks type compatibility.
String	toString()
String	toUriLiteral(String literal) Converts default literal representation to URI literal representation.
boolean	validate(String value, Boolean isNullable, Integer maxLength, Integer precision, Integer scale, Boolean isUnicode) Validates literal value.
<T> T	valueOfString(String value, Boolean isNullable, Integer maxLength, Integer precision, Integer scale, Boolean isUnicode, Class<T> returnType) Converts literal representation of value to system data type.
String	valueToString(Object value, Boolean isNullable, Integer maxLength, Integer precision, Integer scale, Boolean isUnicode) Converts system data type to literal representation of value.

Methods inherited from class java.lang.Object

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

Constructor Detail

EdmNull

public EdmNull()

Method Detail

getInstance

public static EdmNull getInstance()

getNamespace

public String getNamespace()

Description copied from interface: EdmType

Namespace of this EdmType.

Specified by:

getNamespace in interface EdmType

Returns:

namespace as String

getName

public String getName()

Specified by:

getName in interface EdmNamed

Returns:

name as String

getKind

public EdmTypeKind getKind()

Specified by:

getKind in interface EdmType

Returns:

EdmTypeKind of this EdmType

getDefaultType

public Class<?> getDefaultType()

Description copied from interface: EdmPrimitiveType

Returns the default Java type for this EDM primitive type as described in the documentation of EdmPrimitiveType.

Specified by:

getDefaultType in interface EdmPrimitiveType

Returns:

the default Java type

getFullQualifiedName

public FullQualifiedName getFullQualifiedName()

Specified by:

getFullQualifiedName in interface EdmType

Returns:

full qualified name

isCompatible

public boolean isCompatible(EdmPrimitiveType primitiveType)

Description copied from interface: EdmPrimitiveType

Checks type compatibility.

Specified by:

isCompatible in interface EdmPrimitiveType

Parameters:

primitiveType - the EdmPrimitiveType to be tested for compatibility

Returns:

true if the provided type is compatible to this type

validate

public boolean validate(String value,
               Boolean isNullable,
               Integer maxLength,
               Integer precision,
               Integer scale,
               Boolean isUnicode)

Description copied from interface: EdmPrimitiveType

Validates literal value.

Specified by:

validate in interface EdmPrimitiveType

Parameters:

value - the literal value

isNullable - whether the null value is allowed

maxLength - the maximum length

precision - the precision

scale - the scale

isUnicode - whether non-ASCII characters are allowed (relevant only for Edm.String)

Returns:

true if the validation is successful

valueOfString

public final <T> T valueOfString(String value,
                  Boolean isNullable,
                  Integer maxLength,
                  Integer precision,
                  Integer scale,
                  Boolean isUnicode,
                  Class<T> returnType)
                      throws EdmPrimitiveTypeException

Description copied from interface: EdmPrimitiveType

Converts literal representation of value to system data type.

Specified by:

valueOfString in interface EdmPrimitiveType

Parameters:

value - the literal representation of value

isNullable - whether the null value is allowed

maxLength - the maximum length

precision - the precision

scale - the scale

isUnicode - whether non-ASCII characters are allowed (relevant only for Edm.String)

returnType - the class of the returned value; it must be one of the list in the documentation of EdmPrimitiveType

Returns:

the value as an instance of the class the parameter returnType indicates

Throws:

EdmPrimitiveTypeException

valueToString

public final String valueToString(Object value,
                   Boolean isNullable,
                   Integer maxLength,
                   Integer precision,
                   Integer scale,
                   Boolean isUnicode)
                           throws EdmPrimitiveTypeException

Description copied from interface: EdmPrimitiveType

Converts system data type to literal representation of value.

Returns null if value is null and null is an allowed value.

Specified by:

valueToString in interface EdmPrimitiveType

Parameters:

value - the Java value as Object; its type must be one of the list in the documentation of EdmPrimitiveType

isNullable - whether the null value is allowed

maxLength - the maximum length

precision - the precision

scale - the scale

isUnicode - whether non-ASCII characters are allowed (relevant only for Edm.String)

Returns:

literal representation as String

Throws:

EdmPrimitiveTypeException

toUriLiteral

public String toUriLiteral(String literal)

Description copied from interface: EdmPrimitiveType

Converts default literal representation to URI literal representation.

Returns null if the literal is null. Does not perform any validation.

Specified by:

toUriLiteral in interface EdmPrimitiveType

Parameters:

literal - the literal in default representation

Returns:

URI literal representation as String

fromUriLiteral

public String fromUriLiteral(String literal)
                      throws EdmPrimitiveTypeException

Description copied from interface: EdmPrimitiveType

Converts URI literal representation to default literal representation.

Returns null if the literal is null. Checks the presence of a required prefix and of required surrounding quotation marks but does not perform any further validation.

Specified by:

fromUriLiteral in interface EdmPrimitiveType

Parameters:

literal - the literal in URI representation

Returns:

default literal representation as String

Throws:

EdmPrimitiveTypeException - if a required prefix or required surrounding quotation marks are missing

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object