com.neeve.server.mon.cnc

Interface ISrvMonTrace

All Superinterfaces:

IRogValidatable

All Known Subinterfaces:

ISrvMonTraceRecord

All Known Implementing Classes:

SrvMonTrace, SrvMonTraceRecord

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

Encapsulates trace logging output.

ADM Details

ADM Type	Embedded Entity
Factory	SrvMonCncFactory

ADM Field Summary

Field	Type	Id	Description
hostAddress	String	9	The host address (if available).
hostName	String	10	The host name (if available).
level	SrvMonTraceLevel	3	The trace level (if available).
processId	String	7	The process id (if available).
threadId	Long	5	The thread id (if available).
timestamp	Long	6	The timestamp (if available).
trace	String	1	The trace output.
tracerName	String	4	The tracer name (if available).
xvmName	String	8	The XVM name (if available).

Method Summary

Methods

Modifier and Type	Method and Description
void	clearHostAddress() Clears the value of 'hostAddress'.
void	clearHostName() Clears the value of 'hostName'.
void	clearLevel() Clears the value of 'level'.
void	clearProcessId() Clears the value of 'processId'.
void	clearThreadId() Clears the value of 'threadId'.
void	clearTimestamp() Clears the value of 'timestamp'.
void	clearTrace() Clears the value of 'trace'.
void	clearTracerName() Clears the value of 'tracerName'.
void	clearXvmName() Clears the value of 'xvmName'.
String	getHostAddress() Gets the value of 'hostAddress'.
<T extends XString> T	getHostAddressTo(XString.Factory<T> factory) Copies the value of this String field into a new XString from the given factory.
void	getHostAddressTo(XString val) Copies the value of 'hostAddress' into the provided XString.
XString	getHostAddressUnsafe() Gets the raw value of 'hostAddress'.
String	getHostName() Gets the value of 'hostName'.
<T extends XString> T	getHostNameTo(XString.Factory<T> factory) Copies the value of this String field into a new XString from the given factory.
void	getHostNameTo(XString val) Copies the value of 'hostName' into the provided XString.
XString	getHostNameUnsafe() Gets the raw value of 'hostName'.
SrvMonTraceLevel	getLevel() Gets the value of 'level'.
String	getProcessId() Gets the value of 'processId'.
<T extends XString> T	getProcessIdTo(XString.Factory<T> factory) Copies the value of this String field into a new XString from the given factory.
void	getProcessIdTo(XString val) Copies the value of 'processId' into the provided XString.
XString	getProcessIdUnsafe() Gets the raw value of 'processId'.
long	getThreadId() Gets the value of 'threadId'.
long	getTimestamp() Gets the value of 'timestamp'.
String	getTrace() Gets the value of 'trace'.
String	getTracerName() Gets the value of 'tracerName'.
<T extends XString> T	getTracerNameTo(XString.Factory<T> factory) Copies the value of this String field into a new XString from the given factory.
void	getTracerNameTo(XString val) Copies the value of 'tracerName' into the provided XString.
XString	getTracerNameUnsafe() Gets the raw value of 'tracerName'.
<T extends XString> T	getTraceTo(XString.Factory<T> factory) Copies the value of this String field into a new XString from the given factory.
void	getTraceTo(XString val) Copies the value of 'trace' into the provided XString.
XString	getTraceUnsafe() Gets the raw value of 'trace'.
String	getXvmName() Gets the value of 'xvmName'.
<T extends XString> T	getXvmNameTo(XString.Factory<T> factory) Copies the value of this String field into a new XString from the given factory.
void	getXvmNameTo(XString val) Copies the value of 'xvmName' into the provided XString.
XString	getXvmNameUnsafe() Gets the raw value of 'xvmName'.
boolean	hasHostAddress() Checks for the presence of 'hostAddress'.
boolean	hasHostName() Checks for the presence of 'hostName'.
boolean	hasLevel() Checks for the presence of 'level'.
boolean	hasProcessId() Checks for the presence of 'processId'.
boolean	hasThreadId() Checks for the presence of 'threadId'.
boolean	hasTimestamp() Checks for the presence of 'timestamp'.
boolean	hasTrace() Checks for the presence of 'trace'.
boolean	hasTracerName() Checks for the presence of 'tracerName'.
boolean	hasXvmName() Checks for the presence of 'xvmName'.
void	lendHostAddress(XString val) Lends the value of 'hostAddress' to this object.
void	lendHostName(XString val) Lends the value of 'hostName' to this object.
void	lendProcessId(XString val) Lends the value of 'processId' to this object.
void	lendTrace(XString val) Lends the value of 'trace' to this object.
void	lendTracerName(XString val) Lends the value of 'tracerName' to this object.
void	lendXvmName(XString val) Lends the value of 'xvmName' to this object.
void	setHostAddress(String val) Sets the value of 'hostAddress'.
void	setHostAddressFrom(long val) Sets the value of this String field to the given numeric value.
void	setHostAddressFrom(XString val) Copies the provided XString value into this object's 'hostAddress'.
void	setHostName(String val) Sets the value of 'hostName'.
void	setHostNameFrom(long val) Sets the value of this String field to the given numeric value.
void	setHostNameFrom(XString val) Copies the provided XString value into this object's 'hostName'.
void	setLevel(SrvMonTraceLevel val) Sets the value of 'level'.
void	setProcessId(String val) Sets the value of 'processId'.
void	setProcessIdFrom(long val) Sets the value of this String field to the given numeric value.
void	setProcessIdFrom(XString val) Copies the provided XString value into this object's 'processId'.
void	setThreadId(long val) Sets the value of 'threadId'.
void	setTimestamp(long val) Sets the value of 'timestamp'.
void	setTrace(String val) Sets the value of 'trace'.
void	setTraceFrom(long val) Sets the value of this String field to the given numeric value.
void	setTraceFrom(XString val) Copies the provided XString value into this object's 'trace'.
void	setTracerName(String val) Sets the value of 'tracerName'.
void	setTracerNameFrom(long val) Sets the value of this String field to the given numeric value.
void	setTracerNameFrom(XString val) Copies the provided XString value into this object's 'tracerName'.
void	setXvmName(String val) Sets the value of 'xvmName'.
void	setXvmNameFrom(long val) Sets the value of this String field to the given numeric value.
void	setXvmNameFrom(XString val) Copies the provided XString value into this object's 'xvmName'.

Methods inherited from interface com.neeve.rog.IRogValidatable

getValidationErrors, isValid

Method Detail

setLevel

void setLevel(SrvMonTraceLevel val)

Sets the value of 'level'.

Field Description

The trace level (if available).

Parameters:

val - The value to set.

getLevel

SrvMonTraceLevel getLevel()

Gets the value of 'level'.

Field Description

The trace level (if available).

Returns:

The trace level (if available).

clearLevel

void clearLevel()

Clears the value of 'level'.

Field Description

The trace level (if available).

See Also:

setLevel(SrvMonTraceLevel)

hasLevel

boolean hasLevel()

Checks for the presence of 'level'.

Field Description

The trace level (if available).

See Also:

getLevel()

setThreadId

void setThreadId(long val)

Sets the value of 'threadId'.

Field Description

The thread id (if available).

Parameters:

val - The value to set.

getThreadId

long getThreadId()

Gets the value of 'threadId'.

Field Description

The thread id (if available).

Returns:

The thread id (if available).

clearThreadId

void clearThreadId()

Clears the value of 'threadId'.

Field Description

The thread id (if available).

See Also:

setThreadId(long)

hasThreadId

boolean hasThreadId()

Checks for the presence of 'threadId'.

Field Description

The thread id (if available).

See Also:

getThreadId()

setTimestamp

void setTimestamp(long val)

Sets the value of 'timestamp'.

Field Description

The timestamp (if available).

Parameters:

val - The value to set.

getTimestamp

long getTimestamp()

Gets the value of 'timestamp'.

Field Description

The timestamp (if available).

Returns:

The timestamp (if available).

clearTimestamp

void clearTimestamp()

Clears the value of 'timestamp'.

Field Description

The timestamp (if available).

See Also:

setTimestamp(long)

hasTimestamp

boolean hasTimestamp()

Checks for the presence of 'timestamp'.

Field Description

The timestamp (if available).

See Also:

getTimestamp()

setTrace

void setTrace(String val)

Sets the value of 'trace'.

Field Description

The trace output.

Parameters:

val - The value to set.

getTrace

String getTrace()

Gets the value of 'trace'.

Field Description

The trace output.

Returns:

The trace output.

lendTrace

void lendTrace(XString val)

Lends the value of 'trace' to this object.

This method is equivalent to setTrace 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 trace output.

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.

setTraceFrom

void setTraceFrom(long val)

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

Field Description

The trace output.

NOTE:
This is the same as calling setTrace(String). with Long.valueOf(val).toString(), except that using this method is a zero garbage operation for Xbuf encoding.

getTraceTo

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

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

Field Description

The trace output.

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

setTraceFrom

void setTraceFrom(XString val)

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

Field Description

The trace output.

NOTE:
This is a Zero Garbage operation for XBuf encoded objects. Additionally, this setter can be more efficient than setTrace(String) because it avoids encoding the value into a String if the given XString is already encoded.

getTraceTo

void getTraceTo(XString val)

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

Field Description

The trace output.

NOTE:
This is a Zero Garbage operation for XBuf encoded objects. Additionally, this getter can be more efficient than getTrace() bec because it can avoid decoding the value into an String.

See Also:

getTrace()

getTraceUnsafe

XString getTraceUnsafe()

Gets the raw value of 'trace'.

Field Description

The trace output.

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:

getTrace()

clearTrace

void clearTrace()

Clears the value of 'trace'.

Field Description

The trace output.

See Also:

setTrace(String)

hasTrace

boolean hasTrace()

Checks for the presence of 'trace'.

Field Description

The trace output.

See Also:

getTrace()

setTracerName

void setTracerName(String val)

Sets the value of 'tracerName'.

Field Description

The tracer name (if available).

Parameters:

val - The value to set.

getTracerName

String getTracerName()

Gets the value of 'tracerName'.

Field Description

The tracer name (if available).

Returns:

The tracer name (if available).

lendTracerName

void lendTracerName(XString val)

Lends the value of 'tracerName' to this object.

This method is equivalent to setTracerName 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 tracer name (if available).

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.

setTracerNameFrom

void setTracerNameFrom(long val)

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

Field Description

The tracer name (if available).

NOTE:
This is the same as calling setTracerName(String). with Long.valueOf(val).toString(), except that using this method is a zero garbage operation for Xbuf encoding.

getTracerNameTo

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

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

Field Description

The tracer name (if available).

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

setTracerNameFrom

void setTracerNameFrom(XString val)

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

Field Description

The tracer name (if available).

NOTE:
This is a Zero Garbage operation for XBuf encoded objects. Additionally, this setter can be more efficient than setTracerName(String) because it avoids encoding the value into a String if the given XString is already encoded.

getTracerNameTo

void getTracerNameTo(XString val)

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

Field Description

The tracer name (if available).

NOTE:
This is a Zero Garbage operation for XBuf encoded objects. Additionally, this getter can be more efficient than getTracerName() bec because it can avoid decoding the value into an String.

See Also:

getTracerName()

getTracerNameUnsafe

XString getTracerNameUnsafe()

Gets the raw value of 'tracerName'.

Field Description

The tracer name (if available).

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:

getTracerName()

clearTracerName

void clearTracerName()

Clears the value of 'tracerName'.

Field Description

The tracer name (if available).

See Also:

setTracerName(String)

hasTracerName

boolean hasTracerName()

Checks for the presence of 'tracerName'.

Field Description

The tracer name (if available).

See Also:

getTracerName()

setProcessId

void setProcessId(String val)

Sets the value of 'processId'.

Field Description

The process id (if available).

Parameters:

val - The value to set.

getProcessId

String getProcessId()

Gets the value of 'processId'.

Field Description

The process id (if available).

Returns:

The process id (if available).

lendProcessId

void lendProcessId(XString val)

Lends the value of 'processId' to this object.

This method is equivalent to setProcessId 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 process id (if available).

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.

setProcessIdFrom

void setProcessIdFrom(long val)

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

Field Description

The process id (if available).

NOTE:
This is the same as calling setProcessId(String). with Long.valueOf(val).toString(), except that using this method is a zero garbage operation for Xbuf encoding.

getProcessIdTo

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

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

Field Description

The process id (if available).

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

setProcessIdFrom

void setProcessIdFrom(XString val)

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

Field Description

The process id (if available).

NOTE:
This is a Zero Garbage operation for XBuf encoded objects. Additionally, this setter can be more efficient than setProcessId(String) because it avoids encoding the value into a String if the given XString is already encoded.

getProcessIdTo

void getProcessIdTo(XString val)

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

Field Description

The process id (if available).

NOTE:
This is a Zero Garbage operation for XBuf encoded objects. Additionally, this getter can be more efficient than getProcessId() bec because it can avoid decoding the value into an String.

See Also:

getProcessId()

getProcessIdUnsafe

XString getProcessIdUnsafe()

Gets the raw value of 'processId'.

Field Description

The process id (if available).

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:

getProcessId()

clearProcessId

void clearProcessId()

Clears the value of 'processId'.

Field Description

The process id (if available).

See Also:

setProcessId(String)

hasProcessId

boolean hasProcessId()

Checks for the presence of 'processId'.

Field Description

The process id (if available).

See Also:

getProcessId()

setXvmName

void setXvmName(String val)

Sets the value of 'xvmName'.

Field Description

The XVM name (if available).

Parameters:

val - The value to set.

getXvmName

String getXvmName()

Gets the value of 'xvmName'.

Field Description

The XVM name (if available).

Returns:

The XVM name (if available).

lendXvmName

void lendXvmName(XString val)

Lends the value of 'xvmName' to this object.

This method is equivalent to setXvmName 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 XVM name (if available).

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.

setXvmNameFrom

void setXvmNameFrom(long val)

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

Field Description

The XVM name (if available).

NOTE:
This is the same as calling setXvmName(String). with Long.valueOf(val).toString(), except that using this method is a zero garbage operation for Xbuf encoding.

getXvmNameTo

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

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

Field Description

The XVM name (if available).

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

setXvmNameFrom

void setXvmNameFrom(XString val)

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

Field Description

The XVM name (if available).

NOTE:
This is a Zero Garbage operation for XBuf encoded objects. Additionally, this setter can be more efficient than setXvmName(String) because it avoids encoding the value into a String if the given XString is already encoded.

getXvmNameTo

void getXvmNameTo(XString val)

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

Field Description

The XVM name (if available).

NOTE:
This is a Zero Garbage operation for XBuf encoded objects. Additionally, this getter can be more efficient than getXvmName() bec because it can avoid decoding the value into an String.

See Also:

getXvmName()

getXvmNameUnsafe

XString getXvmNameUnsafe()

Gets the raw value of 'xvmName'.

Field Description

The XVM name (if available).

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:

getXvmName()

clearXvmName

void clearXvmName()

Clears the value of 'xvmName'.

Field Description

The XVM name (if available).

See Also:

setXvmName(String)

hasXvmName

boolean hasXvmName()

Checks for the presence of 'xvmName'.

Field Description

The XVM name (if available).

See Also:

getXvmName()

setHostAddress

void setHostAddress(String val)

Sets the value of 'hostAddress'.

Field Description

The host address (if available).

Parameters:

val - The value to set.

getHostAddress

String getHostAddress()

Gets the value of 'hostAddress'.

Field Description

The host address (if available).

Returns:

The host address (if available).

lendHostAddress

void lendHostAddress(XString val)

Lends the value of 'hostAddress' to this object.

This method is equivalent to setHostAddress 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 host address (if available).

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.

setHostAddressFrom

void setHostAddressFrom(long val)

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

Field Description

The host address (if available).

NOTE:
This is the same as calling setHostAddress(String). with Long.valueOf(val).toString(), except that using this method is a zero garbage operation for Xbuf encoding.

getHostAddressTo

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

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

Field Description

The host address (if available).

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

setHostAddressFrom

void setHostAddressFrom(XString val)

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

Field Description

The host address (if available).

NOTE:
This is a Zero Garbage operation for XBuf encoded objects. Additionally, this setter can be more efficient than setHostAddress(String) because it avoids encoding the value into a String if the given XString is already encoded.

getHostAddressTo

void getHostAddressTo(XString val)

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

Field Description

The host address (if available).

NOTE:
This is a Zero Garbage operation for XBuf encoded objects. Additionally, this getter can be more efficient than getHostAddress() bec because it can avoid decoding the value into an String.

See Also:

getHostAddress()

getHostAddressUnsafe

XString getHostAddressUnsafe()

Gets the raw value of 'hostAddress'.

Field Description

The host address (if available).

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:

getHostAddress()

clearHostAddress

void clearHostAddress()

Clears the value of 'hostAddress'.

Field Description

The host address (if available).

See Also:

setHostAddress(String)

hasHostAddress

boolean hasHostAddress()

Checks for the presence of 'hostAddress'.

Field Description

The host address (if available).

See Also:

getHostAddress()

setHostName

void setHostName(String val)

Sets the value of 'hostName'.

Field Description

The host name (if available).

Parameters:

val - The value to set.

getHostName

String getHostName()

Gets the value of 'hostName'.

Field Description

The host name (if available).

Returns:

The host name (if available).

lendHostName

void lendHostName(XString val)

Lends the value of 'hostName' to this object.

This method is equivalent to setHostName 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 host name (if available).

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.

setHostNameFrom

void setHostNameFrom(long val)

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

Field Description

The host name (if available).

NOTE:
This is the same as calling setHostName(String). with Long.valueOf(val).toString(), except that using this method is a zero garbage operation for Xbuf encoding.

getHostNameTo

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

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

Field Description

The host name (if available).

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

setHostNameFrom

void setHostNameFrom(XString val)

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

Field Description

The host name (if available).

NOTE:
This is a Zero Garbage operation for XBuf encoded objects. Additionally, this setter can be more efficient than setHostName(String) because it avoids encoding the value into a String if the given XString is already encoded.

getHostNameTo

void getHostNameTo(XString val)

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

Field Description

The host name (if available).

NOTE:
This is a Zero Garbage operation for XBuf encoded objects. Additionally, this getter can be more efficient than getHostName() bec because it can avoid decoding the value into an String.

See Also:

getHostName()

getHostNameUnsafe

XString getHostNameUnsafe()

Gets the raw value of 'hostName'.

Field Description

The host name (if available).

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:

getHostName()

clearHostName

void clearHostName()

Clears the value of 'hostName'.

Field Description

The host name (if available).

See Also:

setHostName(String)

hasHostName

boolean hasHostName()

Checks for the presence of 'hostName'.

Field Description

The host name (if available).

See Also:

getHostName()