com.neeve.service.messages

Interface IErrorContext

All Superinterfaces:

IRogValidatable

All Known Implementing Classes:

ErrorContext

@Generated(value="com.neeve.adm.AdmGenerator",
           date="Fri Dec 05 11:53:59 EST 2025")
 @AdmGenerated(compatLevel="4.1.0",
              admVersion="Unknown Version",
              date="12/5/25 11:53 AM",
              buildInfo="nvx-eagle-2.9-SNAPSHOT Json Encoding")
public interface IErrorContext
extends IRogValidatable

The 'ErrorContext' type.

ADM Details

ADM Type	Embedded Entity
Factory	MessageFactory

ADM Field Summary

Field	Type	Id	Description
code	ErrorCode	32736	No doc provided.
description	String	32735	No doc provided.
extInfo	String	32734	No doc provided.
type	ErrorType	32737	No doc provided.

Method Summary

Modifier and Type	Method and Description
void	clearCode() Clears the value of 'code'.
void	clearDescription() Clears the value of 'description'.
void	clearExtInfo() Clears the value of 'extInfo'.
void	clearType() Clears the value of 'type'.
ErrorCode	getCode() Gets the value of 'code'.
String	getDescription() Gets the value of 'description'.
<T extends XString> T	getDescriptionTo(XString.Factory<T> factory) Copies the value of this String field into a new XString from the given factory.
void	getDescriptionTo(XString val) Copies the value of 'description' into the provided XString.
XString	getDescriptionUnsafe() Gets the raw value of 'description'.
String	getExtInfo() Gets the value of 'extInfo'.
<T extends XString> T	getExtInfoTo(XString.Factory<T> factory) Copies the value of this String field into a new XString from the given factory.
void	getExtInfoTo(XString val) Copies the value of 'extInfo' into the provided XString.
XString	getExtInfoUnsafe() Gets the raw value of 'extInfo'.
ErrorType	getType() Gets the value of 'type'.
boolean	hasCode() Checks for the presence of 'code'.
boolean	hasDescription() Checks for the presence of 'description'.
boolean	hasExtInfo() Checks for the presence of 'extInfo'.
boolean	hasType() Checks for the presence of 'type'.
void	lendDescription(XString val) Lends the value of 'description' to this object.
void	lendExtInfo(XString val) Lends the value of 'extInfo' to this object.
void	setCode(ErrorCode val) Sets the value of 'code'.
void	setDescription(String val) Sets the value of 'description'.
void	setDescriptionFrom(long val) Sets the value of this String field to the given numeric value.
void	setDescriptionFrom(XString val) Copies the provided XString value into this object's 'description'.
void	setExtInfo(String val) Sets the value of 'extInfo'.
void	setExtInfoFrom(long val) Sets the value of this String field to the given numeric value.
void	setExtInfoFrom(XString val) Copies the provided XString value into this object's 'extInfo'.
void	setType(ErrorType val) Sets the value of 'type'.

Methods inherited from interface com.neeve.rog.IRogValidatable

getValidationErrors, isValid

Method Detail

setType

void setType(ErrorType val)

Sets the value of 'type'.

Parameters:

val - The value to set.

getType

ErrorType getType()

Gets the value of 'type'.

Returns:

The value of 'type'

clearType

void clearType()

Clears the value of 'type'.

See Also:

setType(ErrorType)

hasType

boolean hasType()

Checks for the presence of 'type'.

See Also:

getType()

setCode

void setCode(ErrorCode val)

Sets the value of 'code'.

Parameters:

val - The value to set.

getCode

ErrorCode getCode()

Gets the value of 'code'.

Returns:

The value of 'code'

clearCode

void clearCode()

Clears the value of 'code'.

See Also:

setCode(ErrorCode)

hasCode

boolean hasCode()

Checks for the presence of 'code'.

See Also:

getCode()

setDescription

void setDescription(String val)

Sets the value of 'description'.

Parameters:

val - The value to set.

getDescription

String getDescription()

Gets the value of 'description'.

Returns:

The value of 'description'

lendDescription

void lendDescription(XString val)

Lends the value of 'description' to this object.

This method is equivalent to setDescription 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.

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.

setDescriptionFrom

void setDescriptionFrom(long val)

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

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

getDescriptionTo

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

Copies the value of this String field into a new XString from the given 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;

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

setDescriptionFrom

void setDescriptionFrom(XString val)

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

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

getDescriptionTo

void getDescriptionTo(XString val)

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

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

See Also:

getDescription()

getDescriptionUnsafe

XString getDescriptionUnsafe()

Gets the raw value of 'description'.

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:

getDescription()

clearDescription

void clearDescription()

Clears the value of 'description'.

See Also:

setDescription(String)

hasDescription

boolean hasDescription()

Checks for the presence of 'description'.

See Also:

getDescription()

setExtInfo

void setExtInfo(String val)

Sets the value of 'extInfo'.

Parameters:

val - The value to set.

getExtInfo

String getExtInfo()

Gets the value of 'extInfo'.

Returns:

The value of 'extInfo'

lendExtInfo

void lendExtInfo(XString val)

Lends the value of 'extInfo' to this object.

This method is equivalent to setExtInfo 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.

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.

setExtInfoFrom

void setExtInfoFrom(long val)

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

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

getExtInfoTo

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

Copies the value of this String field into a new XString from the given 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;

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

setExtInfoFrom

void setExtInfoFrom(XString val)

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

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

getExtInfoTo

void getExtInfoTo(XString val)

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

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

See Also:

getExtInfo()

getExtInfoUnsafe

XString getExtInfoUnsafe()

Gets the raw value of 'extInfo'.

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:

getExtInfo()

clearExtInfo

void clearExtInfo()

Clears the value of 'extInfo'.

See Also:

setExtInfo(String)

hasExtInfo

boolean hasExtInfo()

Checks for the presence of 'extInfo'.

See Also:

getExtInfo()