com.tivoli.twg.evtsub
Class TWGEventSourceDetail

java.lang.Object
  extended bycom.tivoli.twg.evtsub.TWGEventSourceDetail

public class TWGEventSourceDetail
extends java.lang.Object


Field Summary
static int DATA_TYPE_BOOLEAN
           
static int DATA_TYPE_BYTE
           
static int DATA_TYPE_CHAR
           
static int DATA_TYPE_DATETIME
           
static int DATA_TYPE_DOUBLE
           
static int DATA_TYPE_FLOAT
           
static int DATA_TYPE_INT
           
static int DATA_TYPE_LONG
           
static int DATA_TYPE_OCTET
           
static int DATA_TYPE_SHORT
           
static int DATA_TYPE_STRING
           
static int DATA_TYPE_UNICHAR
           
 
Constructor Summary
TWGEventSourceDetail()
           
TWGEventSourceDetail(IntelByteBuffer buf)
          Constructor for interpreting a provided IntelByteBuffer.
TWGEventSourceDetail(IntelByteBuffer buf, int off)
          Constructor for interpreting a provided IntelByteBuffer at a given offset.
TWGEventSourceDetail(java.lang.String id, java.lang.String label, int type)
          Constructor.
TWGEventSourceDetail(TWGEventSourceDetail esd)
          Copy Constructor.
 
Method Summary
 int getDataType()
          Get data type.
 int getFlags()
          Get flags.
 java.lang.String getIdentifier()
          Get identifier.
 java.lang.String getPresentationLabel()
          Get presentation label.
 int readTWGEventSourceDetail(IntelByteBuffer buf, int off)
          Method for interpreting a provided IntelByteBuffer at a given offset.
 int sizeOf()
          Determine the size of the entire object.
 int sizeOfTWGEventSourceDetail()
          Determine the size of the entire object.
 IntelByteBuffer toIntelByteBuffer()
          Convert the object into IntelByteBuffer representation.
 java.lang.String toString()
          Create a string.
 int writeIntelByteBuffer(IntelByteBuffer buf)
          Write contents of this object into an IntelByteBuffer.
 int writeIntelByteBuffer(IntelByteBuffer buf, int off)
          Write object into provided IntelByteBuffer starting at a given offset.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

DATA_TYPE_BYTE

public static final int DATA_TYPE_BYTE
See Also:
Constant Field Values

DATA_TYPE_CHAR

public static final int DATA_TYPE_CHAR
See Also:
Constant Field Values

DATA_TYPE_UNICHAR

public static final int DATA_TYPE_UNICHAR
See Also:
Constant Field Values

DATA_TYPE_SHORT

public static final int DATA_TYPE_SHORT
See Also:
Constant Field Values

DATA_TYPE_INT

public static final int DATA_TYPE_INT
See Also:
Constant Field Values

DATA_TYPE_LONG

public static final int DATA_TYPE_LONG
See Also:
Constant Field Values

DATA_TYPE_BOOLEAN

public static final int DATA_TYPE_BOOLEAN
See Also:
Constant Field Values

DATA_TYPE_FLOAT

public static final int DATA_TYPE_FLOAT
See Also:
Constant Field Values

DATA_TYPE_DOUBLE

public static final int DATA_TYPE_DOUBLE
See Also:
Constant Field Values

DATA_TYPE_OCTET

public static final int DATA_TYPE_OCTET
See Also:
Constant Field Values

DATA_TYPE_STRING

public static final int DATA_TYPE_STRING
See Also:
Constant Field Values

DATA_TYPE_DATETIME

public static final int DATA_TYPE_DATETIME
See Also:
Constant Field Values
Constructor Detail

TWGEventSourceDetail

public TWGEventSourceDetail()

TWGEventSourceDetail

public TWGEventSourceDetail(java.lang.String id,
                            java.lang.String label,
                            int type)
Constructor.

Parameters:
id - unique identifier of the detail
label - presentation label of the detail
type - data type of the detail

TWGEventSourceDetail

public TWGEventSourceDetail(TWGEventSourceDetail esd)
Copy Constructor.

Parameters:
esd - event source detail to be copied

TWGEventSourceDetail

public TWGEventSourceDetail(IntelByteBuffer buf)
Constructor for interpreting a provided IntelByteBuffer. Use the current offset and start ptrs within the provided IntelByteBuffer; upon return the buffer's offset ptr is advanced to reflect the number of bytes read.

Parameters:
buf - IntelByteBuffer from which data should be read

TWGEventSourceDetail

public TWGEventSourceDetail(IntelByteBuffer buf,
                            int off)
Constructor for interpreting a provided IntelByteBuffer at a given offset.

Parameters:
buf - IntelByteBuffer from which data should be read
off - offset from the current relative start of the provided IntelByteBuffer
Method Detail

getIdentifier

public java.lang.String getIdentifier()
Get identifier.

Returns:
identifier

getPresentationLabel

public java.lang.String getPresentationLabel()
Get presentation label.

Returns:
presentation label

getDataType

public int getDataType()
Get data type.

Returns:
data type

getFlags

public int getFlags()
Get flags.

Returns:
flags as an integer

toString

public java.lang.String toString()
Create a string.

Returns:
object as a string

sizeOf

public int sizeOf()
Determine the size of the entire object.

Returns:
number of bytes that comprise the object

sizeOfTWGEventSourceDetail

public int sizeOfTWGEventSourceDetail()
Determine the size of the entire object.

Returns:
number of bytes that comprise the object

toIntelByteBuffer

public IntelByteBuffer toIntelByteBuffer()
Convert the object into IntelByteBuffer representation.

Returns:
IntelByteBuffer representing the encoded object

writeIntelByteBuffer

public int writeIntelByteBuffer(IntelByteBuffer buf)
Write contents of this object into an IntelByteBuffer. Use the current offset and start ptrs within the provided IntelByteBuffer; upon return the buffer's offset ptr is advanced to reflect the number of bytes written.

Parameters:
buf - IntelByteBuffer into which data should be written
Returns:
original offset plus number of bytes written

writeIntelByteBuffer

public int writeIntelByteBuffer(IntelByteBuffer buf,
                                int off)
Write object into provided IntelByteBuffer starting at a given offset. Use the current offset and start ptrs within the provided IntelByteBuffer to determine a relative start ptr and begin writing off bytes from that location. Return the buffer's offset ptr advanced to reflect the number of bytes written.

Parameters:
buf - IntelByteBuffer into which data should be written
off - offset from the current relative start of the provided IntelByteBuffer
Returns:
number of bytes written

readTWGEventSourceDetail

public int readTWGEventSourceDetail(IntelByteBuffer buf,
                                    int off)
Method for interpreting a provided IntelByteBuffer at a given offset.

Parameters:
buf - IntelByteBuffer from which data should be read
off - offset from the current relative start of the provided IntelByteBuffer
Returns:
number of bytes read while interpreting the buffer