com.neeve.server.mon.cnc

Class SrvMonCommandDescription.Serializer

java.lang.Object

com.neeve.server.mon.cnc.SrvMonCommandDescription.Serializer

All Implemented Interfaces:

AdmRuntime.BufferSizer, UtlPool.Item<SrvMonCommandDescription.Serializer>

Enclosing class:

SrvMonCommandDescription

public static final class SrvMonCommandDescription.Serializer
extends Object
implements UtlPool.Item<SrvMonCommandDescription.Serializer>, AdmRuntime.BufferSizer

The serializer

Method Summary

Modifier and Type	Method and Description
SrvMonCommandDescription.Serializer	additionalArgs(boolean val)
SrvMonCommandDescription.Serializer	additionalArgsDescription(byte[] val)
SrvMonCommandDescription.Serializer	additionalArgsDescription(byte[] val, int offset, int len)
SrvMonCommandDescription.Serializer	additionalArgsDescription(IOBuffer val, int offset, int len)
SrvMonCommandDescription.Serializer	additionalArgsDescription(String val)
SrvMonCommandDescription.Serializer	additionalArgsDescription(XString val)
SrvMonCommandDescription.Serializer	additionalArgsDescription(XStringDeserializer val)
SrvMonCommandDescription.Serializer	additionalArgsDisplayName(byte[] val)
SrvMonCommandDescription.Serializer	additionalArgsDisplayName(byte[] val, int offset, int len)
SrvMonCommandDescription.Serializer	additionalArgsDisplayName(IOBuffer val, int offset, int len)
SrvMonCommandDescription.Serializer	additionalArgsDisplayName(String val)
SrvMonCommandDescription.Serializer	additionalArgsDisplayName(XString val)
SrvMonCommandDescription.Serializer	additionalArgsDisplayName(XStringDeserializer val)
SrvMonCommandDescription.Serializer	aliases(byte[] val)
SrvMonCommandDescription.Serializer	aliases(byte[] val, int offset, int len)
SrvMonCommandDescription.Serializer	aliases(IOBuffer val, int offset, int len)
SrvMonCommandDescription.Serializer	aliases(String val)
SrvMonCommandDescription.Serializer	aliases(XString val)
SrvMonCommandDescription.Serializer	aliases(XStringDeserializer val)
SrvMonCommandDescription.Serializer	aliases(XStringIterator val)
SrvMonCommandDescription.Serializer	arguments(IOBuffer val, int offset, int len)
SrvMonCommandDescription.Serializer	arguments(long addr, int offset, int len)
SrvMonCommandDescription.Serializer	arguments(SrvMonArgumentDescription.Deserializer val)
SrvMonCommandDescription.Serializer	arguments(SrvMonArgumentDescription.Serializer val)
SrvMonCommandDescription.Serializer	arguments(SrvMonArgumentDescription val)
static SrvMonCommandDescription.Serializer	create()
static SrvMonCommandDescription.Serializer	create(boolean pvt)
SrvMonCommandDescription.Serializer	description(byte[] val)
SrvMonCommandDescription.Serializer	description(byte[] val, int offset, int len)
SrvMonCommandDescription.Serializer	description(IOBuffer val, int offset, int len)
SrvMonCommandDescription.Serializer	description(String val)
SrvMonCommandDescription.Serializer	description(XString val)
SrvMonCommandDescription.Serializer	description(XStringDeserializer val)
SrvMonCommandDescription.Serializer	displayName(byte[] val)
SrvMonCommandDescription.Serializer	displayName(byte[] val, int offset, int len)
SrvMonCommandDescription.Serializer	displayName(IOBuffer val, int offset, int len)
SrvMonCommandDescription.Serializer	displayName(String val)
SrvMonCommandDescription.Serializer	displayName(XString val)
SrvMonCommandDescription.Serializer	displayName(XStringDeserializer val)
int	done()
long	ensureCapacity(long addr, int capacity) Method invoked by the serializer to ensure there is enough space in the target buffer to accommodate a field being serialized
UtlPool<SrvMonCommandDescription.Serializer>	getPool() Get a pool item's pool.
int	getSerializedLength()
void	getTo(IOBuffer buffer, int offset)
int	getTo(long addr, int offset)
SrvMonCommandDescription.Serializer	group(byte[] val)
SrvMonCommandDescription.Serializer	group(byte[] val, int offset, int len)
SrvMonCommandDescription.Serializer	group(IOBuffer val, int offset, int len)
SrvMonCommandDescription.Serializer	group(String val)
SrvMonCommandDescription.Serializer	group(XString val)
SrvMonCommandDescription.Serializer	group(XStringDeserializer val)
SrvMonCommandDescription.Serializer	group(XStringIterator val)
boolean	hasSizer()
SrvMonCommandDescription.Serializer	hidden(boolean val)
SrvMonCommandDescription.Serializer	init() Initialize an item.
SrvMonCommandDescription.Serializer	init(IOBuffer buffer)
SrvMonCommandDescription.Serializer	init(IOBuffer buffer, int len)
SrvMonCommandDescription.Serializer	init(long addr, int len)
boolean	isInitialized()
SrvMonCommandDescription.Serializer	name(byte[] val)
SrvMonCommandDescription.Serializer	name(byte[] val, int offset, int len)
SrvMonCommandDescription.Serializer	name(IOBuffer val, int offset, int len)
SrvMonCommandDescription.Serializer	name(String val)
SrvMonCommandDescription.Serializer	name(XString val)
SrvMonCommandDescription.Serializer	name(XStringDeserializer val)
SrvMonCommandDescription.Serializer	options(IOBuffer val, int offset, int len)
SrvMonCommandDescription.Serializer	options(long addr, int offset, int len)
SrvMonCommandDescription.Serializer	options(SrvMonOptionDescription.Deserializer val)
SrvMonCommandDescription.Serializer	options(SrvMonOptionDescription.Serializer val)
SrvMonCommandDescription.Serializer	options(SrvMonOptionDescription val)
void	putFrom(IOBuffer buffer, int offset, int len)
void	putFrom(long addr, int offset, int len)
SrvMonCommandDescription.Serializer	returnType(SrvMonReturnType val)
SrvMonCommandDescription.Serializer	setPool(UtlPool<SrvMonCommandDescription.Serializer> pool) Set a pool item's pool.
SrvMonCommandDescription.Serializer	setSizer(AdmRuntime.BufferSizer sizer)

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

create

public static final SrvMonCommandDescription.Serializer create(boolean pvt)

create

public static final SrvMonCommandDescription.Serializer create()

init

public final SrvMonCommandDescription.Serializer init(long addr,
                                                      int len)

init

public final SrvMonCommandDescription.Serializer init(IOBuffer buffer,
                                                      int len)

init

public final SrvMonCommandDescription.Serializer init(IOBuffer buffer)

setSizer

public final SrvMonCommandDescription.Serializer setSizer(AdmRuntime.BufferSizer sizer)

hasSizer

public final boolean hasSizer()

isInitialized

public final boolean isInitialized()

getSerializedLength

public final int getSerializedLength()

getTo

public final void getTo(IOBuffer buffer,
                        int offset)

getTo

public final int getTo(long addr,
                       int offset)

putFrom

public final void putFrom(IOBuffer buffer,
                          int offset,
                          int len)

putFrom

public final void putFrom(long addr,
                          int offset,
                          int len)

additionalArgs

public final SrvMonCommandDescription.Serializer additionalArgs(boolean val)

returnType

public final SrvMonCommandDescription.Serializer returnType(SrvMonReturnType val)

hidden

public final SrvMonCommandDescription.Serializer hidden(boolean val)

name

public final SrvMonCommandDescription.Serializer name(String val)

name

public final SrvMonCommandDescription.Serializer name(XString val)

name

public final SrvMonCommandDescription.Serializer name(byte[] val,
                                                      int offset,
                                                      int len)

name

public final SrvMonCommandDescription.Serializer name(byte[] val)

name

public final SrvMonCommandDescription.Serializer name(XStringDeserializer val)

name

public final SrvMonCommandDescription.Serializer name(IOBuffer val,
                                                      int offset,
                                                      int len)

aliases

public final SrvMonCommandDescription.Serializer aliases(String val)

aliases

public final SrvMonCommandDescription.Serializer aliases(XString val)

aliases

public final SrvMonCommandDescription.Serializer aliases(byte[] val,
                                                         int offset,
                                                         int len)

aliases

public final SrvMonCommandDescription.Serializer aliases(byte[] val)

aliases

public final SrvMonCommandDescription.Serializer aliases(XStringDeserializer val)

aliases

public final SrvMonCommandDescription.Serializer aliases(IOBuffer val,
                                                         int offset,
                                                         int len)

aliases

public final SrvMonCommandDescription.Serializer aliases(XStringIterator val)

description

public final SrvMonCommandDescription.Serializer description(String val)

description

public final SrvMonCommandDescription.Serializer description(XString val)

description

public final SrvMonCommandDescription.Serializer description(byte[] val,
                                                             int offset,
                                                             int len)

description

public final SrvMonCommandDescription.Serializer description(byte[] val)

description

public final SrvMonCommandDescription.Serializer description(XStringDeserializer val)

description

public final SrvMonCommandDescription.Serializer description(IOBuffer val,
                                                             int offset,
                                                             int len)

arguments

public final SrvMonCommandDescription.Serializer arguments(SrvMonArgumentDescription val)

arguments

public final SrvMonCommandDescription.Serializer arguments(SrvMonArgumentDescription.Serializer val)

arguments

public final SrvMonCommandDescription.Serializer arguments(SrvMonArgumentDescription.Deserializer val)

arguments

public final SrvMonCommandDescription.Serializer arguments(IOBuffer val,
                                                           int offset,
                                                           int len)

arguments

public final SrvMonCommandDescription.Serializer arguments(long addr,
                                                           int offset,
                                                           int len)

options

public final SrvMonCommandDescription.Serializer options(SrvMonOptionDescription val)

options

public final SrvMonCommandDescription.Serializer options(SrvMonOptionDescription.Serializer val)

options

public final SrvMonCommandDescription.Serializer options(SrvMonOptionDescription.Deserializer val)

options

public final SrvMonCommandDescription.Serializer options(IOBuffer val,
                                                         int offset,
                                                         int len)

options

public final SrvMonCommandDescription.Serializer options(long addr,
                                                         int offset,
                                                         int len)

displayName

public final SrvMonCommandDescription.Serializer displayName(String val)

displayName

public final SrvMonCommandDescription.Serializer displayName(XString val)

displayName

public final SrvMonCommandDescription.Serializer displayName(byte[] val,
                                                             int offset,
                                                             int len)

displayName

public final SrvMonCommandDescription.Serializer displayName(byte[] val)

displayName

public final SrvMonCommandDescription.Serializer displayName(XStringDeserializer val)

displayName

public final SrvMonCommandDescription.Serializer displayName(IOBuffer val,
                                                             int offset,
                                                             int len)

additionalArgsDescription

public final SrvMonCommandDescription.Serializer additionalArgsDescription(String val)

additionalArgsDescription

public final SrvMonCommandDescription.Serializer additionalArgsDescription(XString val)

additionalArgsDescription

public final SrvMonCommandDescription.Serializer additionalArgsDescription(byte[] val,
                                                                           int offset,
                                                                           int len)

additionalArgsDescription

public final SrvMonCommandDescription.Serializer additionalArgsDescription(byte[] val)

additionalArgsDescription

public final SrvMonCommandDescription.Serializer additionalArgsDescription(XStringDeserializer val)

additionalArgsDescription

public final SrvMonCommandDescription.Serializer additionalArgsDescription(IOBuffer val,
                                                                           int offset,
                                                                           int len)

additionalArgsDisplayName

public final SrvMonCommandDescription.Serializer additionalArgsDisplayName(String val)

additionalArgsDisplayName

public final SrvMonCommandDescription.Serializer additionalArgsDisplayName(XString val)

additionalArgsDisplayName

public final SrvMonCommandDescription.Serializer additionalArgsDisplayName(byte[] val,
                                                                           int offset,
                                                                           int len)

additionalArgsDisplayName

public final SrvMonCommandDescription.Serializer additionalArgsDisplayName(byte[] val)

additionalArgsDisplayName

public final SrvMonCommandDescription.Serializer additionalArgsDisplayName(XStringDeserializer val)

additionalArgsDisplayName

public final SrvMonCommandDescription.Serializer additionalArgsDisplayName(IOBuffer val,
                                                                           int offset,
                                                                           int len)

group

public final SrvMonCommandDescription.Serializer group(String val)

group

public final SrvMonCommandDescription.Serializer group(XString val)

group

public final SrvMonCommandDescription.Serializer group(byte[] val,
                                                       int offset,
                                                       int len)

group

public final SrvMonCommandDescription.Serializer group(byte[] val)

group

public final SrvMonCommandDescription.Serializer group(XStringDeserializer val)

group

public final SrvMonCommandDescription.Serializer group(IOBuffer val,
                                                       int offset,
                                                       int len)

group

public final SrvMonCommandDescription.Serializer group(XStringIterator val)

done

public final int done()

init

public final SrvMonCommandDescription.Serializer 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<SrvMonCommandDescription.Serializer>

Returns:

Return 'this' object for method invocation chaining.

setPool

public final SrvMonCommandDescription.Serializer setPool(UtlPool<SrvMonCommandDescription.Serializer> 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<SrvMonCommandDescription.Serializer>

Returns:

Return 'this' object for method invocation chaining.

getPool

public final UtlPool<SrvMonCommandDescription.Serializer> 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<T>)

Specified by:

getPool in interface UtlPool.Item<SrvMonCommandDescription.Serializer>

Returns:

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

ensureCapacity

public final long ensureCapacity(long addr,
                                 int capacity)

Description copied from interface: AdmRuntime.BufferSizer

Method invoked by the serializer to ensure there is enough space in the target buffer to accommodate a field being serialized

Specified by:

ensureCapacity in interface AdmRuntime.BufferSizer

Parameters:

addr - The native address of the target buffer

capacity - The required capacity of the buffer

Returns:

long Returns the address of the buffer that has at least the requested capacity. This could be the same buffer that is passed in if the buffer has the capacity or a reallocated buffer if the passed in buffer did not have the requested capacity and needed to be reallocated

This method is invoked by a serializer each time it serializes a field or part of a field to the target buffer to ensure that the target buffer has the desired capacity to hold the data being added.