Package de.aristaflow.adept2.model.datamanagement

Interface PlaceholderValue

All Superinterfaces:

Serializable

All Known Implementing Classes:

PlaceholderValue.AbstractPlaceholderValue, PlaceholderValue.PlaceholderCharSequence, PlaceholderValue.PlaceholderUdtValue

public interface PlaceholderValue
extends Serializable

This interface represents placeholder for data values. For instance, if a value exceeds a size limit, it may be replaced by such a placeholder and the actual value can be retrieved on demand. The logic needs to be an interface to support proxies wrapping values, for instance de.aristaflow.adept2.model.common.defaultimplementation#CloseIgnoringWrapper.
Only the predefined singleton instances of the placeholders must be used. Each one has a corresponding data type. When comparing use #equals(Object) on the corresponding singleton instance, for instance UDT_VALUE_PLACEHOLDER.equals(...)! Do not compare with == since this does not work with proxies!

This interface must not be extended and not be implemented outside of this file!

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	PlaceholderValue.AbstractPlaceholderValue	Abstract class providing the basic methods for a PlaceholderValue, for instance PlaceholderValue.AbstractPlaceholderValue.equals(Object) and PlaceholderValue.AbstractPlaceholderValue.hashCode().
static final class	PlaceholderValue.PlaceholderCharSequence	This class implements the PlaceholderValue for a value of ProcessConstants.AdeptDataType.STRING.
static final class	PlaceholderValue.PlaceholderUdtValue	This class implements the PlaceholderValue for a value of ProcessConstants.AdeptDataType.USERDEFINED type.

Field Summary

Fields

Modifier and Type	Field	Description
static final Serializable	STRING_VALUE_PLACEHOLDER	A placeholder for a ProcessConstants.AdeptDataType.STRING value to be requested on demand.
static final String	UDT_NAME	The user-defined type name used for a placeholder UDTValue.
static final UDTValue	UDT_VALUE_PLACEHOLDER	The singleton representing an UDTValue that is not transferred since it is too big.

Method Summary

Modifier and Type	Method	Description
ProcessConstants.AdeptDataType	getDataType()	Gets the data type this instance is a placeholder value for.

Field Details

STRING_VALUE_PLACEHOLDER

static final Serializable STRING_VALUE_PLACEHOLDER

A placeholder for a ProcessConstants.AdeptDataType.STRING value to be requested on demand.

UDT_NAME

static final String UDT_NAME

The user-defined type name used for a placeholder UDTValue.

See Also:

• Constant Field Values

UDT_VALUE_PLACEHOLDER

static final UDTValue UDT_VALUE_PLACEHOLDER

The singleton representing an UDTValue that is not transferred since it is too big. The actual value has to be retrieved lazily from the server.

Method Details

getDataType

ProcessConstants.AdeptDataType getDataType()

Gets the data type this instance is a placeholder value for. This method is used for #equals(Object) since methods can be called on proxies.

Returns:

The data type this instance is a placeholder value for.