com.neeve.server.mon.cnc

Class SrvMonOptionDescription.Serializer

java.lang.Object

com.neeve.server.mon.cnc.SrvMonOptionDescription.Serializer

All Implemented Interfaces:

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

Enclosing class:

SrvMonOptionDescription

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

The serializer

Method Summary

Modifier and Type	Method and Description
static SrvMonOptionDescription.Serializer	create()
static SrvMonOptionDescription.Serializer	create(boolean pvt)
SrvMonOptionDescription.Serializer	defaultValue(byte[] val)
SrvMonOptionDescription.Serializer	defaultValue(byte[] val, int offset, int len)
SrvMonOptionDescription.Serializer	defaultValue(IOBuffer val, int offset, int len)
SrvMonOptionDescription.Serializer	defaultValue(String val)
SrvMonOptionDescription.Serializer	defaultValue(XString val)
SrvMonOptionDescription.Serializer	defaultValue(XStringDeserializer val)
SrvMonOptionDescription.Serializer	description(byte[] val)
SrvMonOptionDescription.Serializer	description(byte[] val, int offset, int len)
SrvMonOptionDescription.Serializer	description(IOBuffer val, int offset, int len)
SrvMonOptionDescription.Serializer	description(String val)
SrvMonOptionDescription.Serializer	description(XString val)
SrvMonOptionDescription.Serializer	description(XStringDeserializer val)
SrvMonOptionDescription.Serializer	displayName(byte[] val)
SrvMonOptionDescription.Serializer	displayName(byte[] val, int offset, int len)
SrvMonOptionDescription.Serializer	displayName(IOBuffer val, int offset, int len)
SrvMonOptionDescription.Serializer	displayName(String val)
SrvMonOptionDescription.Serializer	displayName(XString val)
SrvMonOptionDescription.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<SrvMonOptionDescription.Serializer>	getPool() Get a pool item's pool.
int	getSerializedLength()
void	getTo(IOBuffer buffer, int offset)
int	getTo(long addr, int offset)
boolean	hasSizer()
SrvMonOptionDescription.Serializer	init() Initialize an item.
SrvMonOptionDescription.Serializer	init(IOBuffer buffer)
SrvMonOptionDescription.Serializer	init(IOBuffer buffer, int len)
SrvMonOptionDescription.Serializer	init(long addr, int len)
boolean	isInitialized()
SrvMonOptionDescription.Serializer	longForm(byte[] val)
SrvMonOptionDescription.Serializer	longForm(byte[] val, int offset, int len)
SrvMonOptionDescription.Serializer	longForm(IOBuffer val, int offset, int len)
SrvMonOptionDescription.Serializer	longForm(String val)
SrvMonOptionDescription.Serializer	longForm(XString val)
SrvMonOptionDescription.Serializer	longForm(XStringDeserializer val)
void	putFrom(IOBuffer buffer, int offset, int len)
void	putFrom(long addr, int offset, int len)
SrvMonOptionDescription.Serializer	required(boolean val)
SrvMonOptionDescription.Serializer	setPool(UtlPool<SrvMonOptionDescription.Serializer> pool) Set a pool item's pool.
SrvMonOptionDescription.Serializer	setSizer(AdmRuntime.BufferSizer sizer)
SrvMonOptionDescription.Serializer	shortForm(char val)
SrvMonOptionDescription.Serializer	type(SrvMonOptionType val)
SrvMonOptionDescription.Serializer	validValues(byte[] val)
SrvMonOptionDescription.Serializer	validValues(byte[] val, int offset, int len)
SrvMonOptionDescription.Serializer	validValues(IOBuffer val, int offset, int len)
SrvMonOptionDescription.Serializer	validValues(String val)
SrvMonOptionDescription.Serializer	validValues(XString val)
SrvMonOptionDescription.Serializer	validValues(XStringDeserializer val)
SrvMonOptionDescription.Serializer	validValues(XStringIterator val)

Methods inherited from class java.lang.Object

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

Method Detail

create

public static final SrvMonOptionDescription.Serializer create(boolean pvt)

create

public static final SrvMonOptionDescription.Serializer create()

init

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

init

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

init

public final SrvMonOptionDescription.Serializer init(IOBuffer buffer)

setSizer

public final SrvMonOptionDescription.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)

shortForm

public final SrvMonOptionDescription.Serializer shortForm(char val)

required

public final SrvMonOptionDescription.Serializer required(boolean val)

type

public final SrvMonOptionDescription.Serializer type(SrvMonOptionType val)

longForm

public final SrvMonOptionDescription.Serializer longForm(String val)

longForm

public final SrvMonOptionDescription.Serializer longForm(XString val)

longForm

public final SrvMonOptionDescription.Serializer longForm(byte[] val,
                                                         int offset,
                                                         int len)

longForm

public final SrvMonOptionDescription.Serializer longForm(byte[] val)

longForm

public final SrvMonOptionDescription.Serializer longForm(XStringDeserializer val)

longForm

public final SrvMonOptionDescription.Serializer longForm(IOBuffer val,
                                                         int offset,
                                                         int len)

defaultValue

public final SrvMonOptionDescription.Serializer defaultValue(String val)

defaultValue

public final SrvMonOptionDescription.Serializer defaultValue(XString val)

defaultValue

public final SrvMonOptionDescription.Serializer defaultValue(byte[] val,
                                                             int offset,
                                                             int len)

defaultValue

public final SrvMonOptionDescription.Serializer defaultValue(byte[] val)

defaultValue

public final SrvMonOptionDescription.Serializer defaultValue(XStringDeserializer val)

defaultValue

public final SrvMonOptionDescription.Serializer defaultValue(IOBuffer val,
                                                             int offset,
                                                             int len)

validValues

public final SrvMonOptionDescription.Serializer validValues(String val)

validValues

public final SrvMonOptionDescription.Serializer validValues(XString val)

validValues

public final SrvMonOptionDescription.Serializer validValues(byte[] val,
                                                            int offset,
                                                            int len)

validValues

public final SrvMonOptionDescription.Serializer validValues(byte[] val)

validValues

public final SrvMonOptionDescription.Serializer validValues(XStringDeserializer val)

validValues

public final SrvMonOptionDescription.Serializer validValues(IOBuffer val,
                                                            int offset,
                                                            int len)

validValues

public final SrvMonOptionDescription.Serializer validValues(XStringIterator val)

description

public final SrvMonOptionDescription.Serializer description(String val)

description

public final SrvMonOptionDescription.Serializer description(XString val)

description

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

description

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

description

public final SrvMonOptionDescription.Serializer description(XStringDeserializer val)

description

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

displayName

public final SrvMonOptionDescription.Serializer displayName(String val)

displayName

public final SrvMonOptionDescription.Serializer displayName(XString val)

displayName

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

displayName

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

displayName

public final SrvMonOptionDescription.Serializer displayName(XStringDeserializer val)

displayName

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

done

public final int done()

init

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

Returns:

Return 'this' object for method invocation chaining.

setPool

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

Returns:

Return 'this' object for method invocation chaining.

getPool

public final UtlPool<SrvMonOptionDescription.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<SrvMonOptionDescription.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.