|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.ibm.sensorevent.model.generic.GenericGroup
com.ibm.sensorevent.model.Group
com.ibm.sensorevent.model.Payload
public class Payload
Payload represents one of the three main groups within an
IBMSensorEvent
.
Since a Payload is a Group
, Payload may contain attributes and subgroups.
The interface associated with this class is IPayload
.
Field Summary | |
---|---|
static java.lang.String |
COPYRIGHT
|
protected java.lang.String |
payloadClassName
The full class name of this payload instance. |
Fields inherited from class com.ibm.sensorevent.model.generic.GenericGroup |
---|
attributes, groups, name |
Constructor Summary | |
---|---|
protected |
Payload()
Constructs a Payload |
Method Summary | |
---|---|
void |
copyFields(IPayload sourcePayload)
Copies the fields unique to this class (such as payload class name) from the source payload into this payload |
static void |
copyGroup(IGenericGroup sourceGroup,
IGenericGroup targetGroup)
Copies the attributes and subgroups from the source group
into the target group |
static IGenericGroup |
getInstance()
Factory method to create an empty Payload |
static IGenericGroup |
getInstance(IPayload sourcePayload)
Factory method to create an IPayload
from the specified payload |
java.lang.String |
getPayloadClassName()
Returns the payload's class name |
void |
setPayloadClassName(java.lang.String s)
Sets the payload's class name |
java.lang.String |
toString()
Returns a string representation of this payload (for debug purposes) |
Methods inherited from class com.ibm.sensorevent.model.Group |
---|
fromMap, fromTypedMap, getInstance, processGroup, processMap, processTypedGroup, processTypedMap, toMap, toTypedMap |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Methods inherited from interface com.ibm.sensorevent.model.IGroup |
---|
toMap, toTypedMap |
Field Detail |
---|
public static final java.lang.String COPYRIGHT
protected volatile java.lang.String payloadClassName
getPayload
.
Constructor Detail |
---|
protected Payload() throws SensorEventException
SensorEventException
Method Detail |
---|
public static IGenericGroup getInstance() throws SensorEventException
SensorEventException
public static IGenericGroup getInstance(IPayload sourcePayload) throws SensorEventException
IPayload
from the specified payload
sourcePayload
- the payload to copy from
SensorEventException
public static void copyGroup(IGenericGroup sourceGroup, IGenericGroup targetGroup) throws SensorEventException
group
into the target group
sourceGroup
- the source grouptargetGroup
- the target group
SensorEventException
public java.lang.String getPayloadClassName() throws SensorEventException
getPayloadClassName
in interface IPayload
SensorEventException
public void setPayloadClassName(java.lang.String s) throws SensorEventException
setPayloadClassName
in interface IPayload
SensorEventException
public void copyFields(IPayload sourcePayload) throws SensorEventException
copyFields
in interface IPayload
sourcePayload
- the source payload
SensorEventException
public java.lang.String toString()
toString
in class GenericGroup
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |