com.appiancorp.suiteapi.type

Class TypedValue

java.lang.Object

com.appiancorp.suiteapi.type.TypedValue

All Implemented Interfaces:

com.appiancorp.core.expr.portable.PortableTypedValue, DeepCloneable, JSONable, JSONCacheable, com.appiancorp.type.HasTypeRef, java.io.Serializable, java.lang.Cloneable

Direct Known Subclasses:

NamedTypedValue

@GwtCompatible
public class TypedValue
extends java.lang.Object
implements JSONCacheable, DeepCloneable, com.appiancorp.type.HasTypeRef, java.io.Serializable, com.appiancorp.core.expr.portable.PortableTypedValue

This is a simple bean that represents a type and a value.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static int	ALWAYS
static int	AT_DESIGNER_DISCRETION
protected boolean	clearPasswordOnTransport
static int	NEVER
protected static org.apache.commons.lang.builder.ToStringStyle	TO_STRING_STYLE

Fields inherited from interface com.appiancorp.suiteapi.common.JSONable

hiddenAttributes$TRANSIENT

Fields inherited from interface com.appiancorp.type.HasTypeRef

selectTypeId

Constructor Summary

Constructors

Constructor and Description
TypedValue()
TypedValue(java.lang.Long instanceType) Creates an instance with the given type.
TypedValue(java.lang.Long instanceType, java.lang.Object value_) Creates an instance with the given type and value.
TypedValue(TypedValue tv_) Copy constructor.

Method Summary

Modifier and Type	Method and Description
boolean	clearPasswordOnTransport() Deprecated. This is an internal method that will be removed from the public API.
java.lang.Object	clone() Clone this object.
boolean	equals(java.lang.Object o) Compares the specified object with this typedValue for equality.
java.util.HashSet	getHiddenAttributes() Returns the set of attributes (properties) that should not be included in the JSON representation of the object.
java.lang.Long	getInstanceType() Retrieves the type id, which corresponds to a Datatype.
static java.lang.Long[]	getInstanceTypeIds(TypedValue[] tvs_) Get the instance type ids (as a Long array) from an array of typed values.
com.appiancorp.type.TypeRef	getTypeRef()
java.lang.Object	getValue() Retrieves the value of this variable.
int	hashCode()
void	setInstanceType(java.lang.Long instanceType) Sets the instance type of the typed value.
void	setTypeRef(com.appiancorp.type.TypeRef typeRef)
void	setValue(java.lang.Object value) Sets the value of the typed variable.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

NEVER

public static final int NEVER

See Also:

Constant Field Values

ALWAYS

public static final int ALWAYS

See Also:

Constant Field Values

AT_DESIGNER_DISCRETION

public static final int AT_DESIGNER_DISCRETION

See Also:

Constant Field Values

clearPasswordOnTransport

protected transient boolean clearPasswordOnTransport

TO_STRING_STYLE

protected static final org.apache.commons.lang.builder.ToStringStyle TO_STRING_STYLE

Constructor Detail

TypedValue

public TypedValue()

TypedValue

public TypedValue(TypedValue tv_)

Copy constructor. Creates a new TypedValue with the data of the given TypedValue. A deep copy of the value is performed.

TypedValue

public TypedValue(java.lang.Long instanceType)

Creates an instance with the given type.

Parameters:

instanceType - the type id

TypedValue

public TypedValue(java.lang.Long instanceType,
                  java.lang.Object value_)

Creates an instance with the given type and value.

Parameters:

instanceType - the type id

value_ - the value

Method Detail

getHiddenAttributes

public java.util.HashSet getHiddenAttributes()

Description copied from interface: JSONable

Returns the set of attributes (properties) that should not be included in the JSON representation of the object.

Specified by:

getHiddenAttributes in interface JSONable

Returns:

the set of hidden attributes

clone

public java.lang.Object clone()

Clone this object.

Specified by:

clone in interface DeepCloneable

Overrides:

clone in class java.lang.Object

Returns:

equals

public boolean equals(java.lang.Object o)

Compares the specified object with this typedValue for equality. Returns true if and only if the specified object is also a typedValue, both typedValues have the same type, and the same value.

Overrides:

equals in class java.lang.Object

Parameters:

o - the object to be compared for equality with this typeValue

Returns:

true if the specified object is equal to this typeValue

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

getInstanceType

public final java.lang.Long getInstanceType()

Retrieves the type id, which corresponds to a Datatype. Built-in datatype ids are defined in AppianType

Specified by:

getInstanceType in interface com.appiancorp.core.expr.portable.PortableTypedValue

Returns:

the type id

setInstanceType

public void setInstanceType(java.lang.Long instanceType)

Sets the instance type of the typed value.

Parameters:

instanceType - The instance type id, which corresponds to a Datatype. Built-in datatype ids are defined in AppianType

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getValue

public java.lang.Object getValue()

Retrieves the value of this variable.

Specified by:

getValue in interface com.appiancorp.core.expr.portable.PortableTypedValue

Returns:

The value of the typed variable.

setValue

public void setValue(java.lang.Object value)

Sets the value of the typed variable.

Parameters:

value - The value to set the typed variable to.

getInstanceTypeIds

public static java.lang.Long[] getInstanceTypeIds(TypedValue[] tvs_)

Get the instance type ids (as a Long array) from an array of typed values.

Parameters:

tvs_ - an array of typed values

Returns:

an array of the same size as the given array, containing the instance type ids of the given typed values

clearPasswordOnTransport

@Deprecated
public boolean clearPasswordOnTransport()

Deprecated. This is an internal method that will be removed from the public API.

Should this clear passswords on transport? Transient property. Works as a flag to avoid including passwords in transport.

Returns:

getTypeRef

@Transient
public final com.appiancorp.type.TypeRef getTypeRef()

Specified by:

getTypeRef in interface com.appiancorp.type.HasTypeRef

setTypeRef

public final void setTypeRef(com.appiancorp.type.TypeRef typeRef)

Specified by:

setTypeRef in interface com.appiancorp.type.HasTypeRef