com.neeve.server.mon

Interface ISrvMonAppBusChannelInfo

All Superinterfaces:

IRogValidatable

All Known Implementing Classes:

SrvMonAppBusChannelInfo

@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 ISrvMonAppBusChannelInfo
extends IRogValidatable

Holds information about a message bus binding channel.

ADM Details

ADM Type	Embedded Entity
Factory	SrvMonFactory

ADM Field Summary

Field	Type	Id	Description
joined	Boolean	2	Whether or not this channel has been joined.
name	String	1	The channel name.

Method Summary

Methods

Modifier and Type	Method and Description
void	clearJoined() Clears the value of 'joined'.
void	clearName() Clears the value of 'name'.
boolean	getJoined() Gets the value of 'joined'.
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'.
boolean	hasJoined() Checks for the presence of 'joined'.
boolean	hasName() Checks for the presence of 'name'.
void	lendName(XString val) Lends the value of 'name' to this object.
void	setJoined(boolean val) Sets the value of 'joined'.
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'.

Methods inherited from interface com.neeve.rog.IRogValidatable

getValidationErrors, isValid

Method Detail

setJoined

void setJoined(boolean val)

Sets the value of 'joined'.

Field Description

Whether or not this channel has been joined.

Parameters:

val - The value to set.

getJoined

boolean getJoined()

Gets the value of 'joined'.

Field Description

Whether or not this channel has been joined.

Returns:

Whether or not this channel has been joined.

clearJoined

void clearJoined()

Clears the value of 'joined'.

Field Description

Whether or not this channel has been joined.

See Also:

setJoined(boolean)

hasJoined

boolean hasJoined()

Checks for the presence of 'joined'.

Field Description

Whether or not this channel has been joined.

See Also:

getJoined()

setName

void setName(String val)

Sets the value of 'name'.

Field Description

The channel name.

Parameters:

val - The value to set.

getName

String getName()

Gets the value of 'name'.

Field Description

The channel name.

Returns:

The channel 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 channel 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 channel 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 channel 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 channel 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 channel 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 channel 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 channel name.

See Also:

setName(String)

hasName

boolean hasName()

Checks for the presence of 'name'.

Field Description

The channel name.

See Also:

getName()