de.ipcon.schema

Class AnnotatedValue

java.lang.Object

de.ipcon.schema.AnnotatedValue

public class AnnotatedValue
extends java.lang.Object

This class encapsulates a value retrieved for an attribute or an attribute chain of a BO (Business Object).

The value is typically obtained via methods like SchemaI.getAnnotatedValue(Object, String) or SchemaI.getAnnotatedValueAsString(Object, String). Beyond just holding the raw data, this class can also represent an error that occurred during the retrieval process, providing a unified way to handle both successful data fetching and failures.

Field Summary

Fields

Modifier and Type	Field and Description
static AnnotatedValue	FALSE A constant AnnotatedValueRO representing a boolean false value.
static de.ipcon.schema.AnnotatedValueRO	INVALID_BO A constant AnnotatedValueRO representing an invalid parent object (null or not a BOI).
static de.ipcon.schema.AnnotatedValueRO	INVALID_PATH A constant AnnotatedValueRO representing an invalid (empty) attribute path.
static AnnotatedValue	NONE A constant AnnotatedValueRO representing a non-existent or empty value.
static de.ipcon.schema.AnnotatedValueRO	NOT_YET_KNOWN A constant AnnotatedValueRO indicating that the value is not yet known or resolved.
static AnnotatedValue	TRUE A constant AnnotatedValueRO representing a boolean true value.

Constructor Summary

Constructors

Constructor and Description
AnnotatedValue(java.lang.Object _value, boolean _deleted, java.lang.String _nullOnPath) Constructs a new AnnotatedValue instance.
AnnotatedValue(java.lang.Object _value, boolean _deleted, java.lang.String _nullOnPath, java.lang.Throwable _error)

Method Summary

Modifier and Type	Method and Description
static AnnotatedValue	bool(boolean v) Retrieves a static AnnotatedValueRO instance representing a boolean value.
boolean	equals(java.lang.Object o) Compares this AnnotatedValue to the specified object.
static de.ipcon.schema.AnnotatedValueRO	error(java.lang.Throwable t) Creates a static, read-only AnnotatedValueRO instance representing an error state.
java.lang.Object	get() Retrieves the actual value encapsulated by this AnnotatedValue.
java.lang.Throwable	getError() Retrieves the Throwable associated with this AnnotatedValue, if it represents an error state.
java.lang.String	getNullOnPath()
java.lang.Object	getValue() A read-only version of AnnotatedValue.
boolean	isDeleted()
boolean	isError() Checks if this AnnotatedValue represents an error state.
boolean	isNotYetKnown() Checks if this AnnotatedValue is the special NOT_YET_KNOWN constant.
boolean	isReadOnly() Checks if this AnnotatedValue is read-only.
boolean	isResolveError() Checks if the error associated with this AnnotatedValue is a ResolveException.
AnnotatedValue	set(java.lang.Object _value) Sets the actual value encapsulated by this AnnotatedValue.
void	setDeleted(boolean $2)
void	setNullOnPath(java.lang.String $3)
void	setValue(java.lang.Object $1)
java.lang.String	toString() Returns a string representation of this AnnotatedValue.

Methods inherited from class java.lang.Object

getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

INVALID_BO

public static final de.ipcon.schema.AnnotatedValueRO INVALID_BO

A constant AnnotatedValueRO representing an invalid parent object (null or not a BOI). This indicates a fundamental error in the input BO.

INVALID_PATH

public static final de.ipcon.schema.AnnotatedValueRO INVALID_PATH

A constant AnnotatedValueRO representing an invalid (empty) attribute path. This indicates a fundamental error in the requested attribute path.

NONE

public static final AnnotatedValue NONE

A constant AnnotatedValueRO representing a non-existent or empty value. This is used when a value is legitimately absent, not due to an error.

TRUE

public static final AnnotatedValue TRUE

A constant AnnotatedValueRO representing a boolean true value.

FALSE

public static final AnnotatedValue FALSE

A constant AnnotatedValueRO representing a boolean false value.

NOT_YET_KNOWN

public static final de.ipcon.schema.AnnotatedValueRO NOT_YET_KNOWN

A constant AnnotatedValueRO indicating that the value is not yet known or resolved. This can be used for asynchronous loading or initial states.

Constructor Detail

AnnotatedValue

public AnnotatedValue(java.lang.Object _value,
                      boolean _deleted,
                      java.lang.String _nullOnPath)

Constructs a new AnnotatedValue instance.

Parameters:

_value - The actual value of the attribute or attribute chain.

_deleted - A flag indicating if the BO (or a BO in the chain) was deleted.

_nullOnPath - A string indicating which part of the path was null, if any.

_error - A Throwable representing an error during retrieval, or null if no error occurred.

AnnotatedValue

public AnnotatedValue(java.lang.Object _value,
                      boolean _deleted,
                      java.lang.String _nullOnPath,
                      java.lang.Throwable _error)

Method Detail

bool

public static AnnotatedValue bool(boolean v)

Retrieves a static AnnotatedValueRO instance representing a boolean value.

Parameters:

v - The boolean value.

Returns:

TRUE if v is true, FALSE if v is false.

error

public static de.ipcon.schema.AnnotatedValueRO error(java.lang.Throwable t)

Creates a static, read-only AnnotatedValueRO instance representing an error state.

Parameters:

t - The Throwable representing the error.

Returns:

A new AnnotatedValueRO instance with the error set.

get

public java.lang.Object get()

Retrieves the actual value encapsulated by this AnnotatedValue.

Returns:

The Object value. Returns null if the value is genuinely null or if an error occurred.

set

public AnnotatedValue set(java.lang.Object _value)

Sets the actual value encapsulated by this AnnotatedValue.

Parameters:

_value - The Object value to set.

Returns:

This AnnotatedValue instance, allowing for method chaining.

isReadOnly

public boolean isReadOnly()

Checks if this AnnotatedValue is read-only.

Returns:

true if this AnnotatedValue is read-only, false otherwise.

isError

public boolean isError()

Checks if this AnnotatedValue represents an error state.

Returns:

true if an error (Throwable) is associated with this value, false otherwise.

getError

public java.lang.Throwable getError()

Retrieves the Throwable associated with this AnnotatedValue, if it represents an error state.

Returns:

The Throwable error, or null if no error occurred.

isNotYetKnown

public boolean isNotYetKnown()

Checks if this AnnotatedValue is the special NOT_YET_KNOWN constant.

Returns:

true if this instance is NOT_YET_KNOWN, false otherwise.

isResolveError

public boolean isResolveError()

Checks if the error associated with this AnnotatedValue is a ResolveException.

Returns:

true if isError() is true and the error is an instance of ResolveException, false otherwise.

equals

public boolean equals(java.lang.Object o)

Compares this AnnotatedValue to the specified object. Two AnnotatedValue objects are considered equal if their "deleted" status, "nullOnPath" string (null-safe), and "value" (null-safe) are all equal. The "error" field is not part of the equality check.

Overrides:

equals in class java.lang.Object

Parameters:

o - The Object to compare with.

Returns:

true if the specified object is equal to this AnnotatedValue, false otherwise.

toString

public java.lang.String toString()

Returns a string representation of this AnnotatedValue.

If an error is associated with this value, its string representation is returned. Otherwise, a formatted string showing the "value", "deleted" status, and "nullOnPath" is returned.

Overrides:

toString in class java.lang.Object

Returns:

A String representation of this AnnotatedValue.

getValue

public java.lang.Object getValue()

A read-only version of AnnotatedValue.

Instances of this class behave identically to AnnotatedValue for getters, but all setter methods will throw an IllegalStateException if invoked, ensuring that the object's state cannot be modified after creation.

setValue

public void setValue(java.lang.Object $1)

isDeleted

public boolean isDeleted()

setDeleted

public void setDeleted(boolean $2)

getNullOnPath

public java.lang.String getNullOnPath()

setNullOnPath

public void setNullOnPath(java.lang.String $3)