|
|||||||||
| 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 ISrvMonUserStats
Groups together the collections of application (User) defined counter and latencies statistics.
| Method Summary | |
|---|---|
void |
addCounters(SrvMonUserCounterStat val)
Adds the provided value to the list of 'counters' values. |
void |
addGauges(SrvMonUserGaugeStat val)
Adds the provided value to the list of 'gauges' values. |
void |
addSeries(SrvMonUserSeriesStat val)
Adds the provided value to the list of 'series' values. |
void |
clearCounters()
Clears the value of 'counters' Field Description Application Counter Stats |
void |
clearGauges()
Clears the value of 'gauges' Field Description Application Gauge Stats |
void |
clearSeries()
Clears the value of 'series' Field Description Application Series Stats |
SrvMonUserCounterStat[] |
getCounters()
Gets the value of 'counters' If the field is not set this method will return null. |
SrvMonUserCounterStat[] |
getCountersEmptyIfNull()
Gets the value of 'counters' or an empty array if the value is null or not set. |
XIterator<SrvMonUserCounterStat> |
getCountersIterator()
Gets the value of 'counters' as iterator of values. |
SrvMonUserGaugeStat[] |
getGauges()
Gets the value of 'gauges' If the field is not set this method will return null. |
SrvMonUserGaugeStat[] |
getGaugesEmptyIfNull()
Gets the value of 'gauges' or an empty array if the value is null or not set. |
XIterator<SrvMonUserGaugeStat> |
getGaugesIterator()
Gets the value of 'gauges' as iterator of values. |
SrvMonUserSeriesStat[] |
getSeries()
Gets the value of 'series' If the field is not set this method will return null. |
SrvMonUserSeriesStat[] |
getSeriesEmptyIfNull()
Gets the value of 'series' or an empty array if the value is null or not set. |
XIterator<SrvMonUserSeriesStat> |
getSeriesIterator()
Gets the value of 'series' as iterator of values. |
void |
lendCounters(SrvMonUserCounterStat val)
Adds the provided value to the list of 'counters' values and acquires a reference to it. |
void |
lendCounters(SrvMonUserCounterStat[] val)
Lends the value of 'counters' Field Description Application Counter Stats NOTE: It is illegal to hold onto an entity 'set' on a message post the disposal of the container message. |
void |
lendCountersFrom(XIterator<SrvMonUserCounterStat> val)
Sets the value of 'counters' by lending the values from the provided iterator. |
void |
lendGauges(SrvMonUserGaugeStat val)
Adds the provided value to the list of 'gauges' values and acquires a reference to it. |
void |
lendGauges(SrvMonUserGaugeStat[] val)
Lends the value of 'gauges' Field Description Application Gauge Stats NOTE: It is illegal to hold onto an entity 'set' on a message post the disposal of the container message. |
void |
lendGaugesFrom(XIterator<SrvMonUserGaugeStat> val)
Sets the value of 'gauges' by lending the values from the provided iterator. |
void |
lendSeries(SrvMonUserSeriesStat val)
Adds the provided value to the list of 'series' values and acquires a reference to it. |
void |
lendSeries(SrvMonUserSeriesStat[] val)
Lends the value of 'series' Field Description Application Series Stats NOTE: It is illegal to hold onto an entity 'set' on a message post the disposal of the container message. |
void |
lendSeriesFrom(XIterator<SrvMonUserSeriesStat> val)
Sets the value of 'series' by lending the values from the provided iterator. |
void |
setCounters(SrvMonUserCounterStat[] val)
Sets the value of 'counters' Field Description Application Counter Stats |
void |
setCountersFrom(XIterator<SrvMonUserCounterStat> val)
Sets the value of 'counters' using the values from the provided iterator. |
void |
setGauges(SrvMonUserGaugeStat[] val)
Sets the value of 'gauges' Field Description Application Gauge Stats |
void |
setGaugesFrom(XIterator<SrvMonUserGaugeStat> val)
Sets the value of 'gauges' using the values from the provided iterator. |
void |
setSeries(SrvMonUserSeriesStat[] val)
Sets the value of 'series' Field Description Application Series Stats |
void |
setSeriesFrom(XIterator<SrvMonUserSeriesStat> val)
Sets the value of 'series' using the values from the provided iterator. |
SrvMonUserCounterStat[] |
takeCounters()
Takes the value of 'counters' Field Description Application Counter Stats NOTE: A nested entity reference returned by getCounters() 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. |
SrvMonUserGaugeStat[] |
takeGauges()
Takes the value of 'gauges' Field Description Application Gauge Stats NOTE: A nested entity reference returned by getGauges() 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. |
SrvMonUserSeriesStat[] |
takeSeries()
Takes the value of 'series' Field Description Application Series Stats NOTE: A nested entity reference returned by getSeries() 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. |
| Methods inherited from interface com.neeve.rog.IRogValidatable |
|---|
getValidationErrors, isValid |
| Method Detail |
|---|
void setCounters(SrvMonUserCounterStat[] val)
val - The value to set.void setCountersFrom(XIterator<SrvMonUserCounterStat> 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 'counters' accessor can copy the values without iteration.
NOTE:
Passing a null or empty list has the same affect as calling setCounters(SrvMonUserCounterStat[]) with
a value of null.
val - the values to set.void lendCountersFrom(XIterator<SrvMonUserCounterStat> 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 'counters' accessor can copy the values without iteration.
NOTE:
Passing a null or empty list has the same affect as calling setCounters(SrvMonUserCounterStat[]) with
a value of null.
val - the values to set.void addCounters(SrvMonUserCounterStat val)
This method is zero garbage for Xbuf generated classes, and this method is optimized such that calling this with an iterator from another 'counters' 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 lendCounters(SrvMonUserCounterStat 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 'counters' 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<SrvMonUserCounterStat> getCountersIterator()
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 lendCounters(SrvMonUserCounterStat[] 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.SrvMonUserCounterStat[] getCounters()
If the field is not set this method will return null.
null.SrvMonUserCounterStat[] getCountersEmptyIfNull()
null or not set.
null if not set.getCounters()SrvMonUserCounterStat[] takeCounters()
NOTE:
A nested entity reference returned by getCounters() 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 clearCounters()
setCounters(SrvMonUserCounterStat[])void setSeries(SrvMonUserSeriesStat[] val)
val - The value to set.void setSeriesFrom(XIterator<SrvMonUserSeriesStat> 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 'series' accessor can copy the values without iteration.
NOTE:
Passing a null or empty list has the same affect as calling setSeries(SrvMonUserSeriesStat[]) with
a value of null.
val - the values to set.void lendSeriesFrom(XIterator<SrvMonUserSeriesStat> 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 'series' accessor can copy the values without iteration.
NOTE:
Passing a null or empty list has the same affect as calling setSeries(SrvMonUserSeriesStat[]) with
a value of null.
val - the values to set.void addSeries(SrvMonUserSeriesStat val)
This method is zero garbage for Xbuf generated classes, and this method is optimized such that calling this with an iterator from another 'series' 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 lendSeries(SrvMonUserSeriesStat 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 'series' 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<SrvMonUserSeriesStat> getSeriesIterator()
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 lendSeries(SrvMonUserSeriesStat[] 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.SrvMonUserSeriesStat[] getSeries()
If the field is not set this method will return null.
null.SrvMonUserSeriesStat[] getSeriesEmptyIfNull()
null or not set.
null if not set.getSeries()SrvMonUserSeriesStat[] takeSeries()
NOTE:
A nested entity reference returned by getSeries() 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 clearSeries()
setSeries(SrvMonUserSeriesStat[])void setGauges(SrvMonUserGaugeStat[] val)
val - The value to set.void setGaugesFrom(XIterator<SrvMonUserGaugeStat> 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 'gauges' accessor can copy the values without iteration.
NOTE:
Passing a null or empty list has the same affect as calling setGauges(SrvMonUserGaugeStat[]) with
a value of null.
val - the values to set.void lendGaugesFrom(XIterator<SrvMonUserGaugeStat> 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 'gauges' accessor can copy the values without iteration.
NOTE:
Passing a null or empty list has the same affect as calling setGauges(SrvMonUserGaugeStat[]) with
a value of null.
val - the values to set.void addGauges(SrvMonUserGaugeStat val)
This method is zero garbage for Xbuf generated classes, and this method is optimized such that calling this with an iterator from another 'gauges' 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 lendGauges(SrvMonUserGaugeStat 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 'gauges' 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<SrvMonUserGaugeStat> getGaugesIterator()
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 lendGauges(SrvMonUserGaugeStat[] 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.SrvMonUserGaugeStat[] getGauges()
If the field is not set this method will return null.
null.SrvMonUserGaugeStat[] getGaugesEmptyIfNull()
null or not set.
null if not set.getGauges()SrvMonUserGaugeStat[] takeGauges()
NOTE:
A nested entity reference returned by getGauges() 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 clearGauges()
setGauges(SrvMonUserGaugeStat[])
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||