Package ch.hevs.cloudio.endpoint

Class CloudioAdLibObject

java.lang.Object

ch.hevs.cloudio.endpoint.CloudioObject

ch.hevs.cloudio.endpoint.CloudioAdLibObject

public class CloudioAdLibObject
extends CloudioObject

The CloudioAdLibObject class allows you to create the structure of a cloud.iO node at runtime in contrast to the static model used by the CloudioObject class. TODO: Example.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CloudioAdLibObject.Builder	Builder to enable convenient custom object creation.

Constructor Summary

Constructors

Constructor	Description
CloudioAdLibObject()

Method Summary

Modifier and Type	Method	Description
<T> CloudioAttribute<T>	addAttribute(java.lang.String name, java.lang.Class<T> type, CloudioAttributeConstraint constraint)	Adds a new attribute of the given type (class) and the given name to the object.
<T> CloudioAttribute<T>	addAttribute(java.lang.String name, java.lang.Class<T> type, CloudioAttributeConstraint constraint, T initialValue)	Adds a new attribute of the given type (class) and the given name to the object.
void	addObject(java.lang.String name, CloudioObject object)	Adds the given object to this custom object under the given name.
<T extends CloudioObject> T	addObject(java.lang.String name, java.lang.Class<T> clazz)	Adds an object of the given class with the given name to the custom object.
void	declareConformance(java.lang.String dataClass)	Declares conformance of the object for a given data class.
CloudioAttribute	getAttribute(java.lang.String name)	Returns the attribute with the given name or null if no attribute with the given name is part of the object.
CloudioObject	getObject(java.lang.String name)	Returns the object with the given name or null if no object with the given name is part of the object.

Methods inherited from class java.lang.Object

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

Constructor Detail

CloudioAdLibObject

public CloudioAdLibObject()

Method Detail

getObject

public CloudioObject getObject(java.lang.String name)

Returns the object with the given name or null if no object with the given name is part of the object.

Parameters:

name - Name of the object to return.

Returns:

The object with the given name or null if the object does not exists.

addObject

public <T extends CloudioObject> T addObject(java.lang.String name,
                                             java.lang.Class<T> clazz)
                                      throws DuplicateNamedItemException,
                                             InvalidCloudioObjectException

Adds an object of the given class with the given name to the custom object.

Type Parameters:

T - Type of the object.

Parameters:

name - Name to give to the object after creation.

clazz - The class of the object to create and add.

Returns:

The object just created and added.

Throws:

DuplicateNamedItemException - If there already exists an object with the given name.

InvalidCloudioObjectException - The object class is invalid.

addObject

public void addObject(java.lang.String name,
                      CloudioObject object)
               throws DuplicateNamedItemException

Adds the given object to this custom object under the given name.

Parameters:

name - Name to give to the object inside the node.

object - The object to add.

Throws:

DuplicateNamedItemException - If there already exists an object with the given name.

getAttribute

public CloudioAttribute getAttribute(java.lang.String name)

Returns the attribute with the given name or null if no attribute with the given name is part of the object.

Parameters:

name - Name of the attribute to return.

Returns:

The attribute with the given name or null if the attribute does not exists.

addAttribute

public <T> CloudioAttribute<T> addAttribute(java.lang.String name,
                                            java.lang.Class<T> type,
                                            CloudioAttributeConstraint constraint)
                                     throws DuplicateNamedItemException,
                                            InvalidCloudioAttributeException

Adds a new attribute of the given type (class) and the given name to the object. Note that if there is already an attribute with the given name present or the type of the attribute is invalid, an exception will be thrown.

Type Parameters:

T - Attribute's type.

Parameters:

name - Name of the attribute to add.

type - Type of the attribute to add.

constraint - Attribute's constraint.

Returns:

Reference to the newly instantiated attribute.

Throws:

DuplicateNamedItemException - If there already exists an attribute with the given name.

InvalidCloudioAttributeException - If the type of the attribute is not supported.

addAttribute

public <T> CloudioAttribute<T> addAttribute(java.lang.String name,
                                            java.lang.Class<T> type,
                                            CloudioAttributeConstraint constraint,
                                            T initialValue)
                                     throws DuplicateNamedItemException,
                                            InvalidCloudioAttributeException,
                                            CloudioAttributeInitializationException,
                                            CloudioAttributeConstraintException

Adds a new attribute of the given type (class) and the given name to the object. Note that if there is already an attribute with the given name present or the type of the attribute is invalid, an exception will be thrown.

Type Parameters:

T - Attribute's type.

Parameters:

name - Name of the attribute to add.

type - Type of the attribute to add.

constraint - Attribute's constraint.

initialValue - Initial value for the attribute.

Returns:

Reference to the newly instantiated attribute.

Throws:

DuplicateNamedItemException - If there already exists an attribute with the given name.

InvalidCloudioAttributeException - If the type of the attribute is not supported.

CloudioAttributeInitializationException - If the attribute could not be initialized.

CloudioAttributeConstraintException - If the attribute can not be initialized (constraint).

declareConformance

public void declareConformance(java.lang.String dataClass)

Declares conformance of the object for a given data class. Note that a cloud.io objects can only declare conformance for exactly one data class, it you try to declare a second conformance , a runtime exception will be thrown. Additionally this method can only be called before the object is part of an endpoint structure.

Parameters:

dataClass - Data class the object conforms to.