com.neeve.server.mon.cnc.SrvMonArgumentDescription
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Object
@Generated(value="com.neeve.adm.AdmXbufGenerator",
date="Wed Mar 28 10:54:31 EDT 2018")
@AdmGenerated(encoding="Xbuf",
compatLevel="3.8.0",
admVersion="nvx-adm v3.7.265 (build 0)",
date="3/28/18 10:54 AM",
buildInfo="nvx-talon-3.7.265 (nvx-codegen-plugin)")
@AdmFactoryInfo(factoryClass=SrvMonCncFactory.class,
vfid=36,
ofid=36,
typeId=301)
public final class SrvMonArgumentDescriptionDescribes a command argument
| Nested Class Summary | |
|---|---|
static class |
SrvMonArgumentDescription.Field
The SrvMonArgumentDescription xbuf field (used internally when this entity is used as a field of another entity). |
static class |
SrvMonArgumentDescription.ListField
The SrvMonArgumentDescription list field (used internally when this entity is used as an array field of another entity). |
| Field Summary | |
|---|---|
static SrvMonArgumentDescription[] |
EMPTY_ARRAY
A preallocated empty array used to avoid garbage when returning empty arrays of this type. |
| Constructor Summary | |
|---|---|
SrvMonArgumentDescription()
|
|
SrvMonArgumentDescription(int initialBackingBufferSize)
|
|
| Method Summary | ||
|---|---|---|
SrvMonArgumentDescription |
acquire()
|
|
void |
addValidValues(String val)
Adds the provided value to the list of 'validValues' values. |
|
void |
clearContent()
|
|
void |
clearDefaultValue()
Clears the value of 'defaultValue' Field Description The default value for the argument when not specified ... or not set if no default |
|
void |
clearDescription()
Clears the value of 'description' Field Description The command description |
|
void |
clearDisplayName()
Clears the value of 'displayName' Field Description The display name for the argument If a display name is not provided then the name should be used by tools. |
|
void |
clearName()
Clears the value of 'name' Field Description The command name |
|
void |
clearPosition()
Clears the value of 'position' Field Description The position at which the argument must be specified |
|
void |
clearRequired()
Clears the value of 'required' Field Description Whether or not the argument is required |
|
void |
clearType()
Clears the value of 'type' Field Description Describes the type of the argument |
|
void |
clearValidValues()
Clears the value of 'validValues' Field Description When set restricts the set of valid values for the command. |
|
void |
clearXRogType()
|
|
Object |
clone()
Creates a clone of this object. |
|
SrvMonArgumentDescription |
copy()
Creates a copy of this SrvMonArgumentDescription. |
|
void |
copyInto(SrvMonArgumentDescription copy)
Copies the contents of this SrvMonArgumentDescription into the target. |
|
static SrvMonArgumentDescription |
create()
|
|
static SrvMonArgumentDescription |
createFrom(byte[] serializedContainer)
|
|
static SrvMonArgumentDescription |
createFrom(byte[] serializedContainer,
com.neeve.xbuf.XbufDesyncPolicy desyncPolicy)
|
|
static SrvMonArgumentDescription |
createFromSerializedXbufContainer(byte[] serializedContainer)
|
|
static SrvMonArgumentDescription |
createFromSerializedXbufContainer(byte[] serializedContainer,
com.neeve.xbuf.XbufDesyncPolicy desyncPolicy)
|
|
static com.neeve.xbuf.XbufSchema |
createSchema()
|
|
static com.neeve.xbuf.XbufRepeatedStringFieldBuffer |
createValidValuesFieldBuffer(int initialBufferLength,
boolean isNative)
Returns a wrapped buffer that can be used for doing an efficient bulk copy from an XIterator returned for this field. |
|
SrvMonArgumentDescription |
deserializeFromByteArray(byte[] array)
|
|
SrvMonArgumentDescription |
deserializeFromByteArray(byte[] array,
com.neeve.xbuf.XbufDesyncPolicy desyncPolicy)
|
|
SrvMonArgumentDescription |
deserializeFromByteBuffer(ByteBuffer buffer)
|
|
SrvMonArgumentDescription |
deserializeFromByteBuffer(ByteBuffer buffer,
com.neeve.xbuf.XbufDesyncPolicy desyncPolicy)
|
|
SrvMonArgumentDescription |
deserializeFromIOElasticBuffer(com.neeve.io.IOElasticBuffer buffer,
int offset,
int length)
|
|
SrvMonArgumentDescription |
deserializeFromIOElasticBuffer(com.neeve.io.IOElasticBuffer buffer,
int offset,
int length,
com.neeve.xbuf.XbufDesyncPolicy desyncPolicy)
|
|
SrvMonArgumentDescription |
deserializeFromNative(long address,
int offset,
int length)
|
|
SrvMonArgumentDescription |
deserializeFromNative(long address,
int offset,
int length,
com.neeve.xbuf.XbufDesyncPolicy desyncPolicy)
|
|
int |
desync(PktBuffer buffer,
int pos,
boolean frameOnly)
|
|
void |
desyncFieldBitmask()
|
|
void |
dispose()
|
|
PktBuffer |
getBackingBuffer()
|
|
String |
getDefaultValue()
Gets the value of 'defaultValue' Field Description The default value for the argument when not specified ... or not set if no default |
|
com.neeve.xbuf.XbufStringField |
getDefaultValueField()
|
|
static int |
getDefaultValueFieldId()
Get the field id for 'defaultValue' This method can be used to set field interests. |
|
|
getDefaultValueTo(XString.Factory<T> factory)
Copies the value of this String field into a new XString from the given factory. |
|
void |
getDefaultValueTo(XString val)
Copies the value of 'defaultValue' into the provided XString. |
|
XString |
getDefaultValueUnsafe()
Gets the raw value of 'defaultValue'. |
|
String |
getDescription()
Gets the value of 'description' Field Description The command description |
|
com.neeve.xbuf.XbufStringField |
getDescriptionField()
|
|
static int |
getDescriptionFieldId()
Get the field id for 'description' This method can be used to set field interests. |
|
|
getDescriptionTo(XString.Factory<T> factory)
Copies the value of this String field into a new XString from the given factory. |
|
void |
getDescriptionTo(XString val)
Copies the value of 'description' into the provided XString. |
|
XString |
getDescriptionUnsafe()
Gets the raw value of 'description'. |
|
static com.neeve.xbuf.XbufDesyncPolicy |
getDesyncPolicy()
|
|
String |
getDisplayName()
Gets the value of 'displayName' Field Description The display name for the argument If a display name is not provided then the name should be used by tools. |
|
com.neeve.xbuf.XbufStringField |
getDisplayNameField()
|
|
static int |
getDisplayNameFieldId()
Get the field id for 'displayName' This method can be used to set field interests. |
|
|
getDisplayNameTo(XString.Factory<T> factory)
Copies the value of this String field into a new XString from the given factory. |
|
void |
getDisplayNameTo(XString val)
Copies the value of 'displayName' into the provided XString. |
|
XString |
getDisplayNameUnsafe()
Gets the raw value of 'displayName'. |
|
boolean |
getIsReadOnly()
|
|
String |
getName()
Gets the value of 'name' Field Description The command name |
|
com.neeve.xbuf.XbufStringField |
getNameField()
|
|
static int |
getNameFieldId()
Get the field id for 'name' This method can be used to set field interests. |
|
|
getNameTo(XString.Factory<T> factory)
Copies the value of this String field into a new XString from the given factory. |
|
void |
getNameTo(XString val)
Copies the value of 'name' into the provided XString. |
|
XString |
getNameUnsafe()
Gets the raw value of 'name'. |
|
int |
getOwnerCount()
|
|
UtlPool<SrvMonArgumentDescription> |
getPool()
Get a pool item's pool. |
|
short |
getPosition()
Gets the value of 'position' Field Description The position at which the argument must be specified |
|
com.neeve.xbuf.XbufVariableShortField |
getPositionField()
|
|
static int |
getPositionFieldId()
Get the field id for 'position' This method can be used to set field interests. |
|
boolean |
getRequired()
Gets the value of 'required' Field Description Whether or not the argument is required |
|
com.neeve.xbuf.XbufVariableBooleanField |
getRequiredField()
|
|
static int |
getRequiredFieldId()
Get the field id for 'required' This method can be used to set field interests. |
|
int |
getSerializeToNativeLength()
|
|
SrvMonArgumentType |
getType()
Gets the value of 'type' Field Description Describes the type of the argument |
|
com.neeve.xbuf.XbufVariableEnumField<SrvMonArgumentType> |
getTypeField()
|
|
static int |
getTypeFieldId()
Get the field id for 'type' This method can be used to set field interests. |
|
void |
getValidationErrors(List<XString> results,
String errorPrefix)
Collects validation errors into the provided list. |
|
String[] |
getValidValues()
Gets the value of 'validValues' If the field is not set this method will return null. |
|
String[] |
getValidValuesEmptyIfNull()
Gets the value of 'validValues' or an empty array if the value is null or not set. |
|
static int |
getValidValuesFieldId()
Get the field id for 'validValues' This method can be used to set field interests. |
|
XStringIterator |
getValidValuesIterator()
Gets the value of 'validValues' as iterator of values. |
|
short |
getXRogType()
|
|
com.neeve.xbuf.XbufVariableShortField |
getXRogTypeField()
|
|
static int |
getXRogTypeFieldId()
Get the field id for 'xRogType' This method can be used to set field interests. |
|
boolean |
hasDefaultValue()
Checks for the presence of 'defaultValue' Field Description The default value for the argument when not specified ... or not set if no default |
|
boolean |
hasDescription()
Checks for the presence of 'description' Field Description The command description |
|
boolean |
hasDisplayName()
Checks for the presence of 'displayName' Field Description The display name for the argument If a display name is not provided then the name should be used by tools. |
|
boolean |
hasName()
Checks for the presence of 'name' Field Description The command name |
|
boolean |
hasPosition()
Checks for the presence of 'position' Field Description The position at which the argument must be specified |
|
boolean |
hasRequired()
Checks for the presence of 'required' Field Description Whether or not the argument is required |
|
boolean |
hasType()
Checks for the presence of 'type' Field Description Describes the type of the argument |
|
boolean |
hasXRogType()
|
|
SrvMonArgumentDescription |
init()
Initialize an item. |
|
boolean |
isBufferBacked()
|
|
boolean |
isDirty()
|
|
boolean |
isReferenceCounted()
|
|
boolean |
isValid()
Tests if this object has any validation errors. |
|
void |
lendDefaultValue(XString val)
Sets the value of 'defaultValue' Field Description The default value for the argument when not specified ... or not set if no default |
|
void |
lendDescription(XString val)
Sets the value of 'description' Field Description The command description |
|
void |
lendDisplayName(XString val)
Sets the value of 'displayName' Field Description The display name for the argument If a display name is not provided then the name should be used by tools. |
|
void |
lendName(XString val)
Sets the value of 'name' Field Description The command name |
|
static void |
optimizeFor(int val)
|
|
byte[] |
serializeToByteArray()
|
|
ByteBuffer |
serializeToByteBuffer()
|
|
com.neeve.io.IOBuffer |
serializeToIOBuffer(boolean useNative)
|
|
int |
serializeToNative(long address,
int addressOffset)
|
|
void |
setAsReadOnly()
|
|
void |
setDefaultValue(String val)
Sets the value of 'defaultValue' Field Description The default value for the argument when not specified ... or not set if no default |
|
void |
setDefaultValueFrom(long val)
Sets the value of this String field to the given numeric value. |
|
void |
setDefaultValueFrom(com.neeve.xbuf.XbufStringField val)
|
|
void |
setDefaultValueFrom(XString val)
Copies the provided XString value into this object's 'defaultValue'. |
|
void |
setDescription(String val)
Sets the value of 'description' Field Description The command description |
|
void |
setDescriptionFrom(long val)
Sets the value of this String field to the given numeric value. |
|
void |
setDescriptionFrom(com.neeve.xbuf.XbufStringField val)
|
|
void |
setDescriptionFrom(XString val)
Copies the provided XString value into this object's 'description'. |
|
static void |
setDesyncPolicy(com.neeve.xbuf.XbufDesyncPolicy val)
|
|
void |
setDisplayName(String val)
Sets the value of 'displayName' Field Description The display name for the argument If a display name is not provided then the name should be used by tools. |
|
void |
setDisplayNameFrom(long val)
Sets the value of this String field to the given numeric value. |
|
void |
setDisplayNameFrom(com.neeve.xbuf.XbufStringField val)
|
|
void |
setDisplayNameFrom(XString val)
Copies the provided XString value into this object's 'displayName'. |
|
static void |
setFieldInterest(List<Integer> fieldIds)
|
|
void |
setName(String val)
Sets the value of 'name' Field Description The command name |
|
void |
setNameFrom(long val)
Sets the value of this String field to the given numeric value. |
|
void |
setNameFrom(com.neeve.xbuf.XbufStringField val)
|
|
void |
setNameFrom(XString val)
Copies the provided XString value into this object's 'name'. |
|
SrvMonArgumentDescription |
setPool(UtlPool<SrvMonArgumentDescription> pool)
Set a pool item's pool. |
|
void |
setPosition(short val)
Sets the value of 'position' Field Description The position at which the argument must be specified |
|
void |
setPositionFrom(com.neeve.xbuf.XbufVariableShortField val)
|
|
void |
setRequired(boolean val)
Sets the value of 'required' Field Description Whether or not the argument is required |
|
void |
setRequiredFrom(com.neeve.xbuf.XbufVariableBooleanField val)
|
|
void |
setType(SrvMonArgumentType val)
Sets the value of 'type' Field Description Describes the type of the argument |
|
void |
setTypeFrom(com.neeve.xbuf.XbufVariableEnumField<SrvMonArgumentType> val)
|
|
void |
setValidValues(String[] val)
Sets the value of 'validValues' Field Description When set restricts the set of valid values for the command. |
|
void |
setValidValuesFrom(XIterator<String> val)
Sets the value of 'validValues' using the values from the provided iterator. |
|
void |
setXRogType(short val)
|
|
void |
setXRogTypeFrom(com.neeve.xbuf.XbufVariableShortField val)
|
|
void |
sync()
|
|
void |
syncFieldBitmask()
|
|
String |
toString()
|
|
| Methods inherited from class java.lang.Object |
|---|
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
| Field Detail |
|---|
public static final SrvMonArgumentDescription[] EMPTY_ARRAY
| Constructor Detail |
|---|
public SrvMonArgumentDescription()
public SrvMonArgumentDescription(int initialBackingBufferSize)
| Method Detail |
|---|
public static SrvMonArgumentDescription create()
public static SrvMonArgumentDescription createFromSerializedXbufContainer(byte[] serializedContainer,
com.neeve.xbuf.XbufDesyncPolicy desyncPolicy)
public static SrvMonArgumentDescription createFromSerializedXbufContainer(byte[] serializedContainer)
public static SrvMonArgumentDescription createFrom(byte[] serializedContainer,
com.neeve.xbuf.XbufDesyncPolicy desyncPolicy)
public static SrvMonArgumentDescription createFrom(byte[] serializedContainer)
public static final void setDesyncPolicy(com.neeve.xbuf.XbufDesyncPolicy val)
public static final com.neeve.xbuf.XbufDesyncPolicy getDesyncPolicy()
public static final void setFieldInterest(List<Integer> fieldIds)
public final void clearContent()
public final void syncFieldBitmask()
public final void desyncFieldBitmask()
public final PktBuffer getBackingBuffer()
public static final void optimizeFor(int val)
public final void setAsReadOnly()
public final boolean getIsReadOnly()
public static final int getXRogTypeFieldId()
This method can be used to set field interests.
getXRogType()public final void setXRogType(short val)
public final short getXRogType()
public final void setXRogTypeFrom(com.neeve.xbuf.XbufVariableShortField val)
public final com.neeve.xbuf.XbufVariableShortField getXRogTypeField()
public final boolean hasXRogType()
public final void clearXRogType()
public static final int getPositionFieldId()
This method can be used to set field interests.
getPosition()public final void setPosition(short val)
ISrvMonArgumentDescription
setPosition in interface ISrvMonArgumentDescriptionval - The value to set.public final short getPosition()
ISrvMonArgumentDescription
getPosition in interface ISrvMonArgumentDescriptionpublic final void setPositionFrom(com.neeve.xbuf.XbufVariableShortField val)
public final com.neeve.xbuf.XbufVariableShortField getPositionField()
public final boolean hasPosition()
ISrvMonArgumentDescription
hasPosition in interface ISrvMonArgumentDescriptionISrvMonArgumentDescription.getPosition()public final void clearPosition()
ISrvMonArgumentDescription
clearPosition in interface ISrvMonArgumentDescriptionISrvMonArgumentDescription.setPosition(short)public static final int getRequiredFieldId()
This method can be used to set field interests.
getRequired()public final void setRequired(boolean val)
ISrvMonArgumentDescription
setRequired in interface ISrvMonArgumentDescriptionval - The value to set.public final boolean getRequired()
ISrvMonArgumentDescription
getRequired in interface ISrvMonArgumentDescriptionpublic final void setRequiredFrom(com.neeve.xbuf.XbufVariableBooleanField val)
public final com.neeve.xbuf.XbufVariableBooleanField getRequiredField()
public final boolean hasRequired()
ISrvMonArgumentDescription
hasRequired in interface ISrvMonArgumentDescriptionISrvMonArgumentDescription.getRequired()public final void clearRequired()
ISrvMonArgumentDescription
clearRequired in interface ISrvMonArgumentDescriptionISrvMonArgumentDescription.setRequired(boolean)public static final int getTypeFieldId()
This method can be used to set field interests.
getType()public final void setType(SrvMonArgumentType val)
ISrvMonArgumentDescription
setType in interface ISrvMonArgumentDescriptionval - The value to set.public final void setTypeFrom(com.neeve.xbuf.XbufVariableEnumField<SrvMonArgumentType> val)
public final com.neeve.xbuf.XbufVariableEnumField<SrvMonArgumentType> getTypeField()
public final SrvMonArgumentType getType()
ISrvMonArgumentDescription
getType in interface ISrvMonArgumentDescriptionpublic final boolean hasType()
ISrvMonArgumentDescription
hasType in interface ISrvMonArgumentDescriptionISrvMonArgumentDescription.getType()public final void clearType()
ISrvMonArgumentDescription
clearType in interface ISrvMonArgumentDescriptionISrvMonArgumentDescription.setType(SrvMonArgumentType)public static final int getNameFieldId()
This method can be used to set field interests.
getName()public final void setName(String val)
ISrvMonArgumentDescription
setName in interface ISrvMonArgumentDescriptionval - The value to set.public final String getName()
ISrvMonArgumentDescription
getName in interface ISrvMonArgumentDescriptionpublic final void lendName(XString val)
ISrvMonArgumentDescription
lendName in interface ISrvMonArgumentDescriptionval - The value to set.public final void setNameFrom(long val)
ISrvMonArgumentDescription
NOTE:
This is the same as calling ISrvMonArgumentDescription.setName(String).
with Long.valueOf(val).toString(), except that using this method is a zero garbage
operation for Xbuf encoding.
setNameFrom in interface ISrvMonArgumentDescriptionpublic final <T extends XString> T getNameTo(XString.Factory<T> factory)
ISrvMonArgumentDescription
If the value of this field is not null this method creates an XString from
the provided Factory, copies this field's value into the type, and returns the new
XString.);
This is a zero garbage operation if the provided factory is backed by a pool and the pool; has available instances;
getNameTo in interface ISrvMonArgumentDescriptionfactory - The factory from which to get the XString to copy into and return
null.public final void setNameFrom(XString val)
ISrvMonArgumentDescription
NOTE:
This is a Zero Garbage operation for XBuf encoded objects. Additionally, this setter
can be more efficient than ISrvMonArgumentDescription.setName(String)
because it avoids encoding the value into a String if the given XString is already encoded.
setNameFrom in interface ISrvMonArgumentDescriptionpublic final void getNameTo(XString val)
ISrvMonArgumentDescription
NOTE:
This is a Zero Garbage operation for XBuf encoded objects. Additionally, this getter
can be more efficient than ISrvMonArgumentDescription.getName() bec
because it can avoid decoding the value into an String.
getNameTo in interface ISrvMonArgumentDescriptionISrvMonArgumentDescription.getName()public final XString getNameUnsafe()
ISrvMonArgumentDescription
NOTE:
This method retrieves the raw value backed by this object's buffer. This is a useful operation
when copying this field value to another object because it avoids copying the data into an intermediate
XString and instead allows direct byte transfer from the raw value to the target object.
However, this accessor is inherently unsafe because the buffer backing this object can be changed which would consequently invalidate the XString returned by this method. Consequently, the caller must not retain the returned raw value beyond the scope of this object's lifespan and access to the raw value follows the same threading rules as access to this object.
Additionally, the caller must not in any way mutate or modify the returned value as doing so could corrupt this object's backing buffer.
getNameUnsafe in interface ISrvMonArgumentDescriptionISrvMonArgumentDescription.getName()public final void setNameFrom(com.neeve.xbuf.XbufStringField val)
public final com.neeve.xbuf.XbufStringField getNameField()
public final boolean hasName()
ISrvMonArgumentDescription
hasName in interface ISrvMonArgumentDescriptionISrvMonArgumentDescription.getName()public final void clearName()
ISrvMonArgumentDescription
clearName in interface ISrvMonArgumentDescriptionISrvMonArgumentDescription.setName(String)public static final int getDefaultValueFieldId()
This method can be used to set field interests.
getDefaultValue()public final void setDefaultValue(String val)
ISrvMonArgumentDescription
setDefaultValue in interface ISrvMonArgumentDescriptionval - The value to set.public final String getDefaultValue()
ISrvMonArgumentDescription
getDefaultValue in interface ISrvMonArgumentDescriptionpublic final void lendDefaultValue(XString val)
ISrvMonArgumentDescription
lendDefaultValue in interface ISrvMonArgumentDescriptionval - The value to set.public final void setDefaultValueFrom(long val)
ISrvMonArgumentDescription
NOTE:
This is the same as calling ISrvMonArgumentDescription.setDefaultValue(String).
with Long.valueOf(val).toString(), except that using this method is a zero garbage
operation for Xbuf encoding.
setDefaultValueFrom in interface ISrvMonArgumentDescriptionpublic final <T extends XString> T getDefaultValueTo(XString.Factory<T> factory)
ISrvMonArgumentDescription
If the value of this field is not null this method creates an XString from
the provided Factory, copies this field's value into the type, and returns the new
XString.);
This is a zero garbage operation if the provided factory is backed by a pool and the pool; has available instances;
getDefaultValueTo in interface ISrvMonArgumentDescriptionfactory - The factory from which to get the XString to copy into and return
null.public final void setDefaultValueFrom(XString val)
ISrvMonArgumentDescription
NOTE:
This is a Zero Garbage operation for XBuf encoded objects. Additionally, this setter
can be more efficient than ISrvMonArgumentDescription.setDefaultValue(String)
because it avoids encoding the value into a String if the given XString is already encoded.
setDefaultValueFrom in interface ISrvMonArgumentDescriptionpublic final void getDefaultValueTo(XString val)
ISrvMonArgumentDescription
NOTE:
This is a Zero Garbage operation for XBuf encoded objects. Additionally, this getter
can be more efficient than ISrvMonArgumentDescription.getDefaultValue() bec
because it can avoid decoding the value into an String.
getDefaultValueTo in interface ISrvMonArgumentDescriptionISrvMonArgumentDescription.getDefaultValue()public final XString getDefaultValueUnsafe()
ISrvMonArgumentDescription
NOTE:
This method retrieves the raw value backed by this object's buffer. This is a useful operation
when copying this field value to another object because it avoids copying the data into an intermediate
XString and instead allows direct byte transfer from the raw value to the target object.
However, this accessor is inherently unsafe because the buffer backing this object can be changed which would consequently invalidate the XString returned by this method. Consequently, the caller must not retain the returned raw value beyond the scope of this object's lifespan and access to the raw value follows the same threading rules as access to this object.
Additionally, the caller must not in any way mutate or modify the returned value as doing so could corrupt this object's backing buffer.
getDefaultValueUnsafe in interface ISrvMonArgumentDescriptionISrvMonArgumentDescription.getDefaultValue()public final void setDefaultValueFrom(com.neeve.xbuf.XbufStringField val)
public final com.neeve.xbuf.XbufStringField getDefaultValueField()
public final boolean hasDefaultValue()
ISrvMonArgumentDescription
hasDefaultValue in interface ISrvMonArgumentDescriptionISrvMonArgumentDescription.getDefaultValue()public final void clearDefaultValue()
ISrvMonArgumentDescription
clearDefaultValue in interface ISrvMonArgumentDescriptionISrvMonArgumentDescription.setDefaultValue(String)public static final int getValidValuesFieldId()
This method can be used to set field interests.
getValidValues()
public static final com.neeve.xbuf.XbufRepeatedStringFieldBuffer createValidValuesFieldBuffer(int initialBufferLength,
boolean isNative)
For example the following would result in a bulk transfer from this message
XbufRepeatedStringFieldBuffer preallocated = SrvMonArgumentDescription.createValidValuesFieldBuffer(1024, true); // The following would then result in a buffer copy without any iteration: preallocated.setValue(inboundMessage.getValidValuesIterator()); // The preallocated bulk copied values can then be transfered to an outbound message: outboundMessage.setValidValues.setValueFrom(preallocated);
Bulk transfer from the backing buffer may only possible between two fields with the same id (protobuf tag) because the bulk transfered bytes are in protobuf wire format which for most repeated fields encode the field's tag for each element.
initialBufferLength - the initial size of the underlying backing buffer.isNative - Whether the backing buffer should be a native or heap buffer.public final void setValidValues(String[] val)
ISrvMonArgumentDescription
setValidValues in interface ISrvMonArgumentDescriptionval - The value to set.public final void setValidValuesFrom(XIterator<String> val)
ISrvMonArgumentDescription
This method will call XIterator.toFirst() before and after setting the values, meaning
that all values from the iterator will be set and the iterator will be reset on return.
This method is zero garbage for Xbuf generated classes, and this method is optimized such that calling this with an iterator from another 'validValues' accessor can copy the values without iteration.
NOTE:
Passing a null or empty iterator has the same affect as calling ISrvMonArgumentDescription.setValidValues(String[]) with
a value of null.
setValidValuesFrom in interface ISrvMonArgumentDescriptionval - the values to set.public final void addValidValues(String val)
ISrvMonArgumentDescriptionThis method is zero garbage for Xbuf generated classes, and this method is optimized such that calling this with an iterator from another 'validValues' accessor can copy the values without iteration.
For objects generated with json encoding, or transactional state entities, using this method is currently efficient than doing a bulk set. For xbuf generated messages however, this method is optimized to directly serialize to an encoded backing buffer.
addValidValues in interface ISrvMonArgumentDescriptionval - the value to add.public final String[] getValidValues()
ISrvMonArgumentDescription
If the field is not set this method will return null.
getValidValues in interface ISrvMonArgumentDescriptionnull.public final String[] getValidValuesEmptyIfNull()
ISrvMonArgumentDescriptionnull or not set.
getValidValuesEmptyIfNull in interface ISrvMonArgumentDescriptionnull if not set.ISrvMonArgumentDescription.getValidValues()public final XStringIterator getValidValuesIterator()
ISrvMonArgumentDescriptionThis method will always return a non null iterator value. The returned iterator is not threadsafe, and the caller may not hold on to it beyond the pooling lifespan of this object. Depending on the implementation, the same iterator instance may be returned by this object on each call to avoid garbage. Each time this method is called the iterator is reset by calling its toFirst() method. Callers should therefore be especially careful about calling this method while iterating on the iterator returned by this method.
This method is zero garbage for Xbuf generated classes, and this method is optimized such that
passing the returned iterator to another object's setXXX(com.neeve.lang.XStringIterator) method
can perform a direct copy of the underlying values without iteration.
getValidValuesIterator in interface ISrvMonArgumentDescriptionpublic final void clearValidValues()
ISrvMonArgumentDescription
clearValidValues in interface ISrvMonArgumentDescriptionISrvMonArgumentDescription.setValidValues(String[])public static final int getDescriptionFieldId()
This method can be used to set field interests.
getDescription()public final void setDescription(String val)
ISrvMonArgumentDescription
setDescription in interface ISrvMonArgumentDescriptionval - The value to set.public final String getDescription()
ISrvMonArgumentDescription
getDescription in interface ISrvMonArgumentDescriptionpublic final void lendDescription(XString val)
ISrvMonArgumentDescription
lendDescription in interface ISrvMonArgumentDescriptionval - The value to set.public final void setDescriptionFrom(long val)
ISrvMonArgumentDescription
NOTE:
This is the same as calling ISrvMonArgumentDescription.setDescription(String).
with Long.valueOf(val).toString(), except that using this method is a zero garbage
operation for Xbuf encoding.
setDescriptionFrom in interface ISrvMonArgumentDescriptionpublic final <T extends XString> T getDescriptionTo(XString.Factory<T> factory)
ISrvMonArgumentDescription
If the value of this field is not null this method creates an XString from
the provided Factory, copies this field's value into the type, and returns the new
XString.);
This is a zero garbage operation if the provided factory is backed by a pool and the pool; has available instances;
getDescriptionTo in interface ISrvMonArgumentDescriptionfactory - The factory from which to get the XString to copy into and return
null.public final void setDescriptionFrom(XString val)
ISrvMonArgumentDescription
NOTE:
This is a Zero Garbage operation for XBuf encoded objects. Additionally, this setter
can be more efficient than ISrvMonArgumentDescription.setDescription(String)
because it avoids encoding the value into a String if the given XString is already encoded.
setDescriptionFrom in interface ISrvMonArgumentDescriptionpublic final void getDescriptionTo(XString val)
ISrvMonArgumentDescription
NOTE:
This is a Zero Garbage operation for XBuf encoded objects. Additionally, this getter
can be more efficient than ISrvMonArgumentDescription.getDescription() bec
because it can avoid decoding the value into an String.
getDescriptionTo in interface ISrvMonArgumentDescriptionISrvMonArgumentDescription.getDescription()public final XString getDescriptionUnsafe()
ISrvMonArgumentDescription
NOTE:
This method retrieves the raw value backed by this object's buffer. This is a useful operation
when copying this field value to another object because it avoids copying the data into an intermediate
XString and instead allows direct byte transfer from the raw value to the target object.
However, this accessor is inherently unsafe because the buffer backing this object can be changed which would consequently invalidate the XString returned by this method. Consequently, the caller must not retain the returned raw value beyond the scope of this object's lifespan and access to the raw value follows the same threading rules as access to this object.
Additionally, the caller must not in any way mutate or modify the returned value as doing so could corrupt this object's backing buffer.
getDescriptionUnsafe in interface ISrvMonArgumentDescriptionISrvMonArgumentDescription.getDescription()public final void setDescriptionFrom(com.neeve.xbuf.XbufStringField val)
public final com.neeve.xbuf.XbufStringField getDescriptionField()
public final boolean hasDescription()
ISrvMonArgumentDescription
hasDescription in interface ISrvMonArgumentDescriptionISrvMonArgumentDescription.getDescription()public final void clearDescription()
ISrvMonArgumentDescription
clearDescription in interface ISrvMonArgumentDescriptionISrvMonArgumentDescription.setDescription(String)public static final int getDisplayNameFieldId()
This method can be used to set field interests.
getDisplayName()public final void setDisplayName(String val)
ISrvMonArgumentDescriptionIf a display name is not provided then the name should be used by tools. The display name is for display purposes only and cannot be used to invoke a command.
setDisplayName in interface ISrvMonArgumentDescriptionval - The value to set.public final String getDisplayName()
ISrvMonArgumentDescriptionIf a display name is not provided then the name should be used by tools. The display name is for display purposes only and cannot be used to invoke a command.
getDisplayName in interface ISrvMonArgumentDescriptionpublic final void lendDisplayName(XString val)
ISrvMonArgumentDescriptionIf a display name is not provided then the name should be used by tools. The display name is for display purposes only and cannot be used to invoke a command.
lendDisplayName in interface ISrvMonArgumentDescriptionval - The value to set.public final void setDisplayNameFrom(long val)
ISrvMonArgumentDescriptionIf a display name is not provided then the name should be used by tools. The display name is for display purposes only and cannot be used to invoke a command.
NOTE:
This is the same as calling ISrvMonArgumentDescription.setDisplayName(String).
with Long.valueOf(val).toString(), except that using this method is a zero garbage
operation for Xbuf encoding.
setDisplayNameFrom in interface ISrvMonArgumentDescriptionpublic final <T extends XString> T getDisplayNameTo(XString.Factory<T> factory)
ISrvMonArgumentDescriptionIf a display name is not provided then the name should be used by tools. The display name is for display purposes only and cannot be used to invoke a command.
If the value of this field is not null this method creates an XString from
the provided Factory, copies this field's value into the type, and returns the new
XString.);
This is a zero garbage operation if the provided factory is backed by a pool and the pool; has available instances;
getDisplayNameTo in interface ISrvMonArgumentDescriptionfactory - The factory from which to get the XString to copy into and return
null.public final void setDisplayNameFrom(XString val)
ISrvMonArgumentDescriptionIf a display name is not provided then the name should be used by tools. The display name is for display purposes only and cannot be used to invoke a command.
NOTE:
This is a Zero Garbage operation for XBuf encoded objects. Additionally, this setter
can be more efficient than ISrvMonArgumentDescription.setDisplayName(String)
because it avoids encoding the value into a String if the given XString is already encoded.
setDisplayNameFrom in interface ISrvMonArgumentDescriptionpublic final void getDisplayNameTo(XString val)
ISrvMonArgumentDescriptionIf a display name is not provided then the name should be used by tools. The display name is for display purposes only and cannot be used to invoke a command.
NOTE:
This is a Zero Garbage operation for XBuf encoded objects. Additionally, this getter
can be more efficient than ISrvMonArgumentDescription.getDisplayName() bec
because it can avoid decoding the value into an String.
getDisplayNameTo in interface ISrvMonArgumentDescriptionISrvMonArgumentDescription.getDisplayName()public final XString getDisplayNameUnsafe()
ISrvMonArgumentDescriptionIf a display name is not provided then the name should be used by tools. The display name is for display purposes only and cannot be used to invoke a command.
NOTE:
This method retrieves the raw value backed by this object's buffer. This is a useful operation
when copying this field value to another object because it avoids copying the data into an intermediate
XString and instead allows direct byte transfer from the raw value to the target object.
However, this accessor is inherently unsafe because the buffer backing this object can be changed which would consequently invalidate the XString returned by this method. Consequently, the caller must not retain the returned raw value beyond the scope of this object's lifespan and access to the raw value follows the same threading rules as access to this object.
Additionally, the caller must not in any way mutate or modify the returned value as doing so could corrupt this object's backing buffer.
getDisplayNameUnsafe in interface ISrvMonArgumentDescriptionISrvMonArgumentDescription.getDisplayName()public final void setDisplayNameFrom(com.neeve.xbuf.XbufStringField val)
public final com.neeve.xbuf.XbufStringField getDisplayNameField()
public final boolean hasDisplayName()
ISrvMonArgumentDescriptionIf a display name is not provided then the name should be used by tools. The display name is for display purposes only and cannot be used to invoke a command.
hasDisplayName in interface ISrvMonArgumentDescriptionISrvMonArgumentDescription.getDisplayName()public final void clearDisplayName()
ISrvMonArgumentDescriptionIf a display name is not provided then the name should be used by tools. The display name is for display purposes only and cannot be used to invoke a command.
clearDisplayName in interface ISrvMonArgumentDescriptionISrvMonArgumentDescription.setDisplayName(String)public final boolean isDirty()
public static final com.neeve.xbuf.XbufSchema createSchema()
public final byte[] serializeToByteArray()
public final ByteBuffer serializeToByteBuffer()
public final com.neeve.io.IOBuffer serializeToIOBuffer(boolean useNative)
public final boolean isBufferBacked()
public final int getSerializeToNativeLength()
public final int serializeToNative(long address,
int addressOffset)
public final SrvMonArgumentDescription deserializeFromIOElasticBuffer(com.neeve.io.IOElasticBuffer buffer,
int offset,
int length,
com.neeve.xbuf.XbufDesyncPolicy desyncPolicy)
public final SrvMonArgumentDescription deserializeFromIOElasticBuffer(com.neeve.io.IOElasticBuffer buffer,
int offset,
int length)
public final SrvMonArgumentDescription deserializeFromByteArray(byte[] array,
com.neeve.xbuf.XbufDesyncPolicy desyncPolicy)
public final SrvMonArgumentDescription deserializeFromByteArray(byte[] array)
public final SrvMonArgumentDescription deserializeFromByteBuffer(ByteBuffer buffer,
com.neeve.xbuf.XbufDesyncPolicy desyncPolicy)
public final SrvMonArgumentDescription deserializeFromByteBuffer(ByteBuffer buffer)
public final SrvMonArgumentDescription deserializeFromNative(long address,
int offset,
int length,
com.neeve.xbuf.XbufDesyncPolicy desyncPolicy)
public final SrvMonArgumentDescription deserializeFromNative(long address,
int offset,
int length)
public final void sync()
public final int desync(PktBuffer buffer,
int pos,
boolean frameOnly)
desync in interface com.neeve.xbuf.IXbufDesyncerpublic final SrvMonArgumentDescription init()
UtlPool.ItemThis method is invoked by an item pool very time an item is put into the pool. The method should wipe the contents of the item so as to present a fresh instance of the item to the caller when retrieved from the pool.
init in interface UtlPool.Item<SrvMonArgumentDescription>public final SrvMonArgumentDescription setPool(UtlPool<SrvMonArgumentDescription> pool)
UtlPool.ItemThis method is invoked by an item pool at the time an item is added to the pool. The intent is to record the item's source pool in the item so it can be disposed back into the pool when the user is done working with it.
setPool in interface UtlPool.Item<SrvMonArgumentDescription>public final UtlPool<SrvMonArgumentDescription> getPool()
UtlPool.Item
This method should return the pool set using UtlPool.Item.setPool(com.neeve.util.UtlPool
getPool in interface UtlPool.Item<SrvMonArgumentDescription>UtlPool.Item.setPool(com.neeve.util.UtlPool) public final boolean isReferenceCounted()
public final SrvMonArgumentDescription acquire()
public final int getOwnerCount()
public final void dispose()
public final Object clone()
This method differs from the copy() method in that:
clone in class Objectpublic final SrvMonArgumentDescription copy()
The copy copies primitive, enum and embedded entity fields into the returned copy. Each embedded entity field is cloned so that modifications made to the copy's embedded entity fields do not affect this SrvMonArgumentDescription's embedded entity fields.
The returned copy will be writeable even if this SrvMonArgumentDescription is read only.
public final void copyInto(SrvMonArgumentDescription copy)
The copy clears the target's contents and copies primitive, enum and embedded entity fields into the provided copy. Each embedded entity field is cloned so that modifications made to the copy's embedded entity fields do not affect this SrvMonArgumentDescription's embedded entity fields.
The returned copy will be writeable even if this SrvMonArgumentDescription is read only.
copy - The target into which to copy.public final boolean isValid()
IRogValidatable
isValid in interface IRogValidatable
public final void getValidationErrors(List<XString> results,
String errorPrefix)
IRogValidatable
getValidationErrors in interface IRogValidatableresults - A results list into which validation errors will be collected.errorPrefix - The bean path prefix to use when identifying invalid fields or null if validating a top level entity.public final String toString()
toString in class Object
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||