public static final class RT_FieldMap.FieldInfo
extends java.lang.Object
RT_FieldMap
entry which contains information about a
real-time message field.
Instances of this class are returned by the
RT_FieldMap.getFieldInfo(int)
methods. Each instance contains the
field identifier, field name and field type for the queried field.
Modifier and Type | Field and Description |
---|---|
static RT_FieldMap.FieldInfo |
NOT_FOUND
A constant
FieldInfo instance returned by the
RT_FieldMap.getFieldInfo(int) methods when the queried field
information is not present in the field map. |
Modifier and Type | Method and Description |
---|---|
int |
getFid()
Returns the field identifier associated with this
FieldInfo instance. |
java.lang.String |
getName()
Returns the field name associated with this
FieldInfo
instance. |
RT_FieldMap.FieldType |
getType()
Returns the data type associated with this
FieldInfo
instance. |
java.lang.String |
toString()
Returns a brief description of this
RT_FieldMap entry. |
public static final RT_FieldMap.FieldInfo NOT_FOUND
FieldInfo
instance returned by the
RT_FieldMap.getFieldInfo(int)
methods when the queried field
information is not present in the field map.
This constant contains a FID of zero, an empty field name and data
type of FieldType.UNKNOWN
.
public int getFid()
FieldInfo
instance.FieldInfo
public java.lang.String getName()
FieldInfo
instance.FieldInfo
public RT_FieldMap.FieldType getType()
FieldInfo
instance.FieldType
that represents the data type
associated with this FieldInfo
public java.lang.String toString()
RT_FieldMap
entry.toString
in class java.lang.Object
FieldInfo
.