com.sap.cloud.server.odata

Class Annotation

java.lang.Object

com.sap.cloud.server.odata.Annotation

public class Annotation
extends java.lang.Object

Represents an OData annotation.

See Also:

AnnotationTerm.

Constructor Summary

Constructors

Constructor and Description
Annotation()

Method Summary

Modifier and Type	Method and Description
static boolean	equal(Annotation a, Annotation b) Return true if two annotations have equal key-values.
Annotation	getAnnotation(java.lang.String term) Lookup an existing annotation by term name, or throw an exception if the annotation is not found.
AnnotationMap	getAnnotations() Return map of annotations for this model element.
boolean	getExplicitNull() Return is Annotation.explicitValue an explicit null value?
DataValue	getExplicitValue() Return (nullable) Explicit annotation value.
java.lang.String	getQualifier() Return (nullable) Annotation qualifier.
int	getSourceLine() Return source line number for this schema element within its defining schema.
AnnotationTerm	getTerm() Return annotation term.
DataValue	getValue() Return (nullable) Annotation value.
void	setExplicitNull(boolean value) Set is Annotation.explicitValue an explicit null value?
void	setExplicitValue(DataValue value) Set explicit annotation value.
void	setQualifier(java.lang.String value) Set annotation qualifier.
void	setSourceLine(int value) Set source line number for this schema element within its defining schema.
void	setTerm(AnnotationTerm value) Set annotation term.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Annotation

public Annotation()

Method Detail

equal

public static boolean equal(Annotation a,
                            Annotation b)

Return true if two annotations have equal key-values.

Parameters:

a - (nullable) First annotation.

b - (nullable) Second annotation.

Returns:

true if two annotations have equal key-values.

getAnnotation

public Annotation getAnnotation(java.lang.String term)

Lookup an existing annotation by term name, or throw an exception if the annotation is not found.

See Also:

Annotation.annotations and AnnotationMap.get, for looking up annotations that might not exist.

Parameters:

term - The term name.

Returns:

The annotation.

getAnnotations

public AnnotationMap getAnnotations()

Return map of annotations for this model element. For annotations without qualifiers, the entry key is the annotation term name. For annotations with qualifiers, the entry key is the annotation term name, then "#", then the annotation qualifier.

See Also:

Annotation, AnnotationTerm.

Returns:

Map of annotations for this model element.

getExplicitNull

public boolean getExplicitNull()

Return is Annotation.explicitValue an explicit null value?

Returns:

Is Annotation.explicitValue an explicit null value?

getExplicitValue

public DataValue getExplicitValue()

Return (nullable) Explicit annotation value.

See Also:

Annotation.value.

Returns:

(nullable) Explicit annotation value.

getQualifier

public java.lang.String getQualifier()

Return (nullable) Annotation qualifier.

Returns:

(nullable) Annotation qualifier.

getSourceLine

public int getSourceLine()

Return source line number for this schema element within its defining schema.

Returns:

Source line number for this schema element within its defining schema.

getTerm

public AnnotationTerm getTerm()

Return annotation term.

Returns:

Annotation term.

getValue

public DataValue getValue()

Return (nullable) Annotation value. Will return term.defaultValue if Annotation.explicitValue is null and Annotation.explicitNull is false. Otherwise returns Annotation.explicitValue.

Returns:

(nullable) Annotation value.

setExplicitNull

public void setExplicitNull(boolean value)

Set is Annotation.explicitValue an explicit null value?

Parameters:

value - Is Annotation.explicitValue an explicit null value?

setExplicitValue

public void setExplicitValue(DataValue value)

Set explicit annotation value.

See Also:

Annotation.value.

Parameters:

value - Explicit annotation value.

setQualifier

public void setQualifier(java.lang.String value)

Set annotation qualifier.

Parameters:

value - Annotation qualifier.

setSourceLine

public void setSourceLine(int value)

Set source line number for this schema element within its defining schema.

Parameters:

value - Source line number for this schema element within its defining schema.

setTerm

public void setTerm(AnnotationTerm value)

Set annotation term.

Parameters:

value - Annotation term.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object