com.neeve.server.mon

Interface ISrvMonAppBusBindingInfo

All Superinterfaces:

IRogValidatable

All Known Implementing Classes:

SrvMonAppBusBindingInfo

@Generated(value="com.neeve.adm.AdmGenerator",
           date="Thu May 07 15:37:32 EDT 2020")
@AdmGenerated(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)")
public interface ISrvMonAppBusBindingInfo
extends IRogValidatable

Holds information about a message bus binding.

ADM Details

ADM Type	Embedded Entity
Factory	SrvMonFactory

ADM Field Summary

Field	Type	Id	Description
channelsInfo	SrvMonAppBusChannelInfo[]	3	Holds channel info for the bus channels.
name	String	1	The bus name.
state	SrvMonAppBusBindingState	2	The current bus state.

Method Summary

Methods

Modifier and Type	Method and Description
void	addChannelsInfo(SrvMonAppBusChannelInfo val) Adds the provided value to the list of 'channelsInfo' values.
void	clearChannelsInfo() Clears the value of 'channelsInfo'.
void	clearName() Clears the value of 'name'.
void	clearState() Clears the value of 'state'.
SrvMonAppBusChannelInfo[]	getChannelsInfo() Gets the value of 'channelsInfo'.
SrvMonAppBusChannelInfo[]	getChannelsInfoEmptyIfNull() Gets the value of 'channelsInfo' or an empty array if the value is null or not set.
XIterator<SrvMonAppBusChannelInfo>	getChannelsInfoIterator() Gets the value of 'channelsInfo' as iterator of values.
String	getName() Gets the value of 'name'.
<T extends XString> T	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'.
SrvMonAppBusBindingState	getState() Gets the value of 'state'.
boolean	hasName() Checks for the presence of 'name'.
boolean	hasState() Checks for the presence of 'state'.
void	lendChannelsInfo(SrvMonAppBusChannelInfo val) Adds the provided value to the list of 'channelsInfo' values and acquires a reference to it.
void	lendChannelsInfo(SrvMonAppBusChannelInfo[] val) Lends the value of 'channelsInfo'.
void	lendChannelsInfoFrom(XIterator<SrvMonAppBusChannelInfo> val) Sets the value of 'channelsInfo' by lending the values from the provided iterator.
void	lendName(XString val) Lends the value of 'name' to this object.
void	setChannelsInfo(SrvMonAppBusChannelInfo[] val) Sets the value of 'channelsInfo'.
void	setChannelsInfoFrom(XIterator<SrvMonAppBusChannelInfo> val) Sets the value of 'channelsInfo' using the values from the provided iterator.
void	setName(String val) Sets the value of '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	setState(SrvMonAppBusBindingState val) Sets the value of 'state'.
SrvMonAppBusChannelInfo[]	takeChannelsInfo() Takes the value of 'channelsInfo'.

Methods inherited from interface com.neeve.rog.IRogValidatable

getValidationErrors, isValid

Method Detail

setState

void setState(SrvMonAppBusBindingState val)

Sets the value of 'state'.

Field Description

The current bus state.

Parameters:

val - The value to set.

getState

SrvMonAppBusBindingState getState()

Gets the value of 'state'.

Field Description

The current bus state.

Returns:

The current bus state.

clearState

void clearState()

Clears the value of 'state'.

Field Description

The current bus state.

See Also:

setState(SrvMonAppBusBindingState)

hasState

boolean hasState()

Checks for the presence of 'state'.

Field Description

The current bus state.

See Also:

getState()

setName

void setName(String val)

Sets the value of 'name'.

Field Description

The bus name.

Parameters:

val - The value to set.

getName

String getName()

Gets the value of 'name'.

Field Description

The bus name.

Returns:

The bus name.

lendName

void lendName(XString val)

Lends the value of 'name' to this object.

This method is equivalent to setName except that it allows this object to defer copying the value until this object is next serialized. This means that the caller must not modify or dispose the value being passed in to this method.

Field Description

The bus name.

Usage Notes

Note that implementations of this method are not strictly required to defer copying the value, this method only provides the hint to this object that it may defer copy. The caller must ensure that the value value is immutable and not disposed regardless.

Note, also, that unlike lendXXX methods for embedded entities, this method does not attempt to acquire or dispose of the value passed in even if the value is poolable.

Parameters:

val - The value to set.

Throws:

IllegalArgumentException - If the value is mutable.

setNameFrom

void setNameFrom(long val)

Sets the value of this String field to the given numeric value.

Field Description

The bus name.

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.

getNameTo

<T extends XString> T getNameTo(XString.Factory<T> factory)

Copies the value of this String field into a new XString from the given factory.

Field Description

The bus name.

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;

Parameters:

factory - The factory from which to get the XString to copy into and return

Returns:

a new XString from the provided factory if this field is set or null.

Throws:

NullPointerException - if the provided factory is null

setNameFrom

void setNameFrom(XString val)

Copies the provided XString value into this object's 'name'.

Field Description

The bus name.

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.

getNameTo

void getNameTo(XString val)

Copies the value of 'name' into the provided XString.

Field Description

The bus name.

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.

See Also:

getName()

getNameUnsafe

XString getNameUnsafe()

Gets the raw value of 'name'.

Field Description

The bus name.

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.

Returns:

the field's raw value

See Also:

getName()

clearName

void clearName()

Clears the value of 'name'.

Field Description

The bus name.

See Also:

setName(String)

hasName

boolean hasName()

Checks for the presence of 'name'.

Field Description

The bus name.

See Also:

getName()

setChannelsInfo

void setChannelsInfo(SrvMonAppBusChannelInfo[] val)

Sets the value of 'channelsInfo'.

Field Description

Holds channel info for the bus channels.

Parameters:

val - The value to set.

setChannelsInfoFrom

void setChannelsInfoFrom(XIterator<SrvMonAppBusChannelInfo> val)

Sets the value of 'channelsInfo' using the values from the provided iterator.

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 'channelsInfo' accessor can copy the values without iteration.

Field Description

Holds channel info for the bus channels.

NOTE:
Passing a null or empty list has the same affect as calling setChannelsInfo(SrvMonAppBusChannelInfo[]) with a value of null.

Parameters:

val - the values to set.

lendChannelsInfoFrom

void lendChannelsInfoFrom(XIterator<SrvMonAppBusChannelInfo> val)

Sets the value of 'channelsInfo' by lending the values from the provided iterator.

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 'channelsInfo' accessor can copy the values without iteration.

Field Description

Holds channel info for the bus channels.

NOTE:
Passing a null or empty list has the same affect as calling setChannelsInfo(SrvMonAppBusChannelInfo[]) with a value of null.

Parameters:

val - the values to set.

addChannelsInfo

void addChannelsInfo(SrvMonAppBusChannelInfo val)

Adds the provided value to the list of 'channelsInfo' values.

This method is zero garbage for Xbuf generated classes, and this method is optimized such that calling this with an iterator from another 'channelsInfo' 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.

Field Description

Holds channel info for the bus channels.

Parameters:

val - the value to add.

lendChannelsInfo

void lendChannelsInfo(SrvMonAppBusChannelInfo val)

Adds the provided value to the list of 'channelsInfo' values and acquires a reference to it.

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 'channelsInfo' 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.

Field Description

Holds channel info for the bus channels.

Parameters:

val - the value to add.

getChannelsInfoIterator

XIterator<SrvMonAppBusChannelInfo> getChannelsInfoIterator()

Gets the value of 'channelsInfo' as iterator of values.

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 it intends to keep beyond the either the next call to next(), toFirst() or the lifespace of this object as each object returned by this iterator is disposed on a subsequent call to next() or when this object is disposed.

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 method can perform a direct copy of the underlying values without iteration.

Field Description

Holds channel info for the bus channels.

Returns:

An iterator containing this field values.

lendChannelsInfo

void lendChannelsInfo(SrvMonAppBusChannelInfo[] val)

Lends the value of 'channelsInfo'.

Field Description

Holds channel info for the bus channels.

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.

Parameters:

val - the value to 'lend' to lend.

getChannelsInfo

SrvMonAppBusChannelInfo[] getChannelsInfo()

Gets the value of 'channelsInfo'.

If the field is not set this method will return null.

Field Description

Holds channel info for the bus channels.

Returns:

Holds channel info for the bus channels. If the field is not set this method will return null.

getChannelsInfoEmptyIfNull

SrvMonAppBusChannelInfo[] getChannelsInfoEmptyIfNull()

Gets the value of 'channelsInfo' or an empty array if the value is null or not set.

Field Description

Holds channel info for the bus channels.

Returns:

Holds channel info for the bus channels. or an empty array if null if not set.

See Also:

getChannelsInfo()

takeChannelsInfo

SrvMonAppBusChannelInfo[] takeChannelsInfo()

Takes the value of 'channelsInfo'.

Field Description

Holds channel info for the bus channels.

NOTE:
A nested entity reference returned by getChannelsInfo() 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.

Returns:

a 'taken' reference to the field or null if the field is not set.

clearChannelsInfo

void clearChannelsInfo()

Clears the value of 'channelsInfo'.

Field Description

Holds channel info for the bus channels.

See Also:

setChannelsInfo(SrvMonAppBusChannelInfo[])