com.neeve.server.mon.cnc
Class SrvMonOptionDescription

java.lang.Object
  com.neeve.server.mon.cnc.SrvMonOptionDescription

All Implemented Interfaces:

IRogValidatable, ISrvMonOptionDescription, UtlPool.Item<SrvMonOptionDescription>, com.neeve.xbuf.IXbufDesyncer

@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=302)
public final class SrvMonOptionDescription
extends Object
implements com.neeve.xbuf.IXbufDesyncer, UtlPool.Item<SrvMonOptionDescription>, ISrvMonOptionDescription

Descripes a command option

Nested Class Summary

static class	SrvMonOptionDescription.Field The SrvMonOptionDescription xbuf field (used internally when this entity is used as a field of another entity).
static class	SrvMonOptionDescription.ListField The SrvMonOptionDescription list field (used internally when this entity is used as an array field of another entity).

Field Summary

static SrvMonOptionDescription[]

EMPTY_ARRAY A preallocated empty array used to avoid garbage when returning empty arrays of this type.

Constructor Summary

SrvMonOptionDescription()

SrvMonOptionDescription(int initialBackingBufferSize)

Method Summary

SrvMonOptionDescription	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 an option 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	clearLongForm() Clears the value of 'longForm' Field Description The long form of the command. e.g.
void	clearRequired() Clears the value of 'required' Field Description Whether or not the option is required
void	clearShortForm() Clears the value of 'shortForm' Field Description The short form of the command. e.g.
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.
SrvMonOptionDescription	copy() Creates a copy of this SrvMonOptionDescription.
void	copyInto(SrvMonOptionDescription copy) Copies the contents of this SrvMonOptionDescription into the target.
static SrvMonOptionDescription	create()
static SrvMonOptionDescription	createFrom(byte[] serializedContainer)
static SrvMonOptionDescription	createFrom(byte[] serializedContainer, com.neeve.xbuf.XbufDesyncPolicy desyncPolicy)
static SrvMonOptionDescription	createFromSerializedXbufContainer(byte[] serializedContainer)
static SrvMonOptionDescription	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.
SrvMonOptionDescription	deserializeFromByteArray(byte[] array)
SrvMonOptionDescription	deserializeFromByteArray(byte[] array, com.neeve.xbuf.XbufDesyncPolicy desyncPolicy)
SrvMonOptionDescription	deserializeFromByteBuffer(ByteBuffer buffer)
SrvMonOptionDescription	deserializeFromByteBuffer(ByteBuffer buffer, com.neeve.xbuf.XbufDesyncPolicy desyncPolicy)
SrvMonOptionDescription	deserializeFromIOElasticBuffer(com.neeve.io.IOElasticBuffer buffer, int offset, int length)
SrvMonOptionDescription	deserializeFromIOElasticBuffer(com.neeve.io.IOElasticBuffer buffer, int offset, int length, com.neeve.xbuf.XbufDesyncPolicy desyncPolicy)
SrvMonOptionDescription	deserializeFromNative(long address, int offset, int length)
SrvMonOptionDescription	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 an option 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.
<T extends XString> T	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.
<T extends XString> T	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.
<T extends XString> T	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	getLongForm() Gets the value of 'longForm' Field Description The long form of the command. e.g.
com.neeve.xbuf.XbufStringField	getLongFormField()
static int	getLongFormFieldId() Get the field id for 'longForm' This method can be used to set field interests.
<T extends XString> T	getLongFormTo(XString.Factory<T> factory) Copies the value of this String field into a new XString from the given factory.
void	getLongFormTo(XString val) Copies the value of 'longForm' into the provided XString.
XString	getLongFormUnsafe() Gets the raw value of 'longForm'.
int	getOwnerCount()
UtlPool<SrvMonOptionDescription>	getPool() Get a pool item's pool.
boolean	getRequired() Gets the value of 'required' Field Description Whether or not the option 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()
char	getShortForm() Gets the value of 'shortForm' Field Description The short form of the command. e.g.
com.neeve.xbuf.XbufVariableCharField	getShortFormField()
static int	getShortFormFieldId() Get the field id for 'shortForm' This method can be used to set field interests.
SrvMonOptionType	getType() Gets the value of 'type' Field Description Describes the type of the argument
com.neeve.xbuf.XbufVariableEnumField<SrvMonOptionType>	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 an option 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	hasLongForm() Checks for the presence of 'longForm' Field Description The long form of the command. e.g.
boolean	hasRequired() Checks for the presence of 'required' Field Description Whether or not the option is required
boolean	hasShortForm() Checks for the presence of 'shortForm' Field Description The short form of the command. e.g.
boolean	hasType() Checks for the presence of 'type' Field Description Describes the type of the argument
boolean	hasXRogType()
SrvMonOptionDescription	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 an option 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	lendLongForm(XString val) Sets the value of 'longForm' Field Description The long form of the command. e.g.
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 an option 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	setLongForm(String val) Sets the value of 'longForm' Field Description The long form of the command. e.g.
void	setLongFormFrom(long val) Sets the value of this String field to the given numeric value.
void	setLongFormFrom(com.neeve.xbuf.XbufStringField val)
void	setLongFormFrom(XString val) Copies the provided XString value into this object's 'longForm'.
SrvMonOptionDescription	setPool(UtlPool<SrvMonOptionDescription> pool) Set a pool item's pool.
void	setRequired(boolean val) Sets the value of 'required' Field Description Whether or not the option is required
void	setRequiredFrom(com.neeve.xbuf.XbufVariableBooleanField val)
void	setShortForm(char val) Sets the value of 'shortForm' Field Description The short form of the command. e.g.
void	setShortFormFrom(com.neeve.xbuf.XbufVariableCharField val)
void	setType(SrvMonOptionType val) Sets the value of 'type' Field Description Describes the type of the argument
void	setTypeFrom(com.neeve.xbuf.XbufVariableEnumField<SrvMonOptionType> 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

EMPTY_ARRAY

public static final SrvMonOptionDescription[] EMPTY_ARRAY

A preallocated empty array used to avoid garbage when returning empty arrays of this type.

Constructor Detail

SrvMonOptionDescription

public SrvMonOptionDescription()

SrvMonOptionDescription

public SrvMonOptionDescription(int initialBackingBufferSize)

Method Detail

create

public static SrvMonOptionDescription create()

createFromSerializedXbufContainer

public static SrvMonOptionDescription createFromSerializedXbufContainer(byte[] serializedContainer,
                                                                        com.neeve.xbuf.XbufDesyncPolicy desyncPolicy)

createFromSerializedXbufContainer

public static SrvMonOptionDescription createFromSerializedXbufContainer(byte[] serializedContainer)

createFrom

public static SrvMonOptionDescription createFrom(byte[] serializedContainer,
                                                 com.neeve.xbuf.XbufDesyncPolicy desyncPolicy)

createFrom

public static SrvMonOptionDescription createFrom(byte[] serializedContainer)

setDesyncPolicy

public static final void setDesyncPolicy(com.neeve.xbuf.XbufDesyncPolicy val)

getDesyncPolicy

public static final com.neeve.xbuf.XbufDesyncPolicy getDesyncPolicy()

setFieldInterest

public static final void setFieldInterest(List<Integer> fieldIds)

clearContent

public final void clearContent()

syncFieldBitmask

public final void syncFieldBitmask()

desyncFieldBitmask

public final void desyncFieldBitmask()

getBackingBuffer

public final PktBuffer getBackingBuffer()

optimizeFor

public static final void optimizeFor(int val)

setAsReadOnly

public final void setAsReadOnly()

getIsReadOnly

public final boolean getIsReadOnly()

getXRogTypeFieldId

public static final int getXRogTypeFieldId()

Get the field id for 'xRogType'

This method can be used to set field interests.

See Also:

getXRogType()

setXRogType

public final void setXRogType(short val)

getXRogType

public final short getXRogType()

setXRogTypeFrom

public final void setXRogTypeFrom(com.neeve.xbuf.XbufVariableShortField val)

getXRogTypeField

public final com.neeve.xbuf.XbufVariableShortField getXRogTypeField()

hasXRogType

public final boolean hasXRogType()

clearXRogType

public final void clearXRogType()

getShortFormFieldId

public static final int getShortFormFieldId()

Get the field id for 'shortForm'

This method can be used to set field interests.

See Also:

getShortForm()

setShortForm

public final void setShortForm(char val)

Description copied from interface: ISrvMonOptionDescription

Sets the value of 'shortForm'

Field Description

The short form of the command. e.g. 'o' for -o

Specified by:

setShortForm in interface ISrvMonOptionDescription

Parameters:

val - The value to set.

getShortForm

public final char getShortForm()

Description copied from interface: ISrvMonOptionDescription

Gets the value of 'shortForm'

Field Description

The short form of the command. e.g. 'o' for -o

Specified by:

getShortForm in interface ISrvMonOptionDescription

Returns:

The short form of the command. e.g. 'o' for -o

setShortFormFrom

public final void setShortFormFrom(com.neeve.xbuf.XbufVariableCharField val)

getShortFormField

public final com.neeve.xbuf.XbufVariableCharField getShortFormField()

hasShortForm

public final boolean hasShortForm()

Description copied from interface: ISrvMonOptionDescription

Checks for the presence of 'shortForm'

Field Description

The short form of the command. e.g. 'o' for -o

Specified by:

hasShortForm in interface ISrvMonOptionDescription

See Also:

ISrvMonOptionDescription.getShortForm()

clearShortForm

public final void clearShortForm()

Description copied from interface: ISrvMonOptionDescription

Clears the value of 'shortForm'

Field Description

The short form of the command. e.g. 'o' for -o

Specified by:

clearShortForm in interface ISrvMonOptionDescription

See Also:

ISrvMonOptionDescription.setShortForm(char)

getRequiredFieldId

public static final int getRequiredFieldId()

Get the field id for 'required'

This method can be used to set field interests.

See Also:

getRequired()

setRequired

public final void setRequired(boolean val)

Description copied from interface: ISrvMonOptionDescription

Sets the value of 'required'

Field Description

Whether or not the option is required

Specified by:

setRequired in interface ISrvMonOptionDescription

Parameters:

val - The value to set.

getRequired

public final boolean getRequired()

Description copied from interface: ISrvMonOptionDescription

Gets the value of 'required'

Field Description

Whether or not the option is required

Specified by:

getRequired in interface ISrvMonOptionDescription

Returns:

Whether or not the option is required

setRequiredFrom

public final void setRequiredFrom(com.neeve.xbuf.XbufVariableBooleanField val)

getRequiredField

public final com.neeve.xbuf.XbufVariableBooleanField getRequiredField()

hasRequired

public final boolean hasRequired()

Description copied from interface: ISrvMonOptionDescription

Checks for the presence of 'required'

Field Description

Whether or not the option is required

Specified by:

hasRequired in interface ISrvMonOptionDescription

See Also:

ISrvMonOptionDescription.getRequired()

clearRequired

public final void clearRequired()

Description copied from interface: ISrvMonOptionDescription

Clears the value of 'required'

Field Description

Whether or not the option is required

Specified by:

clearRequired in interface ISrvMonOptionDescription

See Also:

ISrvMonOptionDescription.setRequired(boolean)

getTypeFieldId

public static final int getTypeFieldId()

Get the field id for 'type'

This method can be used to set field interests.

See Also:

getType()

setType

public final void setType(SrvMonOptionType val)

Description copied from interface: ISrvMonOptionDescription

Sets the value of 'type'

Field Description

Describes the type of the argument

Specified by:

setType in interface ISrvMonOptionDescription

Parameters:

val - The value to set.

setTypeFrom

public final void setTypeFrom(com.neeve.xbuf.XbufVariableEnumField<SrvMonOptionType> val)

getTypeField

public final com.neeve.xbuf.XbufVariableEnumField<SrvMonOptionType> getTypeField()

getType

public final SrvMonOptionType getType()

Description copied from interface: ISrvMonOptionDescription

Gets the value of 'type'

Field Description

Describes the type of the argument

Specified by:

getType in interface ISrvMonOptionDescription

Returns:

Describes the type of the argument

hasType

public final boolean hasType()

Description copied from interface: ISrvMonOptionDescription

Checks for the presence of 'type'

Field Description

Describes the type of the argument

Specified by:

hasType in interface ISrvMonOptionDescription

See Also:

ISrvMonOptionDescription.getType()

clearType

public final void clearType()

Description copied from interface: ISrvMonOptionDescription

Clears the value of 'type'

Field Description

Describes the type of the argument

Specified by:

clearType in interface ISrvMonOptionDescription

See Also:

ISrvMonOptionDescription.setType(SrvMonOptionType)

getLongFormFieldId

public static final int getLongFormFieldId()

Get the field id for 'longForm'

This method can be used to set field interests.

See Also:

getLongForm()

setLongForm

public final void setLongForm(String val)

Description copied from interface: ISrvMonOptionDescription

Sets the value of 'longForm'

Field Description

The long form of the command. e.g. 'option' for -option

Specified by:

setLongForm in interface ISrvMonOptionDescription

Parameters:

val - The value to set.

getLongForm

public final String getLongForm()

Description copied from interface: ISrvMonOptionDescription

Gets the value of 'longForm'

Field Description

The long form of the command. e.g. 'option' for -option

Specified by:

getLongForm in interface ISrvMonOptionDescription

Returns:

The long form of the command. e.g. 'option' for -option

lendLongForm

public final void lendLongForm(XString val)

Description copied from interface: ISrvMonOptionDescription

Sets the value of 'longForm'

Field Description

The long form of the command. e.g. 'option' for -option

Specified by:

lendLongForm in interface ISrvMonOptionDescription

Parameters:

val - The value to set.

setLongFormFrom

public final void setLongFormFrom(long val)

Description copied from interface: ISrvMonOptionDescription

Sets the value of this String field to the given numeric value.

Field Description

The long form of the command. e.g. 'option' for -option

NOTE:
This is the same as calling ISrvMonOptionDescription.setLongForm(String). with Long.valueOf(val).toString(), except that using this method is a zero garbage operation for Xbuf encoding.

Specified by:

setLongFormFrom in interface ISrvMonOptionDescription

getLongFormTo

public final <T extends XString> T getLongFormTo(XString.Factory<T> factory)

Description copied from interface: ISrvMonOptionDescription

Copies the value of this String field into a new XString from the given factory.

Field Description

The long form of the command. e.g. 'option' for -option

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;

Specified by:

getLongFormTo in interface ISrvMonOptionDescription

Parameters:

factory - The factory from which to get the XString to copy into and return

Returns:

a new XString from the provided factory if this field is set or null.

setLongFormFrom

public final void setLongFormFrom(XString val)

Description copied from interface: ISrvMonOptionDescription

Copies the provided XString value into this object's 'longForm'.

Field Description

The long form of the command. e.g. 'option' for -option

NOTE:
This is a Zero Garbage operation for XBuf encoded objects. Additionally, this setter can be more efficient than ISrvMonOptionDescription.setLongForm(String) because it avoids encoding the value into a String if the given XString is already encoded.

Specified by:

setLongFormFrom in interface ISrvMonOptionDescription

getLongFormTo

public final void getLongFormTo(XString val)

Description copied from interface: ISrvMonOptionDescription

Copies the value of 'longForm' into the provided XString.

Field Description

The long form of the command. e.g. 'option' for -option

NOTE:
This is a Zero Garbage operation for XBuf encoded objects. Additionally, this getter can be more efficient than ISrvMonOptionDescription.getLongForm() bec because it can avoid decoding the value into an String.

Specified by:

getLongFormTo in interface ISrvMonOptionDescription

See Also:

ISrvMonOptionDescription.getLongForm()

getLongFormUnsafe

public final XString getLongFormUnsafe()

Description copied from interface: ISrvMonOptionDescription

Gets the raw value of 'longForm'.

Field Description

The long form of the command. e.g. 'option' for -option

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.

Specified by:

getLongFormUnsafe in interface ISrvMonOptionDescription

Returns:

the field's raw value

See Also:

ISrvMonOptionDescription.getLongForm()

setLongFormFrom

public final void setLongFormFrom(com.neeve.xbuf.XbufStringField val)

getLongFormField

public final com.neeve.xbuf.XbufStringField getLongFormField()

hasLongForm

public final boolean hasLongForm()

Description copied from interface: ISrvMonOptionDescription

Checks for the presence of 'longForm'

Field Description

The long form of the command. e.g. 'option' for -option

Specified by:

hasLongForm in interface ISrvMonOptionDescription

See Also:

ISrvMonOptionDescription.getLongForm()

clearLongForm

public final void clearLongForm()

Description copied from interface: ISrvMonOptionDescription

Clears the value of 'longForm'

Field Description

The long form of the command. e.g. 'option' for -option

Specified by:

clearLongForm in interface ISrvMonOptionDescription

See Also:

ISrvMonOptionDescription.setLongForm(String)

getDefaultValueFieldId

public static final int getDefaultValueFieldId()

Get the field id for 'defaultValue'

This method can be used to set field interests.

See Also:

getDefaultValue()

setDefaultValue

public final void setDefaultValue(String val)

Description copied from interface: ISrvMonOptionDescription

Sets the value of 'defaultValue'

Field Description

The default value for an option when not specified ... or not set if no default

Specified by:

setDefaultValue in interface ISrvMonOptionDescription

Parameters:

val - The value to set.

getDefaultValue

public final String getDefaultValue()

Description copied from interface: ISrvMonOptionDescription

Gets the value of 'defaultValue'

Field Description

The default value for an option when not specified ... or not set if no default

Specified by:

getDefaultValue in interface ISrvMonOptionDescription

Returns:

The default value for an option when not specified ... or not set if no default

lendDefaultValue

public final void lendDefaultValue(XString val)

Description copied from interface: ISrvMonOptionDescription

Sets the value of 'defaultValue'

Field Description

The default value for an option when not specified ... or not set if no default

Specified by:

lendDefaultValue in interface ISrvMonOptionDescription

Parameters:

val - The value to set.

setDefaultValueFrom

public final void setDefaultValueFrom(long val)

Description copied from interface: ISrvMonOptionDescription

Sets the value of this String field to the given numeric value.

Field Description

The default value for an option when not specified ... or not set if no default

NOTE:
This is the same as calling ISrvMonOptionDescription.setDefaultValue(String). with Long.valueOf(val).toString(), except that using this method is a zero garbage operation for Xbuf encoding.

Specified by:

setDefaultValueFrom in interface ISrvMonOptionDescription

getDefaultValueTo

public final <T extends XString> T getDefaultValueTo(XString.Factory<T> factory)

Description copied from interface: ISrvMonOptionDescription

Copies the value of this String field into a new XString from the given factory.

Field Description

The default value for an option when not specified ... or not set if no default

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;

Specified by:

getDefaultValueTo in interface ISrvMonOptionDescription

Parameters:

factory - The factory from which to get the XString to copy into and return

Returns:

a new XString from the provided factory if this field is set or null.

setDefaultValueFrom

public final void setDefaultValueFrom(XString val)

Description copied from interface: ISrvMonOptionDescription

Copies the provided XString value into this object's 'defaultValue'.

Field Description

The default value for an option when not specified ... or not set if no default

NOTE:
This is a Zero Garbage operation for XBuf encoded objects. Additionally, this setter can be more efficient than ISrvMonOptionDescription.setDefaultValue(String) because it avoids encoding the value into a String if the given XString is already encoded.

Specified by:

setDefaultValueFrom in interface ISrvMonOptionDescription

getDefaultValueTo

public final void getDefaultValueTo(XString val)

Description copied from interface: ISrvMonOptionDescription

Copies the value of 'defaultValue' into the provided XString.

Field Description

The default value for an option when not specified ... or not set if no default

NOTE:
This is a Zero Garbage operation for XBuf encoded objects. Additionally, this getter can be more efficient than ISrvMonOptionDescription.getDefaultValue() bec because it can avoid decoding the value into an String.

Specified by:

getDefaultValueTo in interface ISrvMonOptionDescription

See Also:

ISrvMonOptionDescription.getDefaultValue()

getDefaultValueUnsafe

public final XString getDefaultValueUnsafe()

Description copied from interface: ISrvMonOptionDescription

Gets the raw value of 'defaultValue'.

Field Description

The default value for an option when not specified ... or not set if no default

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.

Specified by:

getDefaultValueUnsafe in interface ISrvMonOptionDescription

Returns:

the field's raw value

See Also:

ISrvMonOptionDescription.getDefaultValue()

setDefaultValueFrom

public final void setDefaultValueFrom(com.neeve.xbuf.XbufStringField val)

getDefaultValueField

public final com.neeve.xbuf.XbufStringField getDefaultValueField()

hasDefaultValue

public final boolean hasDefaultValue()

Description copied from interface: ISrvMonOptionDescription

Checks for the presence of 'defaultValue'

Field Description

The default value for an option when not specified ... or not set if no default

Specified by:

hasDefaultValue in interface ISrvMonOptionDescription

See Also:

ISrvMonOptionDescription.getDefaultValue()

clearDefaultValue

public final void clearDefaultValue()

Description copied from interface: ISrvMonOptionDescription

Clears the value of 'defaultValue'

Field Description

The default value for an option when not specified ... or not set if no default

Specified by:

clearDefaultValue in interface ISrvMonOptionDescription

See Also:

ISrvMonOptionDescription.setDefaultValue(String)

getValidValuesFieldId

public static final int getValidValuesFieldId()

Get the field id for 'validValues'

This method can be used to set field interests.

See Also:

getValidValues()

createValidValuesFieldBuffer

public static final 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.

For example the following would result in a bulk transfer from this message

 XbufRepeatedStringFieldBuffer preallocated = SrvMonOptionDescription.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.

Parameters:

initialBufferLength - the initial size of the underlying backing buffer.

isNative - Whether the backing buffer should be a native or heap buffer.

setValidValues

public final void setValidValues(String[] val)

Description copied from interface: ISrvMonOptionDescription

Sets the value of 'validValues'

Field Description

When set restricts the set of valid values for the command

Specified by:

setValidValues in interface ISrvMonOptionDescription

Parameters:

val - The value to set.

setValidValuesFrom

public final void setValidValuesFrom(XIterator<String> val)

Description copied from interface: ISrvMonOptionDescription

Sets the value of 'validValues' using the values from the provided iterator.

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.

Field Description

When set restricts the set of valid values for the command

NOTE:
Passing a null or empty iterator has the same affect as calling ISrvMonOptionDescription.setValidValues(String[]) with a value of null.

Specified by:

setValidValuesFrom in interface ISrvMonOptionDescription

Parameters:

val - the values to set.

addValidValues

public final void addValidValues(String val)

Description copied from interface: ISrvMonOptionDescription

Adds the provided value to the list of 'validValues' values.

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.

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.

Field Description

When set restricts the set of valid values for the command

Specified by:

addValidValues in interface ISrvMonOptionDescription

Parameters:

val - the value to add.

getValidValues

public final String[] getValidValues()

Description copied from interface: ISrvMonOptionDescription

Gets the value of 'validValues'

If the field is not set this method will return null.

Field Description

When set restricts the set of valid values for the command

Specified by:

getValidValues in interface ISrvMonOptionDescription

Returns:

When set restricts the set of valid values for the command If the field is not set this method will return null.

getValidValuesEmptyIfNull

public final String[] getValidValuesEmptyIfNull()

Description copied from interface: ISrvMonOptionDescription

Gets the value of 'validValues' or an empty array if the value is null or not set.

Field Description

When set restricts the set of valid values for the command

Specified by:

getValidValuesEmptyIfNull in interface ISrvMonOptionDescription

Returns:

When set restricts the set of valid values for the command or an empty array if null if not set.

See Also:

ISrvMonOptionDescription.getValidValues()

getValidValuesIterator

public final XStringIterator getValidValuesIterator()

Description copied from interface: ISrvMonOptionDescription

Gets the value of 'validValues' as iterator of values.

This 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.

Field Description

When set restricts the set of valid values for the command

Specified by:

getValidValuesIterator in interface ISrvMonOptionDescription

Returns:

An XStringIterator containing this field values.

clearValidValues

public final void clearValidValues()

Description copied from interface: ISrvMonOptionDescription

Clears the value of 'validValues'

Field Description

When set restricts the set of valid values for the command

Specified by:

clearValidValues in interface ISrvMonOptionDescription

See Also:

ISrvMonOptionDescription.setValidValues(String[])

getDescriptionFieldId

public static final int getDescriptionFieldId()

Get the field id for 'description'

This method can be used to set field interests.

See Also:

getDescription()

setDescription

public final void setDescription(String val)

Description copied from interface: ISrvMonOptionDescription

Sets the value of 'description'

Field Description

The command description

Specified by:

setDescription in interface ISrvMonOptionDescription

Parameters:

val - The value to set.

getDescription

public final String getDescription()

Description copied from interface: ISrvMonOptionDescription

Gets the value of 'description'

Field Description

The command description

Specified by:

getDescription in interface ISrvMonOptionDescription

Returns:

The command description

lendDescription

public final void lendDescription(XString val)

Description copied from interface: ISrvMonOptionDescription

Sets the value of 'description'

Field Description

The command description

Specified by:

lendDescription in interface ISrvMonOptionDescription

Parameters:

val - The value to set.

setDescriptionFrom

public final void setDescriptionFrom(long val)

Description copied from interface: ISrvMonOptionDescription

Sets the value of this String field to the given numeric value.

Field Description

The command description

NOTE:
This is the same as calling ISrvMonOptionDescription.setDescription(String). with Long.valueOf(val).toString(), except that using this method is a zero garbage operation for Xbuf encoding.

Specified by:

setDescriptionFrom in interface ISrvMonOptionDescription

getDescriptionTo

public final <T extends XString> T getDescriptionTo(XString.Factory<T> factory)

Description copied from interface: ISrvMonOptionDescription

Copies the value of this String field into a new XString from the given factory.

Field Description

The command description

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;

Specified by:

getDescriptionTo in interface ISrvMonOptionDescription

Parameters:

factory - The factory from which to get the XString to copy into and return

Returns:

a new XString from the provided factory if this field is set or null.

setDescriptionFrom

public final void setDescriptionFrom(XString val)

Description copied from interface: ISrvMonOptionDescription

Copies the provided XString value into this object's 'description'.

Field Description

The command description

NOTE:
This is a Zero Garbage operation for XBuf encoded objects. Additionally, this setter can be more efficient than ISrvMonOptionDescription.setDescription(String) because it avoids encoding the value into a String if the given XString is already encoded.

Specified by:

setDescriptionFrom in interface ISrvMonOptionDescription

getDescriptionTo

public final void getDescriptionTo(XString val)

Description copied from interface: ISrvMonOptionDescription

Copies the value of 'description' into the provided XString.

Field Description

The command description

NOTE:
This is a Zero Garbage operation for XBuf encoded objects. Additionally, this getter can be more efficient than ISrvMonOptionDescription.getDescription() bec because it can avoid decoding the value into an String.

Specified by:

getDescriptionTo in interface ISrvMonOptionDescription

See Also:

ISrvMonOptionDescription.getDescription()

getDescriptionUnsafe

public final XString getDescriptionUnsafe()

Description copied from interface: ISrvMonOptionDescription

Gets the raw value of 'description'.

Field Description

The command description

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.

Specified by:

getDescriptionUnsafe in interface ISrvMonOptionDescription

Returns:

the field's raw value

See Also:

ISrvMonOptionDescription.getDescription()

setDescriptionFrom

public final void setDescriptionFrom(com.neeve.xbuf.XbufStringField val)

getDescriptionField

public final com.neeve.xbuf.XbufStringField getDescriptionField()

hasDescription

public final boolean hasDescription()

Description copied from interface: ISrvMonOptionDescription

Checks for the presence of 'description'

Field Description

The command description

Specified by:

hasDescription in interface ISrvMonOptionDescription

See Also:

ISrvMonOptionDescription.getDescription()

clearDescription

public final void clearDescription()

Description copied from interface: ISrvMonOptionDescription

Clears the value of 'description'

Field Description

The command description

Specified by:

clearDescription in interface ISrvMonOptionDescription

See Also:

ISrvMonOptionDescription.setDescription(String)

getDisplayNameFieldId

public static final int getDisplayNameFieldId()

Get the field id for 'displayName'

This method can be used to set field interests.

See Also:

getDisplayName()

setDisplayName

public final void setDisplayName(String val)

Description copied from interface: ISrvMonOptionDescription

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. The display name is for display purposes only and cannot be used to invoke a command.

Specified by:

setDisplayName in interface ISrvMonOptionDescription

Parameters:

val - The value to set.

getDisplayName

public final String getDisplayName()

Description copied from interface: ISrvMonOptionDescription

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. The display name is for display purposes only and cannot be used to invoke a command.

Specified by:

getDisplayName in interface ISrvMonOptionDescription

Returns:

The display name for the argument

lendDisplayName

public final void lendDisplayName(XString val)

Description copied from interface: ISrvMonOptionDescription

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. The display name is for display purposes only and cannot be used to invoke a command.

Specified by:

lendDisplayName in interface ISrvMonOptionDescription

Parameters:

val - The value to set.

setDisplayNameFrom

public final void setDisplayNameFrom(long val)

Description copied from interface: ISrvMonOptionDescription

Sets the value of this String field to the given numeric value.

Field Description

The display name for the argument

If 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 ISrvMonOptionDescription.setDisplayName(String). with Long.valueOf(val).toString(), except that using this method is a zero garbage operation for Xbuf encoding.

Specified by:

setDisplayNameFrom in interface ISrvMonOptionDescription

getDisplayNameTo

public final <T extends XString> T getDisplayNameTo(XString.Factory<T> factory)

Description copied from interface: ISrvMonOptionDescription

Copies the value of this String field into a new XString from the given factory.

Field Description

The display name for the argument

If 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;

Specified by:

getDisplayNameTo in interface ISrvMonOptionDescription

Parameters:

factory - The factory from which to get the XString to copy into and return

Returns:

a new XString from the provided factory if this field is set or null.

setDisplayNameFrom

public final void setDisplayNameFrom(XString val)

Description copied from interface: ISrvMonOptionDescription

Copies the provided XString value into this object's 'displayName'.

Field Description

The display name for the argument

If 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 ISrvMonOptionDescription.setDisplayName(String) because it avoids encoding the value into a String if the given XString is already encoded.

Specified by:

setDisplayNameFrom in interface ISrvMonOptionDescription

getDisplayNameTo

public final void getDisplayNameTo(XString val)

Description copied from interface: ISrvMonOptionDescription

Copies the value of 'displayName' into the provided XString.

Field Description

The display name for the argument

If 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 ISrvMonOptionDescription.getDisplayName() bec because it can avoid decoding the value into an String.

Specified by:

getDisplayNameTo in interface ISrvMonOptionDescription

See Also:

ISrvMonOptionDescription.getDisplayName()

getDisplayNameUnsafe

public final XString getDisplayNameUnsafe()

Description copied from interface: ISrvMonOptionDescription

Gets the raw 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. 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.

Specified by:

getDisplayNameUnsafe in interface ISrvMonOptionDescription

Returns:

the field's raw value

See Also:

ISrvMonOptionDescription.getDisplayName()

setDisplayNameFrom

public final void setDisplayNameFrom(com.neeve.xbuf.XbufStringField val)

getDisplayNameField

public final com.neeve.xbuf.XbufStringField getDisplayNameField()

hasDisplayName

public final boolean hasDisplayName()

Description copied from interface: ISrvMonOptionDescription

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. The display name is for display purposes only and cannot be used to invoke a command.

Specified by:

hasDisplayName in interface ISrvMonOptionDescription

See Also:

ISrvMonOptionDescription.getDisplayName()

clearDisplayName

public final void clearDisplayName()

Description copied from interface: ISrvMonOptionDescription

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. The display name is for display purposes only and cannot be used to invoke a command.

Specified by:

clearDisplayName in interface ISrvMonOptionDescription

See Also:

ISrvMonOptionDescription.setDisplayName(String)

isDirty

public final boolean isDirty()

createSchema

public static final com.neeve.xbuf.XbufSchema createSchema()

serializeToByteArray

public final byte[] serializeToByteArray()

serializeToByteBuffer

public final ByteBuffer serializeToByteBuffer()

serializeToIOBuffer

public final com.neeve.io.IOBuffer serializeToIOBuffer(boolean useNative)

isBufferBacked

public final boolean isBufferBacked()

getSerializeToNativeLength

public final int getSerializeToNativeLength()

serializeToNative

public final int serializeToNative(long address,
                                   int addressOffset)

deserializeFromIOElasticBuffer

public final SrvMonOptionDescription deserializeFromIOElasticBuffer(com.neeve.io.IOElasticBuffer buffer,
                                                                    int offset,
                                                                    int length,
                                                                    com.neeve.xbuf.XbufDesyncPolicy desyncPolicy)

deserializeFromIOElasticBuffer

public final SrvMonOptionDescription deserializeFromIOElasticBuffer(com.neeve.io.IOElasticBuffer buffer,
                                                                    int offset,
                                                                    int length)

deserializeFromByteArray

public final SrvMonOptionDescription deserializeFromByteArray(byte[] array,
                                                              com.neeve.xbuf.XbufDesyncPolicy desyncPolicy)

deserializeFromByteArray

public final SrvMonOptionDescription deserializeFromByteArray(byte[] array)

deserializeFromByteBuffer

public final SrvMonOptionDescription deserializeFromByteBuffer(ByteBuffer buffer,
                                                               com.neeve.xbuf.XbufDesyncPolicy desyncPolicy)

deserializeFromByteBuffer

public final SrvMonOptionDescription deserializeFromByteBuffer(ByteBuffer buffer)

deserializeFromNative

public final SrvMonOptionDescription deserializeFromNative(long address,
                                                           int offset,
                                                           int length,
                                                           com.neeve.xbuf.XbufDesyncPolicy desyncPolicy)

deserializeFromNative

public final SrvMonOptionDescription deserializeFromNative(long address,
                                                           int offset,
                                                           int length)

sync

public final void sync()

desync

public final int desync(PktBuffer buffer,
                        int pos,
                        boolean frameOnly)

Specified by:

desync in interface com.neeve.xbuf.IXbufDesyncer

init

public final SrvMonOptionDescription init()

Description copied from interface: UtlPool.Item

Initialize an item.

This 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.

Specified by:

init in interface UtlPool.Item<SrvMonOptionDescription>

Returns:

Return 'this' object for method invocation chaining.

setPool

public final SrvMonOptionDescription setPool(UtlPool<SrvMonOptionDescription> pool)

Description copied from interface: UtlPool.Item

Set a pool item's pool.

This 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.

Specified by:

setPool in interface UtlPool.Item<SrvMonOptionDescription>

Returns:

Return 'this' object for method invocation chaining.

getPool

public final UtlPool<SrvMonOptionDescription> getPool()

Description copied from interface: UtlPool.Item

Get a pool item's pool.

This method should return the pool set using UtlPool.Item.setPool(com.neeve.util.UtlPool)

Specified by:

getPool in interface UtlPool.Item<SrvMonOptionDescription>

Returns:

the pool set using UtlPool.Item.setPool(com.neeve.util.UtlPool)

isReferenceCounted

public final boolean isReferenceCounted()

acquire

public final SrvMonOptionDescription acquire()

getOwnerCount

public final int getOwnerCount()

dispose

public final void dispose()

clone

public final Object clone()

Creates a clone of this object.

This method differs from the copy() method in that:

• For protobuf and xbuf generated objects pass-through fields are not preserved. Pass through fields are fields not defined by ADM model that generated this class, but may exist in the backing buffer or protobuf message for the object.
• The copy method may replace empty arrays with a null value whereas this method preserves empty array fields.

Overrides:

clone in class Object

copy

public final SrvMonOptionDescription copy()

Creates a copy of this SrvMonOptionDescription.

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 SrvMonOptionDescription's embedded entity fields.

The returned copy will be writeable even if this SrvMonOptionDescription is read only.

Xbuf Pass-through Fields

When backed by a buffer, this operation copies the underlying buffer which means that if the message was deserialized from with unrecognized fields, such fields will be preserved in the copy as well.

Returns:

The copied entity.

copyInto

public final void copyInto(SrvMonOptionDescription copy)

Copies the contents of this SrvMonOptionDescription into the target.

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 SrvMonOptionDescription's embedded entity fields.

The returned copy will be writeable even if this SrvMonOptionDescription is read only.

Xbuf Pass-through Fields

When backed by a buffer, this operation copies the underlying buffer which means that if the message was deserialized from with unrecognized fields, such fields will be preserved in the copy as well.

Parameters:

copy - The target into which to copy.

isValid

public final boolean isValid()

Description copied from interface: IRogValidatable

Tests if this object has any validation errors.

Specified by:

isValid in interface IRogValidatable

getValidationErrors

public final void getValidationErrors(List<XString> results,
                                      String errorPrefix)

Description copied from interface: IRogValidatable

Collects validation errors into the provided list. It is illegal for the caller to hold onto the List of XStrings beyond the lifespace of this object.

Specified by:

getValidationErrors in interface IRogValidatable

Parameters:

results - 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.

toString

public final String toString()

Overrides:

toString in class Object