public class Description
extends java.lang.Object
implements java.io.Serializable
Modifier and Type | Field and Description |
---|---|
private BitSet |
bitMask
bitfield only - BitSet of unassigned bits
|
private java.lang.String[] |
bitNames
bitfield only - array of bit names
|
private java.lang.String |
description
item's description
|
private boolean |
flagOptional
item is optional or mandatory
|
private boolean |
flagVariable
item is variable or fixed size
|
private java.lang.String |
label
item's label
|
private int |
primitiveType
reports the P2J directory primitive data type
|
private int |
size
item's size
|
Constructor and Description |
---|
Description()
The default constructor.
|
Description(int primitiveType,
boolean flagOptional,
boolean flagVariable,
int size,
java.lang.String label,
java.lang.String description)
Convenience constructor for all types except bitfield based ones.
|
Description(int primitiveType,
boolean flagOptional,
boolean flagVariable,
int size,
java.lang.String label,
java.lang.String description,
java.lang.String[] bitNames,
BitSet bitMask)
Regular constructor for all types of items.
|
Modifier and Type | Method and Description |
---|---|
java.lang.String[] |
getBitNames()
Gets the bit names of this item.
|
java.lang.String |
getDescription()
Gets the description of this item.
|
java.lang.String |
getLabel()
Gets the label of this item.
|
int |
getPrimitiveType()
Gets the primitive data type of this item.
|
int |
getSize()
Gets the fixed size of this item.
|
BitSet |
getUnusedBits()
Gets the mask uf unused bits of this item.
|
boolean |
isOptional()
Gets the optional vs mandatory item's profile.
|
boolean |
isVariableSize()
Gets the variable vs fixed size item's profile.
|
private int primitiveType
private boolean flagOptional
private boolean flagVariable
private int size
private java.lang.String label
private java.lang.String description
private java.lang.String[] bitNames
private BitSet bitMask
public Description()
public Description(int primitiveType, boolean flagOptional, boolean flagVariable, int size, java.lang.String label, java.lang.String description)
primitiveType
- The primitive data typeflagOptional
- Defines an item to be optional or mandatoryflagVariable
- Defines an item to be variable or fixed sizesize
- The sizelabel
- The labeldescription
- The descriptionpublic Description(int primitiveType, boolean flagOptional, boolean flagVariable, int size, java.lang.String label, java.lang.String description, java.lang.String[] bitNames, BitSet bitMask)
primitiveType
- The primitive data typeflagOptional
- Defines an item to be optional or mandatoryflagVariable
- Defines an item to be variable or fixed sizesize
- The sizelabel
- The labeldescription
- The descriptionbitNames
- The array of bit field namesbitMask
- The bit maskpublic int getPrimitiveType()
PrimitiveTypes
interfacepublic boolean isOptional()
true
if the item is optionalpublic boolean isVariableSize()
true
if the item's size is variablepublic int getSize()
public java.lang.String getLabel()
public java.lang.String getDescription()
public java.lang.String[] getBitNames()
null
if not a bitfieldpublic BitSet getUnusedBits()
null
if not a bitfield