TibrvMsgField

Class

Declaration

class com.tibco.tibrv.TibrvMsgField
  extends java.lang.Object

Purpose

Represent a message field.

Remarks

This class has no destroy() method. Instead, the Java garbage collector reclaims storage automatically.

Field

Description

name

Field name, of type java.lang.String.

Names must be strings; null is a special value that indicates no name.

Field names use the character encoding appropriate to the ISO locale; see Strings and Character Encodings.

id

Field identifier, of type int.

Identifiers must be in the range [0-65535]; zero is a special value that indicates no identifier.

data

Data content of the field, a java.lang.Object.

When storing data in this field, Rendezvous software does not verify that the data and type of the field are consistent. Methods that add the field object into a message verify consistency (for example TibrvMsg.addField() and TibrvMsg.updateField()).

It is illegal to add or update a field with null data.

type

Type designator for the data, a short.

For a list of types, see Datatype Constants. To interpret a type designator as a string, see TibrvMsg.getTypeName().

When storing a type designator in this field, Rendezvous software does not verify that the data and type of the field are consistent. Methods that add the field object into a message verify consistency (for example TibrvMsg.addField() and TibrvMsg.updateField()).

If absent, the default type is TibrvMsg.DEFAULT, which instructs TibrvMsg.addField() and TibrvMsg.updateField() to use the default type corresponding to the data value.

Method

Description

TibrvMsgField()

Create a message field object.

TibrvMsgField.toString()

Format a field as a string.

Inherited Methods

java.lang.Object.equals

java.lang.Object.getClass

java.lang.Object.hashCode

java.lang.Object.notify

java.lang.Object.notifyAll

java.lang.Object.wait

See Also

TibrvMsg.addField()

TibrvMsg.getField()

TibrvMsg.updateField()