livespace.services.entities
Class ClipboardEntity

java.lang.Object
  dsto.dfc.databeans.AbstractDataObject
      dsto.dfc.databeans.SimpleDataObject
          dsto.dfc.databeans.FancyDataObject
              livespace.services.Entity
                  livespace.services.entities.ClipboardEntity

All Implemented Interfaces:

IDataObject, IDataObjectChildListener, Cloneable

public class ClipboardEntity
extends Entity

Author:

Matthew Phillips

Field Summary

static String	ENTITY_TYPE
String	text

Fields inherited from class livespace.services.Entity

container, id, lastTouched, name, unconfirmedUpdates

Fields inherited from class dsto.dfc.databeans.AbstractDataObject

listeners

Fields inherited from interface dsto.dfc.databeans.IDataObject

OVERRIDE, PERSISTENT, PERSISTENT_OVERRIDE, TRANSIENT, TRANSIENT_OVERRIDE

Constructor Summary

ClipboardEntity()

ClipboardEntity(String name)

ClipboardEntity(String id, String name)

Method Summary

static String	defaultClipboardId(RoomEntity room) Get the ID that should be used for the default clipboard in a given room.
String	getType() The type of the object (eg "room", "light", "volume", etc).
static ClipboardEntity	waitForDefault(EntityContainer container) Wait for the default clipboard for a given room to appear in a container.

Methods inherited from class livespace.services.Entity

create, createId, getElvin, getType, getTypeInfo, mutex, sameEntity, shallowClone, waitForProperty, waitForProperty, waitForProperty, waitForProperty

Methods inherited from class dsto.dfc.databeans.FancyDataObject

childPropertyChanged, getValue, isTransient, propertyIterator, setValue

Methods inherited from class dsto.dfc.databeans.SimpleDataObject

getFieldNames, setValue

Methods inherited from class dsto.dfc.databeans.AbstractDataObject

addFirstPropertyListener, addPropertyListener, firePropertyChangedEvent, firePropertyChangedEvent, firePropertyChangedEvent, firePropertyChangedEvent, firePropertyChangedEvent, firePropertyChangedEvent, getBeanValue, getBooleanValue, getBooleanValue, getCharValue, getCharValue, getDoubleValue, getDoubleValue, getFloatValue, getFloatValue, getIntValue, getIntValue, getLongValue, getLongValue, getObjectValue, getPropertyListeners, getShortValue, getStringValue, registerValue, removePropertyListener, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, toString, unregisterValue

Methods inherited from class java.lang.Object

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

Field Detail

ENTITY_TYPE

public static final String ENTITY_TYPE

See Also:

Constant Field Values

text

public String text

Constructor Detail

ClipboardEntity

public ClipboardEntity()

ClipboardEntity

public ClipboardEntity(String name)

ClipboardEntity

public ClipboardEntity(String id,
                       String name)

Method Detail

getType

public String getType()

Description copied from class: Entity

The type of the object (eg "room", "light", "volume", etc). This must be unique to the entity class.

NOTE: it is also a good practice to provide a static field that defines the entity type on the class: eg

 public static final String ENTITY_TYPE = "room";
 

Specified by:

getType in class Entity

waitForDefault

public static ClipboardEntity waitForDefault(EntityContainer container)
                                      throws SynchronizationException

Wait for the default clipboard for a given room to appear in a container.

Parameters:

container - The container.

Returns:

The default clipboard for the room the container is hosted in.

Throws:

SynchronizationException - if the clipboard cannot be found.

defaultClipboardId

public static String defaultClipboardId(RoomEntity room)

Get the ID that should be used for the default clipboard in a given room.