SrvMonAppFlowInfo (Talon 3.14.19 API)

java.lang.Object
- com.neeve.server.mon.SrvMonAppFlowInfo

All Implemented Interfaces:: IRogValidatable, ISrvMonAppFlowInfo, UtlPool.Item<SrvMonAppFlowInfo>, com.neeve.xbuf.IXbufDesyncer

@Generated(value="com.neeve.adm.AdmXbufGenerator",
           date="Thu May 07 15:37:32 EDT 2020")
@AdmGenerated(encoding="Xbuf",
              compatLevel="4.0.0",
              admVersion="nvx-rumi-adm v3.14 (build 29)",
              date="5/7/20 3:37 PM",
              buildInfo="nvx-talon-3.14.19 (nvx-codegen-plugin)")
@AdmFactoryInfo(factoryClass=SrvMonFactory.class,
                vfid=32,
                ofid=32,
                typeId=104)
public final class SrvMonAppFlowInfo
extends Object
implements com.neeve.xbuf.IXbufDesyncer, UtlPool.Item<SrvMonAppFlowInfo>, ISrvMonAppFlowInfo

Holds information about a application flow.

ADM Details

ADM Type	Embedded Entity
Factory	SrvMonFactory

ADM Field Summary

Field	Type	Id	Description
id	Integer	16	The flow id.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`SrvMonAppFlowInfo.Field` The SrvMonAppFlowInfo xbuf field (used internally when this entity is used as a field of another entity).
`static class`	`SrvMonAppFlowInfo.ListField` The SrvMonAppFlowInfo list field (used internally when this entity is used as an array field of another entity).

Field Summary

Fields
Modifier and Type Field and Description

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

Fields
Modifier and Type	Field and Description
`static SrvMonAppFlowInfo[]`	`EMPTY_ARRAY` A preallocated empty array used to avoid garbage when returning empty arrays of this type.

Constructor Summary

Constructors
Constructor and Description

SrvMonAppFlowInfo()

SrvMonAppFlowInfo(int initialBackingBufferSize)

Constructors
Constructor and Description
`SrvMonAppFlowInfo()`
`SrvMonAppFlowInfo(int initialBackingBufferSize)`

Method Summary

Methods
Modifier and Type	Method and Description
`SrvMonAppFlowInfo`	`acquire()`
`void`	`clearContent()`
`void`	`clearId()` Clears the value of 'id'.
`void`	`clearXRogType()`
`Object`	`clone()` Creates a clone of this object.
`SrvMonAppFlowInfo`	`copy()` Creates a copy of this SrvMonAppFlowInfo.
`void`	`copyInto(SrvMonAppFlowInfo copy)` Copies the contents of this SrvMonAppFlowInfo into the target.
`static SrvMonAppFlowInfo`	`create()`
`static SrvMonAppFlowInfo`	`createFrom(byte[] serializedContainer)`
`static SrvMonAppFlowInfo`	`createFrom(byte[] serializedContainer, com.neeve.xbuf.XbufDesyncPolicy desyncPolicy)`
`static SrvMonAppFlowInfo`	`createFromSerializedXbufContainer(byte[] serializedContainer)`
`static SrvMonAppFlowInfo`	`createFromSerializedXbufContainer(byte[] serializedContainer, com.neeve.xbuf.XbufDesyncPolicy desyncPolicy)`
`static com.neeve.xbuf.XbufSchema`	`createSchema()`
`SrvMonAppFlowInfo`	`deserializeFromByteArray(byte[] array)`
`SrvMonAppFlowInfo`	`deserializeFromByteArray(byte[] array, com.neeve.xbuf.XbufDesyncPolicy desyncPolicy)`
`SrvMonAppFlowInfo`	`deserializeFromByteBuffer(ByteBuffer buffer)`
`SrvMonAppFlowInfo`	`deserializeFromByteBuffer(ByteBuffer buffer, com.neeve.xbuf.XbufDesyncPolicy desyncPolicy)`
`SrvMonAppFlowInfo`	`deserializeFromIOElasticBuffer(com.neeve.io.IOElasticBuffer buffer, int offset, int length)`
`SrvMonAppFlowInfo`	`deserializeFromIOElasticBuffer(com.neeve.io.IOElasticBuffer buffer, int offset, int length, com.neeve.xbuf.XbufDesyncPolicy desyncPolicy)`
`SrvMonAppFlowInfo`	`deserializeFromNative(long address, int offset, int length)`
`SrvMonAppFlowInfo`	`deserializeFromNative(long address, int offset, int length, com.neeve.xbuf.XbufDesyncPolicy desyncPolicy)`
`int`	`desync(PktBuffer buffer, int pos, boolean frameOnly)` Desync fields from a buffer
`void`	`desyncFieldBitmask()`
`void`	`dispose()`
`PktBuffer`	`getBackingBuffer()`
`static com.neeve.xbuf.XbufDesyncPolicy`	`getDesyncPolicy()`
`int`	`getId()` Gets the value of 'id'.
`com.neeve.xbuf.XbufVariableIntField`	`getIdField()`
`static int`	`getIdFieldId()`
`boolean`	`getIsReadOnly()`
`int`	`getOwnerCount()`
`UtlPool<SrvMonAppFlowInfo>`	`getPool()` Get a pool item's pool.
`int`	`getSerializeToNativeLength()`
`void`	`getValidationErrors(List<XString> results, String errorPrefix)` Collects validation errors into the provided list.
`short`	`getXRogType()`
`com.neeve.xbuf.XbufVariableShortField`	`getXRogTypeField()`
`static int`	`getXRogTypeFieldId()`
`boolean`	`hasId()` Checks for the presence of 'id'.
`boolean`	`hasXRogType()`
`SrvMonAppFlowInfo`	`init()` Initialize an item.
`boolean`	`isBufferBacked()`
`boolean`	`isDirty()`
`boolean`	`isReferenceCounted()`
`boolean`	`isValid()` Tests if this object has any validation errors.
`static void`	`optimizeFor(int val)`
`byte[]`	`serializeToByteArray()`
`ByteBuffer`	`serializeToByteBuffer()`
`com.neeve.io.IOBuffer`	`serializeToIOBuffer(boolean useNative)`
`int`	`serializeToNative(long address, int addressOffset)`
`void`	`setAsReadOnly()`
`static void`	`setDesyncPolicy(com.neeve.xbuf.XbufDesyncPolicy val)`
`static void`	`setFieldInterest(List<Integer> fieldIds)`
`void`	`setId(int val)` Sets the value of 'id'.
`void`	`setIdFrom(com.neeve.xbuf.XbufVariableIntField val)`
`SrvMonAppFlowInfo`	`setPool(UtlPool<SrvMonAppFlowInfo> pool)` Set a pool item's pool.
`void`	`setPreserializedFields(PktBuffer buffer)`
`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 SrvMonAppFlowInfo[] EMPTY_ARRAY
```
    A preallocated empty array used to avoid garbage when returning empty arrays of this type.
- Constructor Detail
  - SrvMonAppFlowInfo
```
public SrvMonAppFlowInfo()
```
  - SrvMonAppFlowInfo
```
public SrvMonAppFlowInfo(int initialBackingBufferSize)
```
- Method Detail
  - create
```
public static SrvMonAppFlowInfo create()
```
  - createFromSerializedXbufContainer
```
public static SrvMonAppFlowInfo createFromSerializedXbufContainer(byte[] serializedContainer,
                                                  com.neeve.xbuf.XbufDesyncPolicy desyncPolicy)
```
  - createFromSerializedXbufContainer
```
public static SrvMonAppFlowInfo createFromSerializedXbufContainer(byte[] serializedContainer)
```
  - createFrom
```
public static SrvMonAppFlowInfo createFrom(byte[] serializedContainer,
                           com.neeve.xbuf.XbufDesyncPolicy desyncPolicy)
```
  - createFrom
```
public static SrvMonAppFlowInfo 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()
```
  - setPreserializedFields
```
public final void setPreserializedFields(PktBuffer buffer)
```
  - getXRogTypeFieldId
```
public static final int getXRogTypeFieldId()
```
  - 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()
```
  - getIdFieldId
```
public static final int getIdFieldId()
```
  - setId
```
public final void setId(int val)
```
    Description copied from interface: ISrvMonAppFlowInfo
    
    Sets the value of 'id'.
    Field Description
    The flow id.
    
    Specified by:
    
    setId in interface ISrvMonAppFlowInfo
    
    Parameters:
    val - The value to set.
  - getId
```
public final int getId()
```
    Description copied from interface: ISrvMonAppFlowInfo
    
    Gets the value of 'id'.
    Field Description
    The flow id.
    
    Specified by:
    
    getId in interface ISrvMonAppFlowInfo
    
    Returns:
    The flow id.
  - setIdFrom
```
public final void setIdFrom(com.neeve.xbuf.XbufVariableIntField val)
```
  - getIdField
```
public final com.neeve.xbuf.XbufVariableIntField getIdField()
```
  - hasId
```
public final boolean hasId()
```
    Description copied from interface: ISrvMonAppFlowInfo
    
    Checks for the presence of 'id'.
    Field Description
    The flow id.
    
    Specified by:
    
    hasId in interface ISrvMonAppFlowInfo
    
    See Also:
    ISrvMonAppFlowInfo.getId()
  - clearId
```
public final void clearId()
```
    Description copied from interface: ISrvMonAppFlowInfo
    
    Clears the value of 'id'.
    Field Description
    The flow id.
    
    Specified by:
    
    clearId in interface ISrvMonAppFlowInfo
    
    See Also:
    ISrvMonAppFlowInfo.setId(int)
  - 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 SrvMonAppFlowInfo deserializeFromIOElasticBuffer(com.neeve.io.IOElasticBuffer buffer,
                                               int offset,
                                               int length,
                                               com.neeve.xbuf.XbufDesyncPolicy desyncPolicy)
```
  - deserializeFromIOElasticBuffer
```
public final SrvMonAppFlowInfo deserializeFromIOElasticBuffer(com.neeve.io.IOElasticBuffer buffer,
                                               int offset,
                                               int length)
```
  - deserializeFromByteArray
```
public final SrvMonAppFlowInfo deserializeFromByteArray(byte[] array,
                                         com.neeve.xbuf.XbufDesyncPolicy desyncPolicy)
```
  - deserializeFromByteArray
```
public final SrvMonAppFlowInfo deserializeFromByteArray(byte[] array)
```
  - deserializeFromByteBuffer
```
public final SrvMonAppFlowInfo deserializeFromByteBuffer(ByteBuffer buffer,
                                          com.neeve.xbuf.XbufDesyncPolicy desyncPolicy)
```
  - deserializeFromByteBuffer
```
public final SrvMonAppFlowInfo deserializeFromByteBuffer(ByteBuffer buffer)
```
  - deserializeFromNative
```
public final SrvMonAppFlowInfo deserializeFromNative(long address,
                                      int offset,
                                      int length,
                                      com.neeve.xbuf.XbufDesyncPolicy desyncPolicy)
```
  - deserializeFromNative
```
public final SrvMonAppFlowInfo deserializeFromNative(long address,
                                      int offset,
                                      int length)
```
  - sync
```
public final void sync()
```
  - desync
```
public final int desync(PktBuffer buffer,
         int pos,
         boolean frameOnly)
```
    Description copied from interface: com.neeve.xbuf.IXbufDesyncer
    
    Desync fields from a buffer
    
    Specified by:
    
    desync in interface com.neeve.xbuf.IXbufDesyncer
    
    Parameters:
    buffer - The buffer to desync from
    pos - The position in the container's backing buffer to desync from
    frameOnly - Whether to frame the field on the underlying buffer. See XbufField.desync(PktBuffer, int, boolean) for more information
  - init
```
public final SrvMonAppFlowInfo 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<SrvMonAppFlowInfo>
    
    Returns:
    Return 'this' object for method invocation chaining.
  - setPool
```
public final SrvMonAppFlowInfo setPool(UtlPool<SrvMonAppFlowInfo> 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<SrvMonAppFlowInfo>
    
    Returns:
    Return 'this' object for method invocation chaining.
  - getPool
```
public final UtlPool<SrvMonAppFlowInfo> 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<SrvMonAppFlowInfo>
    
    Returns:
    the pool set using UtlPool.Item.setPool(com.neeve.util.UtlPool<T>)
  - isReferenceCounted
```
public final boolean isReferenceCounted()
```
  - acquire
```
public final SrvMonAppFlowInfo 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 SrvMonAppFlowInfo copy()
```
    Creates a copy of this SrvMonAppFlowInfo.
    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 SrvMonAppFlowInfo's embedded entity fields.
    The returned copy will be writeable even if this SrvMonAppFlowInfo 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(SrvMonAppFlowInfo copy)
```
    Copies the contents of this SrvMonAppFlowInfo 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 SrvMonAppFlowInfo's embedded entity fields.
    The returned copy will be writeable even if this SrvMonAppFlowInfo 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

Class SrvMonAppFlowInfo

ADM Details

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

EMPTY_ARRAY

Constructor Detail

SrvMonAppFlowInfo

SrvMonAppFlowInfo

Method Detail

create

createFromSerializedXbufContainer

createFromSerializedXbufContainer

createFrom

createFrom

setDesyncPolicy

getDesyncPolicy

setFieldInterest

clearContent

syncFieldBitmask

desyncFieldBitmask

getBackingBuffer

optimizeFor

setAsReadOnly

getIsReadOnly

setPreserializedFields

getXRogTypeFieldId

setXRogType

getXRogType

setXRogTypeFrom

getXRogTypeField

hasXRogType

clearXRogType

getIdFieldId

setId

Field Description

getId

Field Description

setIdFrom

getIdField

hasId

Field Description

clearId

Field Description

isDirty

createSchema

serializeToByteArray

serializeToByteBuffer

serializeToIOBuffer

isBufferBacked

getSerializeToNativeLength

serializeToNative

deserializeFromIOElasticBuffer

deserializeFromIOElasticBuffer

deserializeFromByteArray

deserializeFromByteArray

deserializeFromByteBuffer

deserializeFromByteBuffer

deserializeFromNative

deserializeFromNative

sync

desync

init

setPool

getPool

isReferenceCounted

acquire

getOwnerCount

dispose

clone

copy

Xbuf Pass-through Fields

copyInto

Xbuf Pass-through Fields

isValid

getValidationErrors

toString