Package com.wombat.mama
Class MamaFieldDescriptor
- java.lang.Object
-
- com.wombat.mama.MamaFieldDescriptor
-
public class MamaFieldDescriptor extends java.lang.Object
TheMamaFieldDescriptor
class represents a field in aMamaMsg
- See Also:
MamaDictionary
,MamaMsg
-
-
Field Summary
Fields Modifier and Type Field Description static short
BOOL
static short
CHAR
static short
COLLECTION
static short
DATETIME
static short
F32
static short
F32ARRAY
static short
F64
static short
F64ARRAY
static short
I16
static short
I16ARRAY
static short
I32
static short
I32ARRAY
static short
I64
static short
I64ARRAY
static short
I8
static short
I8ARRAY
static short
MSG
static short
OPAQUE
static short
PRICE
static short
QUANTITY
static short
STRING
static short
TIME
static short
U16
static short
U16ARRAY
static short
U32
static short
U32ARRAY
static short
U64
static short
U64ARRAY
static short
U8
static short
U8ARRAY
static short
UNKNOWN
static short
VECTOR
static short
VECTOR_MSG
static short
VECTOR_PRICE
static short
VECTOR_STRING
static short
VECTOR_TIME
-
Constructor Summary
Constructors Constructor Description MamaFieldDescriptor(int fid, short type, java.lang.String name, java.lang.Object data)
Create aMamaFieldDescriptor
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.Object
getClosure()
Return the user specified data associated with the field descriptor.int
getFid()
Return the field identifier.java.lang.String
getName()
Return the human readable name of the field.boolean
getTrackModState()
short
getType()
Return the data type.static java.lang.String
getTypeName(short type)
void
setClosure(java.lang.Object closure)
Set user specified data to associate with the field descriptor.void
setTrackModState(boolean on)
java.lang.String
toString()
Returns a string suitable for output to a terminal containing the type, id, and name.
-
-
-
Field Detail
-
MSG
public static final short MSG
- See Also:
- Constant Field Values
-
DATETIME
public static final short DATETIME
- See Also:
- Constant Field Values
-
OPAQUE
public static final short OPAQUE
- See Also:
- Constant Field Values
-
STRING
public static final short STRING
- See Also:
- Constant Field Values
-
BOOL
public static final short BOOL
- See Also:
- Constant Field Values
-
CHAR
public static final short CHAR
- See Also:
- Constant Field Values
-
I8
public static final short I8
- See Also:
- Constant Field Values
-
U8
public static final short U8
- See Also:
- Constant Field Values
-
I16
public static final short I16
- See Also:
- Constant Field Values
-
U16
public static final short U16
- See Also:
- Constant Field Values
-
I32
public static final short I32
- See Also:
- Constant Field Values
-
U32
public static final short U32
- See Also:
- Constant Field Values
-
I64
public static final short I64
- See Also:
- Constant Field Values
-
U64
public static final short U64
- See Also:
- Constant Field Values
-
F32
public static final short F32
- See Also:
- Constant Field Values
-
F64
public static final short F64
- See Also:
- Constant Field Values
-
TIME
public static final short TIME
- See Also:
- Constant Field Values
-
PRICE
public static final short PRICE
- See Also:
- Constant Field Values
-
I8ARRAY
public static final short I8ARRAY
- See Also:
- Constant Field Values
-
U8ARRAY
public static final short U8ARRAY
- See Also:
- Constant Field Values
-
I16ARRAY
public static final short I16ARRAY
- See Also:
- Constant Field Values
-
U16ARRAY
public static final short U16ARRAY
- See Also:
- Constant Field Values
-
I32ARRAY
public static final short I32ARRAY
- See Also:
- Constant Field Values
-
U32ARRAY
public static final short U32ARRAY
- See Also:
- Constant Field Values
-
I64ARRAY
public static final short I64ARRAY
- See Also:
- Constant Field Values
-
U64ARRAY
public static final short U64ARRAY
- See Also:
- Constant Field Values
-
F32ARRAY
public static final short F32ARRAY
- See Also:
- Constant Field Values
-
F64ARRAY
public static final short F64ARRAY
- See Also:
- Constant Field Values
-
VECTOR_STRING
public static final short VECTOR_STRING
- See Also:
- Constant Field Values
-
VECTOR_MSG
public static final short VECTOR_MSG
- See Also:
- Constant Field Values
-
VECTOR_TIME
public static final short VECTOR_TIME
- See Also:
- Constant Field Values
-
VECTOR_PRICE
public static final short VECTOR_PRICE
- See Also:
- Constant Field Values
-
QUANTITY
public static final short QUANTITY
- See Also:
- Constant Field Values
-
VECTOR
public static final short VECTOR
- See Also:
- Constant Field Values
-
COLLECTION
public static final short COLLECTION
- See Also:
- Constant Field Values
-
UNKNOWN
public static final short UNKNOWN
- See Also:
- Constant Field Values
-
-
Method Detail
-
getFid
public int getFid()
Return the field identifier.- Returns:
- The fid.
-
getType
public short getType()
Return the data type.- Returns:
- The type.
-
getName
public java.lang.String getName()
Return the human readable name of the field.- Returns:
- The name.
-
toString
public java.lang.String toString()
Returns a string suitable for output to a terminal containing the type, id, and name.- Overrides:
toString
in classjava.lang.Object
- Returns:
- A human readable string for the field.
-
setClosure
public void setClosure(java.lang.Object closure)
Set user specified data to associate with the field descriptor.- Parameters:
closure
- The data to associate with the descriptor.
-
getClosure
public java.lang.Object getClosure()
Return the user specified data associated with the field descriptor. The closure data has a default value ofnull
- Returns:
- The user specified data associated with the field descriptor.
-
getTypeName
public static java.lang.String getTypeName(short type)
-
setTrackModState
public void setTrackModState(boolean on)
-
getTrackModState
public boolean getTrackModState()
-
-