com.appiancorp.ps.plugins.typetransformer

Class AppianObject

java.lang.Object

java.util.AbstractMap<K,V>

java.util.HashMap<K,V>

java.util.LinkedHashMap<String,AppianElement>

com.appiancorp.ps.plugins.typetransformer.AppianObject

All Implemented Interfaces:

AppianElement, Serializable, Cloneable, Map<String,AppianElement>

Direct Known Subclasses:

AppianComplex

public class AppianObject
extends LinkedHashMap<String,AppianElement>
implements AppianElement

Represents types with key and value mappings (aka dictionary and CDT). Implements the Map interface.

Author:

james.carter

See Also:

AppianTypeFactory, AppianList, AppianComplex, AppianPrimitive, Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Method Summary

Modifier and Type	Method and Description
AppianList	getList(String property) Returns the element with the specified property name in this map as an AppianList.
<T> List<T>	getList(String property, Class<T> clazz) Returns the value of the primitive as the given type
AppianObject	getObject(String property) Returns the element with the specified property name in this map as an AppianObject.
AppianPrimitive	getPrimitive(String property) Returns the element with the specified property name in this map as an AppianPrimitive.
long	getTypeId() Returns the AppianType Id of this element.
<T> T	getValue(String property, Class<T> clazz) Returns the value of the primitive as the given type

Methods inherited from class java.util.LinkedHashMap

clear, containsValue, entrySet, forEach, get, getOrDefault, keySet, removeEldestEntry, replaceAll, values

Methods inherited from class java.util.HashMap

clone, compute, computeIfAbsent, computeIfPresent, containsKey, isEmpty, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, size

Methods inherited from class java.util.AbstractMap

equals, hashCode, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, containsKey, equals, hashCode, isEmpty, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, size

Method Detail

getList

public AppianList getList(String property)

Returns the element with the specified property name in this map as an AppianList.

Parameters:

property - the property name of the element in this map to return

Returns:

Returns the element with the specified property name in this map as an AppianList.

Throws:

ClassCastException - if the specified element is not an AppianList

See Also:

getList(String, Class), LinkedHashMap.get(Object)

getList

public <T> List<T> getList(String property,
                           Class<T> clazz)

Returns the value of the primitive as the given type

Parameters:

property - the property name of the element in this map to return

clazz - The type to cast each value in the list to

Throws:

ClassCastException - if any value of the list at the requested position cannot be cast to the requested type

See Also:

LinkedHashMap.get(Object)

getObject

public AppianObject getObject(String property)

Returns the element with the specified property name in this map as an AppianObject.

Parameters:

property - the property name of the element in this map to return

Returns:

Returns the element with the specified property name in this map as an AppianObject.

Throws:

ClassCastException - if the specified element is not an AppianObject

See Also:

LinkedHashMap.get(Object)

getPrimitive

public AppianPrimitive getPrimitive(String property)

Returns the element with the specified property name in this map as an AppianPrimitive.

Parameters:

property - the property name of the element in this map to return

Returns:

Returns the element with the specified property name in this map as an AppianPrimitive.

Throws:

ClassCastException - if the specified element is not an AppianPrimitive

See Also:

getValue(String, Class), LinkedHashMap.get(Object)

getValue

public <T> T getValue(String property,
                      Class<T> clazz)

Returns the value of the primitive as the given type

Parameters:

property - the property name of the element in this map to return

clazz - The type to cast the value to

Returns:

Returns the value of the primitive cast to the class type

Throws:

ClassCastException - if the value of the primitive at the requested position cannot be cast to the requested type

See Also:

LinkedHashMap.get(Object)

getTypeId

public long getTypeId()

Returns the AppianType Id of this element.

Specified by:

getTypeId in interface AppianElement

Returns:

the AppianType Id of this element.