|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
@Generated(value="com.neeve.adm.AdmGenerator",
date="Wed Mar 28 10:54:31 EDT 2018")
@AdmGenerated(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)")
public interface ISrvMonAppInfoHolds information about an application.
| Method Summary | ||
|---|---|---|
void |
addBusBindingsInfo(SrvMonAppBusBindingInfo val)
Adds the provided value to the list of 'busBindingsInfo' values. |
|
void |
addClientsInfo(SrvMonAppClientInfo val)
Adds the provided value to the list of 'clientsInfo' values. |
|
void |
addFlowsInfo(SrvMonAppFlowInfo val)
Adds the provided value to the list of 'flowsInfo' values. |
|
void |
clearBusBindingsInfo()
Clears the value of 'busBindingsInfo' Field Description Holds information about a app's message bus bindings. |
|
void |
clearClientsInfo()
Clears the value of 'clientsInfo' Field Description Holds information about a app's connected clients. |
|
void |
clearFlowsInfo()
Clears the value of 'flowsInfo' Field Description Holds information about a app's active message flows. |
|
void |
clearHAPolicy()
Clears the value of 'HAPolicy' Field Description The application's HAPolicy. |
|
void |
clearJarVersion()
Deprecated. - No Reason Given |
|
void |
clearJarVersionString()
Clears the value of 'jarVersionString' Field Description The jar version of the application (if specified/known) |
|
void |
clearLoadedTime()
Clears the value of 'loadedTime' Field Description The time at which the app was last loaded |
|
void |
clearName()
Clears the value of 'name' Field Description The application's name. |
|
void |
clearRole()
Clears the value of 'role' Field Description The application's current HA role. |
|
void |
clearState()
Clears the value of 'state' Field Description The application's current state. |
|
void |
clearVersion()
Clears the value of 'version' Field Description The application version if (if specified/known). |
|
SrvMonAppBusBindingInfo[] |
getBusBindingsInfo()
Gets the value of 'busBindingsInfo' If the field is not set this method will return null. |
|
SrvMonAppBusBindingInfo[] |
getBusBindingsInfoEmptyIfNull()
Gets the value of 'busBindingsInfo' or an empty array if the value is null or not set. |
|
XIterator<SrvMonAppBusBindingInfo> |
getBusBindingsInfoIterator()
Gets the value of 'busBindingsInfo' as iterator of values. |
|
SrvMonAppClientInfo[] |
getClientsInfo()
Gets the value of 'clientsInfo' If the field is not set this method will return null. |
|
SrvMonAppClientInfo[] |
getClientsInfoEmptyIfNull()
Gets the value of 'clientsInfo' or an empty array if the value is null or not set. |
|
XIterator<SrvMonAppClientInfo> |
getClientsInfoIterator()
Gets the value of 'clientsInfo' as iterator of values. |
|
SrvMonAppFlowInfo[] |
getFlowsInfo()
Gets the value of 'flowsInfo' If the field is not set this method will return null. |
|
SrvMonAppFlowInfo[] |
getFlowsInfoEmptyIfNull()
Gets the value of 'flowsInfo' or an empty array if the value is null or not set. |
|
XIterator<SrvMonAppFlowInfo> |
getFlowsInfoIterator()
Gets the value of 'flowsInfo' as iterator of values. |
|
SrvMonAppHAPolicy |
getHAPolicy()
Gets the value of 'HAPolicy' Field Description The application's HAPolicy. |
|
int |
getJarVersion()
Deprecated. - No Reason Given |
|
String |
getJarVersionString()
Gets the value of 'jarVersionString' Field Description The jar version of the application (if specified/known) |
|
|
getJarVersionStringTo(XString.Factory<T> factory)
Copies the value of this String field into a new XString from the given factory. |
|
void |
getJarVersionStringTo(XString val)
Copies the value of 'jarVersionString' into the provided XString. |
|
XString |
getJarVersionStringUnsafe()
Gets the raw value of 'jarVersionString'. |
|
Date |
getLoadedTime()
Gets the value of 'loadedTime' Field Description The time at which the app was last loaded |
|
long |
getLoadedTimeAsTimestamp()
Retrieves the date as a timestamp (a zero garbage operation for XBuf encoding). |
|
String |
getName()
Gets the value of 'name' Field Description The application's name. |
|
|
getNameTo(XString.Factory<T> factory)
Copies the value of this String field into a new XString from the given factory. |
|
void |
getNameTo(XString val)
Copies the value of 'name' into the provided XString. |
|
XString |
getNameUnsafe()
Gets the raw value of 'name'. |
|
SrvMonAppRole |
getRole()
Gets the value of 'role' Field Description The application's current HA role. |
|
SrvMonAppState |
getState()
Gets the value of 'state' Field Description The application's current state. |
|
int |
getVersion()
Gets the value of 'version' Field Description The application version if (if specified/known). |
|
boolean |
hasHAPolicy()
Checks for the presence of 'HAPolicy' Field Description The application's HAPolicy. |
|
boolean |
hasJarVersion()
Deprecated. - No Reason Given |
|
boolean |
hasJarVersionString()
Checks for the presence of 'jarVersionString' Field Description The jar version of the application (if specified/known) |
|
boolean |
hasLoadedTime()
Checks for the presence of 'loadedTime' Field Description The time at which the app was last loaded |
|
boolean |
hasName()
Checks for the presence of 'name' Field Description The application's name. |
|
boolean |
hasRole()
Checks for the presence of 'role' Field Description The application's current HA role. |
|
boolean |
hasState()
Checks for the presence of 'state' Field Description The application's current state. |
|
boolean |
hasVersion()
Checks for the presence of 'version' Field Description The application version if (if specified/known). |
|
void |
lendBusBindingsInfo(SrvMonAppBusBindingInfo val)
Adds the provided value to the list of 'busBindingsInfo' values and acquires a reference to it. |
|
void |
lendBusBindingsInfo(SrvMonAppBusBindingInfo[] val)
Lends the value of 'busBindingsInfo' Field Description Holds information about a app's message bus bindings. |
|
void |
lendBusBindingsInfoFrom(XIterator<SrvMonAppBusBindingInfo> val)
Sets the value of 'busBindingsInfo' by lending the values from the provided iterator. |
|
void |
lendClientsInfo(SrvMonAppClientInfo val)
Adds the provided value to the list of 'clientsInfo' values and acquires a reference to it. |
|
void |
lendClientsInfo(SrvMonAppClientInfo[] val)
Lends the value of 'clientsInfo' Field Description Holds information about a app's connected clients. |
|
void |
lendClientsInfoFrom(XIterator<SrvMonAppClientInfo> val)
Sets the value of 'clientsInfo' by lending the values from the provided iterator. |
|
void |
lendFlowsInfo(SrvMonAppFlowInfo val)
Adds the provided value to the list of 'flowsInfo' values and acquires a reference to it. |
|
void |
lendFlowsInfo(SrvMonAppFlowInfo[] val)
Lends the value of 'flowsInfo' Field Description Holds information about a app's active message flows. |
|
void |
lendFlowsInfoFrom(XIterator<SrvMonAppFlowInfo> val)
Sets the value of 'flowsInfo' by lending the values from the provided iterator. |
|
void |
lendJarVersionString(XString val)
Sets the value of 'jarVersionString' Field Description The jar version of the application (if specified/known) |
|
void |
lendName(XString val)
Sets the value of 'name' Field Description The application's name. |
|
void |
setBusBindingsInfo(SrvMonAppBusBindingInfo[] val)
Sets the value of 'busBindingsInfo' Field Description Holds information about a app's message bus bindings. |
|
void |
setBusBindingsInfoFrom(XIterator<SrvMonAppBusBindingInfo> val)
Sets the value of 'busBindingsInfo' using the values from the provided iterator. |
|
void |
setClientsInfo(SrvMonAppClientInfo[] val)
Sets the value of 'clientsInfo' Field Description Holds information about a app's connected clients. |
|
void |
setClientsInfoFrom(XIterator<SrvMonAppClientInfo> val)
Sets the value of 'clientsInfo' using the values from the provided iterator. |
|
void |
setFlowsInfo(SrvMonAppFlowInfo[] val)
Sets the value of 'flowsInfo' Field Description Holds information about a app's active message flows. |
|
void |
setFlowsInfoFrom(XIterator<SrvMonAppFlowInfo> val)
Sets the value of 'flowsInfo' using the values from the provided iterator. |
|
void |
setHAPolicy(SrvMonAppHAPolicy val)
Sets the value of 'HAPolicy' Field Description The application's HAPolicy. |
|
void |
setJarVersion(int val)
Deprecated. - No Reason Given |
|
void |
setJarVersionString(String val)
Sets the value of 'jarVersionString' Field Description The jar version of the application (if specified/known) |
|
void |
setJarVersionStringFrom(long val)
Sets the value of this String field to the given numeric value. |
|
void |
setJarVersionStringFrom(XString val)
Copies the provided XString value into this object's 'jarVersionString'. |
|
void |
setLoadedTime(Date val)
Sets the value of 'loadedTime' Field Description The time at which the app was last loaded |
|
void |
setLoadedTimeAsTimestamp(long val)
Sets the date value as a timestamp. |
|
void |
setName(String val)
Sets the value of 'name' Field Description The application's name. |
|
void |
setNameFrom(long val)
Sets the value of this String field to the given numeric value. |
|
void |
setNameFrom(XString val)
Copies the provided XString value into this object's 'name'. |
|
void |
setRole(SrvMonAppRole val)
Sets the value of 'role' Field Description The application's current HA role. |
|
void |
setState(SrvMonAppState val)
Sets the value of 'state' Field Description The application's current state. |
|
void |
setVersion(int val)
Sets the value of 'version' Field Description The application version if (if specified/known). |
|
SrvMonAppBusBindingInfo[] |
takeBusBindingsInfo()
Takes the value of 'busBindingsInfo' Field Description Holds information about a app's message bus bindings. |
|
SrvMonAppClientInfo[] |
takeClientsInfo()
Takes the value of 'clientsInfo' Field Description Holds information about a app's connected clients. |
|
SrvMonAppFlowInfo[] |
takeFlowsInfo()
Takes the value of 'flowsInfo' Field Description Holds information about a app's active message flows. |
|
| Methods inherited from interface com.neeve.rog.IRogValidatable |
|---|
getValidationErrors, isValid |
| Method Detail |
|---|
void setVersion(int val)
val - The value to set.int getVersion()
void clearVersion()
setVersion(int)boolean hasVersion()
getVersion()@Deprecated void setJarVersion(int val)
val - The value to set.@Deprecated int getJarVersion()
@Deprecated void clearJarVersion()
setJarVersion(int)@Deprecated boolean hasJarVersion()
getJarVersion()void setState(SrvMonAppState val)
val - The value to set.SrvMonAppState getState()
void clearState()
setState(SrvMonAppState)boolean hasState()
getState()void setRole(SrvMonAppRole val)
val - The value to set.SrvMonAppRole getRole()
void clearRole()
setRole(SrvMonAppRole)boolean hasRole()
getRole()void setHAPolicy(SrvMonAppHAPolicy val)
val - The value to set.SrvMonAppHAPolicy getHAPolicy()
void clearHAPolicy()
setHAPolicy(SrvMonAppHAPolicy)boolean hasHAPolicy()
getHAPolicy()void setLoadedTime(Date val)
val - The value to set.Date getLoadedTime()
void setLoadedTimeAsTimestamp(long val)
val - The date value in milliseconds from the epochlong getLoadedTimeAsTimestamp()
NOTE:
Note that a return value of -1 could also indicate 1 millisecond before the epoch.
In cases where a such an ambiguity is a practical concern, hasLoadedTime()
should be called.
void clearLoadedTime()
setLoadedTime(Date)boolean hasLoadedTime()
getLoadedTime()void setName(String val)
val - The value to set.String getName()
void lendName(XString val)
val - The value to set.void setNameFrom(long val)
NOTE:
This is the same as calling setName(String).
with Long.valueOf(val).toString(), except that using this method is a zero garbage
operation for Xbuf encoding.
<T extends XString> T getNameTo(XString.Factory<T> factory)
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;
factory - The factory from which to get the XString to copy into and return
null.
NullPointerException - if the provided factory is nullvoid setNameFrom(XString val)
NOTE:
This is a Zero Garbage operation for XBuf encoded objects. Additionally, this setter
can be more efficient than setName(String)
because it avoids encoding the value into a String if the given XString is already encoded.
void getNameTo(XString val)
NOTE:
This is a Zero Garbage operation for XBuf encoded objects. Additionally, this getter
can be more efficient than getName() bec
because it can avoid decoding the value into an String.
getName()XString getNameUnsafe()
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.
getName()void clearName()
setName(String)boolean hasName()
getName()void setClientsInfo(SrvMonAppClientInfo[] val)
val - The value to set.void setClientsInfoFrom(XIterator<SrvMonAppClientInfo> val)
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 'clientsInfo' accessor can copy the values without iteration.
NOTE:
Passing a null or empty list has the same affect as calling setClientsInfo(SrvMonAppClientInfo[]) with
a value of null.
val - the values to set.void lendClientsInfoFrom(XIterator<SrvMonAppClientInfo> val)
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 will acquire references to each non null value in the provided iterator making it suitable for cases where the values come from another message that may be disposed.
This method is zero garbage for Xbuf generated classes, and this method is optimized such that calling this with an iterator from another 'clientsInfo' accessor can copy the values without iteration.
NOTE:
Passing a null or empty list has the same affect as calling setClientsInfo(SrvMonAppClientInfo[]) with
a value of null.
val - the values to set.void addClientsInfo(SrvMonAppClientInfo val)
This method is zero garbage for Xbuf generated classes, and this method is optimized such that calling this with an iterator from another 'clientsInfo' 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.
val - the value to add.void lendClientsInfo(SrvMonAppClientInfo val)
Lending of an added value is useful in cases where a field is being added from a source message to provide dispose of the source value when the source message is disposed.
This method is zero garbage for Xbuf generated classes, and this method is optimized such that calling this with an iterator from another 'clientsInfo' 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.
val - the value to add.XIterator<SrvMonAppClientInfo> getClientsInfoIterator()
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.
The elements returned by this iterator are owned by and pooled along with this object. The caller. must call acquire() on each returned object that this object intends to keep beyond the lifespan. of this object (unless the element is lent to another object in which that object will acquire it then).
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(XIterator
void lendClientsInfo(SrvMonAppClientInfo[] val)
NOTE:
It is illegal to hold onto an entity 'set' on a message post the disposal of the container message.
This is true even if a reference to the entity is explicitly 'acquired' by the application via acquire().
To hold onto the reference of an entity beyond the lifecycle of its container message, an application must own a reference to the entity (via, for example, 'taking' the entity off an inbound message) and then 'lend' the entity to the message for sending. The act of 'lending' an entity to a message implies that the application continues to own the entity even though the message is holding a reference to it for the duration of the send.
val - the value to 'lend' to lend.SrvMonAppClientInfo[] getClientsInfo()
If the field is not set this method will return null.
null.SrvMonAppClientInfo[] getClientsInfoEmptyIfNull()
null or not set.
null if not set.getClientsInfo()SrvMonAppClientInfo[] takeClientsInfo()
NOTE:
A nested entity reference returned by getClientsInfo() is only valid until the entity is disposed
i.e. the act of getting an entity does not transfer ownership of the entity to the application
A message disposes of its reference to its contained entities when it is disposed itself.
An AEP engine disposes a message on return from its message handler. Therefore, applications working with AEP engines that wish to hold onto a nested entity reference post return from its containing message's handler must either acquire a reference to the container message or 'take' the nested entity itself from the container message. The act of 'taking' an entity differs from 'getting' an entity in that 'take' does what is necessary to ensure that the entity contents are not cleared and the entity not disposed when the message itself is disposed. For a taken entity to be disposed, the application must explicitly dispose it when done working with it.
null if the field is not set.void clearClientsInfo()
setClientsInfo(SrvMonAppClientInfo[])void setBusBindingsInfo(SrvMonAppBusBindingInfo[] val)
val - The value to set.void setBusBindingsInfoFrom(XIterator<SrvMonAppBusBindingInfo> val)
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 'busBindingsInfo' accessor can copy the values without iteration.
NOTE:
Passing a null or empty list has the same affect as calling setBusBindingsInfo(SrvMonAppBusBindingInfo[]) with
a value of null.
val - the values to set.void lendBusBindingsInfoFrom(XIterator<SrvMonAppBusBindingInfo> val)
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 will acquire references to each non null value in the provided iterator making it suitable for cases where the values come from another message that may be disposed.
This method is zero garbage for Xbuf generated classes, and this method is optimized such that calling this with an iterator from another 'busBindingsInfo' accessor can copy the values without iteration.
NOTE:
Passing a null or empty list has the same affect as calling setBusBindingsInfo(SrvMonAppBusBindingInfo[]) with
a value of null.
val - the values to set.void addBusBindingsInfo(SrvMonAppBusBindingInfo val)
This method is zero garbage for Xbuf generated classes, and this method is optimized such that calling this with an iterator from another 'busBindingsInfo' 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.
val - the value to add.void lendBusBindingsInfo(SrvMonAppBusBindingInfo val)
Lending of an added value is useful in cases where a field is being added from a source message to provide dispose of the source value when the source message is disposed.
This method is zero garbage for Xbuf generated classes, and this method is optimized such that calling this with an iterator from another 'busBindingsInfo' 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.
val - the value to add.XIterator<SrvMonAppBusBindingInfo> getBusBindingsInfoIterator()
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.
The elements returned by this iterator are owned by and pooled along with this object. The caller. must call acquire() on each returned object that this object intends to keep beyond the lifespan. of this object (unless the element is lent to another object in which that object will acquire it then).
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(XIterator
void lendBusBindingsInfo(SrvMonAppBusBindingInfo[] val)
NOTE:
It is illegal to hold onto an entity 'set' on a message post the disposal of the container message.
This is true even if a reference to the entity is explicitly 'acquired' by the application via acquire().
To hold onto the reference of an entity beyond the lifecycle of its container message, an application must own a reference to the entity (via, for example, 'taking' the entity off an inbound message) and then 'lend' the entity to the message for sending. The act of 'lending' an entity to a message implies that the application continues to own the entity even though the message is holding a reference to it for the duration of the send.
val - the value to 'lend' to lend.SrvMonAppBusBindingInfo[] getBusBindingsInfo()
If the field is not set this method will return null.
null.SrvMonAppBusBindingInfo[] getBusBindingsInfoEmptyIfNull()
null or not set.
null if not set.getBusBindingsInfo()SrvMonAppBusBindingInfo[] takeBusBindingsInfo()
NOTE:
A nested entity reference returned by getBusBindingsInfo() is only valid until the entity is disposed
i.e. the act of getting an entity does not transfer ownership of the entity to the application
A message disposes of its reference to its contained entities when it is disposed itself.
An AEP engine disposes a message on return from its message handler. Therefore, applications working with AEP engines that wish to hold onto a nested entity reference post return from its containing message's handler must either acquire a reference to the container message or 'take' the nested entity itself from the container message. The act of 'taking' an entity differs from 'getting' an entity in that 'take' does what is necessary to ensure that the entity contents are not cleared and the entity not disposed when the message itself is disposed. For a taken entity to be disposed, the application must explicitly dispose it when done working with it.
null if the field is not set.void clearBusBindingsInfo()
setBusBindingsInfo(SrvMonAppBusBindingInfo[])void setFlowsInfo(SrvMonAppFlowInfo[] val)
val - The value to set.void setFlowsInfoFrom(XIterator<SrvMonAppFlowInfo> val)
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 'flowsInfo' accessor can copy the values without iteration.
NOTE:
Passing a null or empty list has the same affect as calling setFlowsInfo(SrvMonAppFlowInfo[]) with
a value of null.
val - the values to set.void lendFlowsInfoFrom(XIterator<SrvMonAppFlowInfo> val)
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 will acquire references to each non null value in the provided iterator making it suitable for cases where the values come from another message that may be disposed.
This method is zero garbage for Xbuf generated classes, and this method is optimized such that calling this with an iterator from another 'flowsInfo' accessor can copy the values without iteration.
NOTE:
Passing a null or empty list has the same affect as calling setFlowsInfo(SrvMonAppFlowInfo[]) with
a value of null.
val - the values to set.void addFlowsInfo(SrvMonAppFlowInfo val)
This method is zero garbage for Xbuf generated classes, and this method is optimized such that calling this with an iterator from another 'flowsInfo' 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.
val - the value to add.void lendFlowsInfo(SrvMonAppFlowInfo val)
Lending of an added value is useful in cases where a field is being added from a source message to provide dispose of the source value when the source message is disposed.
This method is zero garbage for Xbuf generated classes, and this method is optimized such that calling this with an iterator from another 'flowsInfo' 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.
val - the value to add.XIterator<SrvMonAppFlowInfo> getFlowsInfoIterator()
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.
The elements returned by this iterator are owned by and pooled along with this object. The caller. must call acquire() on each returned object that this object intends to keep beyond the lifespan. of this object (unless the element is lent to another object in which that object will acquire it then).
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(XIterator
void lendFlowsInfo(SrvMonAppFlowInfo[] val)
NOTE:
It is illegal to hold onto an entity 'set' on a message post the disposal of the container message.
This is true even if a reference to the entity is explicitly 'acquired' by the application via acquire().
To hold onto the reference of an entity beyond the lifecycle of its container message, an application must own a reference to the entity (via, for example, 'taking' the entity off an inbound message) and then 'lend' the entity to the message for sending. The act of 'lending' an entity to a message implies that the application continues to own the entity even though the message is holding a reference to it for the duration of the send.
val - the value to 'lend' to lend.SrvMonAppFlowInfo[] getFlowsInfo()
If the field is not set this method will return null.
null.SrvMonAppFlowInfo[] getFlowsInfoEmptyIfNull()
null or not set.
null if not set.getFlowsInfo()SrvMonAppFlowInfo[] takeFlowsInfo()
NOTE:
A nested entity reference returned by getFlowsInfo() is only valid until the entity is disposed
i.e. the act of getting an entity does not transfer ownership of the entity to the application
A message disposes of its reference to its contained entities when it is disposed itself.
An AEP engine disposes a message on return from its message handler. Therefore, applications working with AEP engines that wish to hold onto a nested entity reference post return from its containing message's handler must either acquire a reference to the container message or 'take' the nested entity itself from the container message. The act of 'taking' an entity differs from 'getting' an entity in that 'take' does what is necessary to ensure that the entity contents are not cleared and the entity not disposed when the message itself is disposed. For a taken entity to be disposed, the application must explicitly dispose it when done working with it.
null if the field is not set.void clearFlowsInfo()
setFlowsInfo(SrvMonAppFlowInfo[])void setJarVersionString(String val)
val - The value to set.String getJarVersionString()
void lendJarVersionString(XString val)
val - The value to set.void setJarVersionStringFrom(long val)
NOTE:
This is the same as calling setJarVersionString(String).
with Long.valueOf(val).toString(), except that using this method is a zero garbage
operation for Xbuf encoding.
<T extends XString> T getJarVersionStringTo(XString.Factory<T> factory)
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;
factory - The factory from which to get the XString to copy into and return
null.
NullPointerException - if the provided factory is nullvoid setJarVersionStringFrom(XString val)
NOTE:
This is a Zero Garbage operation for XBuf encoded objects. Additionally, this setter
can be more efficient than setJarVersionString(String)
because it avoids encoding the value into a String if the given XString is already encoded.
void getJarVersionStringTo(XString val)
NOTE:
This is a Zero Garbage operation for XBuf encoded objects. Additionally, this getter
can be more efficient than getJarVersionString() bec
because it can avoid decoding the value into an String.
getJarVersionString()XString getJarVersionStringUnsafe()
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.
getJarVersionString()void clearJarVersionString()
setJarVersionString(String)boolean hasJarVersionString()
getJarVersionString()
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||