ErrorContext (Eagle Core API)

java.lang.Object
- com.neeve.service.messages.ErrorContext

All Implemented Interfaces:: IRogValidatable, IErrorContext

@Generated(value="com.neeve.adm.AdmJsonGenerator",
           date="Fri Dec 05 11:53:59 EST 2025")
 @AdmGenerated(encoding="Json",
              compatLevel="4.1.0",
              admVersion="Unknown Version",
              date="12/5/25 11:53 AM",
              buildInfo="nvx-eagle-2.9-SNAPSHOT Json Encoding")
 @AdmFactoryInfo(factoryClass=MessageFactory.class,
                vfid=132,
                ofid=132,
                typeId=1001)
public final class ErrorContext
extends Object
implements IErrorContext

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.

Field Summary

Fields
Modifier and Type Field and Description

static ErrorContext[] EMPTY_ARRAY
A preallocated empty array used to avoid garbage when returning empty arrays of this type.

Fields
Modifier and Type	Field and Description
`static ErrorContext[]`	`EMPTY_ARRAY` A preallocated empty array used to avoid garbage when returning empty arrays of this type.

Constructor Summary

Constructors
Constructor and Description

ErrorContext()

Constructors
Constructor and Description
`ErrorContext()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ErrorContext`	`acquire()`
`void`	`clearCode()` Clears the value of 'code'.
`void`	`clearContent()`
`void`	`clearDescription()` Clears the value of 'description'.
`void`	`clearExtInfo()` Clears the value of 'extInfo'.
`void`	`clearType()` Clears the value of 'type'.
`Object`	`clone()` Creates a clone of this object.
`ErrorContext`	`copy()`
`void`	`copyInto(ErrorContext copy)`
`static ErrorContext`	`create()`
`static ErrorContext`	`createFrom(byte[] serializedJson)`
`static ErrorContext`	`createFromJson(String json)`
`static ErrorContext`	`createFromSerializedJson(byte[] serializedJson)`
`static ErrorContext`	`createFromSerializedJson(ByteBuffer serializedJson)`
`ErrorContext`	`deserializeFromByteArray(byte[] array)`
`ErrorContext`	`deserializeFromByteBuffer(ByteBuffer buffer)`
`ErrorContext`	`deserializeFromNative(long address, int addressOffset, int length)`
`void`	`dispose()`
`ErrorCode`	`getCode()` Gets the value of 'code'.
`static int`	`getCodeFieldId()`
`String`	`getDescription()` Gets the value of 'description'.
`static int`	`getDescriptionFieldId()`
`<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'.
`static int`	`getExtInfoFieldId()`
`<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'.
`boolean`	`getIsReadOnly()`
`int`	`getOwnerCount()`
`int`	`getSerializeToNativeLength()`
`ErrorType`	`getType()` Gets the value of 'type'.
`static int`	`getTypeFieldId()`
`void`	`getValidationErrors(List<XString> results, String errorPrefix)`
`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'.
`boolean`	`isBufferBacked()`
`boolean`	`isReferenceCounted()`
`boolean`	`isValid()`
`void`	`lendDescription(XString val)` Lends the value of 'description' to this object.
`void`	`lendExtInfo(XString val)` Lends the value of 'extInfo' to this object.
`byte[]`	`serializeToByteArray()`
`ByteBuffer`	`serializeToByteBuffer()`
`int`	`serializeToNative(long address, int addressOffset)`
`void`	`setAsReadOnly()`
`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'.
`String`	`toString()`

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - EMPTY_ARRAY
```
public static final ErrorContext[] EMPTY_ARRAY
```
    A preallocated empty array used to avoid garbage when returning empty arrays of this type.
- Constructor Detail
  - ErrorContext
```
public ErrorContext()
```
- Method Detail
  - create
```
public static ErrorContext create()
```
  - createFromJson
```
public static ErrorContext createFromJson(String json)
```
  - createFromSerializedJson
```
public static ErrorContext createFromSerializedJson(ByteBuffer serializedJson)
```
  - createFromSerializedJson
```
public static ErrorContext createFromSerializedJson(byte[] serializedJson)
```
  - createFrom
```
public static ErrorContext createFrom(byte[] serializedJson)
```
  - clearContent
```
public final void clearContent()
```
  - setAsReadOnly
```
public final void setAsReadOnly()
```
  - getIsReadOnly
```
public final boolean getIsReadOnly()
```
  - getTypeFieldId
```
public static final int getTypeFieldId()
```
  - setType
```
public final void setType(ErrorType val)
```
    Description copied from interface: IErrorContext
    
    Sets the value of 'type'.
    
    Specified by:
    
    setType in interface IErrorContext
    
    Parameters:
    
    val - The value to set.
  - getType
```
public final ErrorType getType()
```
    Description copied from interface: IErrorContext
    
    Gets the value of 'type'.
    
    Specified by:
    
    getType in interface IErrorContext
    
    Returns:
    
    The value of 'type'
  - clearType
```
public final void clearType()
```
    Description copied from interface: IErrorContext
    
    Clears the value of 'type'.
    
    Specified by:
    
    clearType in interface IErrorContext
    
    See Also:
    
    IErrorContext.setType(ErrorType)
  - hasType
```
public final boolean hasType()
```
    Description copied from interface: IErrorContext
    
    Checks for the presence of 'type'.
    
    Specified by:
    
    hasType in interface IErrorContext
    
    See Also:
    
    IErrorContext.getType()
  - getCodeFieldId
```
public static final int getCodeFieldId()
```
  - setCode
```
public final void setCode(ErrorCode val)
```
    Description copied from interface: IErrorContext
    
    Sets the value of 'code'.
    
    Specified by:
    
    setCode in interface IErrorContext
    
    Parameters:
    
    val - The value to set.
  - getCode
```
public final ErrorCode getCode()
```
    Description copied from interface: IErrorContext
    
    Gets the value of 'code'.
    
    Specified by:
    
    getCode in interface IErrorContext
    
    Returns:
    
    The value of 'code'
  - clearCode
```
public final void clearCode()
```
    Description copied from interface: IErrorContext
    
    Clears the value of 'code'.
    
    Specified by:
    
    clearCode in interface IErrorContext
    
    See Also:
    
    IErrorContext.setCode(ErrorCode)
  - hasCode
```
public final boolean hasCode()
```
    Description copied from interface: IErrorContext
    
    Checks for the presence of 'code'.
    
    Specified by:
    
    hasCode in interface IErrorContext
    
    See Also:
    
    IErrorContext.getCode()
  - getDescriptionFieldId
```
public static final int getDescriptionFieldId()
```
  - setDescription
```
public final void setDescription(String val)
```
    Description copied from interface: IErrorContext
    
    Sets the value of 'description'.
    
    Specified by:
    
    setDescription in interface IErrorContext
    
    Parameters:
    
    val - The value to set.
  - getDescription
```
public final String getDescription()
```
    Description copied from interface: IErrorContext
    
    Gets the value of 'description'.
    
    Specified by:
    
    getDescription in interface IErrorContext
    
    Returns:
    
    The value of 'description'
  - lendDescription
```
public final void lendDescription(XString val)
```
    Description copied from interface: IErrorContext
    
    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.
    
    Specified by:
    
    lendDescription in interface IErrorContext
    
    Parameters:
    
    val - The value to set.
  - setDescriptionFrom
```
public final void setDescriptionFrom(long val)
```
    Description copied from interface: IErrorContext
    
    Sets the value of this String field to the given numeric value.
    NOTE:
    This is the same as calling IErrorContext.setDescription(String). with Long.valueOf(val).toString(), except that using this method is a zero garbage operation for Xbuf encoding.
    
    Specified by:
    
    setDescriptionFrom in interface IErrorContext
  - getDescriptionTo
```
public final <T extends XString> T getDescriptionTo(XString.Factory<T> factory)
```
    Description copied from interface: IErrorContext
    
    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;
    
    Specified by:
    
    getDescriptionTo in interface IErrorContext
    
    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.
  - setDescriptionFrom
```
public final void setDescriptionFrom(XString val)
```
    Description copied from interface: IErrorContext
    
    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 IErrorContext.setDescription(String) because it avoids encoding the value into a String if the given XString is already encoded.
    
    Specified by:
    
    setDescriptionFrom in interface IErrorContext
  - getDescriptionTo
```
public final void getDescriptionTo(XString val)
```
    Description copied from interface: IErrorContext
    
    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 IErrorContext.getDescription() bec because it can avoid decoding the value into an String.
    
    Specified by:
    
    getDescriptionTo in interface IErrorContext
    
    See Also:
    
    IErrorContext.getDescription()
  - getDescriptionUnsafe
```
public final XString getDescriptionUnsafe()
```
    Description copied from interface: IErrorContext
    
    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.
    
    Specified by:
    
    getDescriptionUnsafe in interface IErrorContext
    
    Returns:
    
    the field's raw value
    
    See Also:
    
    IErrorContext.getDescription()
  - clearDescription
```
public final void clearDescription()
```
    Description copied from interface: IErrorContext
    
    Clears the value of 'description'.
    
    Specified by:
    
    clearDescription in interface IErrorContext
    
    See Also:
    
    IErrorContext.setDescription(String)
  - hasDescription
```
public final boolean hasDescription()
```
    Description copied from interface: IErrorContext
    
    Checks for the presence of 'description'.
    
    Specified by:
    
    hasDescription in interface IErrorContext
    
    See Also:
    
    IErrorContext.getDescription()
  - getExtInfoFieldId
```
public static final int getExtInfoFieldId()
```
  - setExtInfo
```
public final void setExtInfo(String val)
```
    Description copied from interface: IErrorContext
    
    Sets the value of 'extInfo'.
    
    Specified by:
    
    setExtInfo in interface IErrorContext
    
    Parameters:
    
    val - The value to set.
  - getExtInfo
```
public final String getExtInfo()
```
    Description copied from interface: IErrorContext
    
    Gets the value of 'extInfo'.
    
    Specified by:
    
    getExtInfo in interface IErrorContext
    
    Returns:
    
    The value of 'extInfo'
  - lendExtInfo
```
public final void lendExtInfo(XString val)
```
    Description copied from interface: IErrorContext
    
    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.
    
    Specified by:
    
    lendExtInfo in interface IErrorContext
    
    Parameters:
    
    val - The value to set.
  - setExtInfoFrom
```
public final void setExtInfoFrom(long val)
```
    Description copied from interface: IErrorContext
    
    Sets the value of this String field to the given numeric value.
    NOTE:
    This is the same as calling IErrorContext.setExtInfo(String). with Long.valueOf(val).toString(), except that using this method is a zero garbage operation for Xbuf encoding.
    
    Specified by:
    
    setExtInfoFrom in interface IErrorContext
  - getExtInfoTo
```
public final <T extends XString> T getExtInfoTo(XString.Factory<T> factory)
```
    Description copied from interface: IErrorContext
    
    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;
    
    Specified by:
    
    getExtInfoTo in interface IErrorContext
    
    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.
  - setExtInfoFrom
```
public final void setExtInfoFrom(XString val)
```
    Description copied from interface: IErrorContext
    
    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 IErrorContext.setExtInfo(String) because it avoids encoding the value into a String if the given XString is already encoded.
    
    Specified by:
    
    setExtInfoFrom in interface IErrorContext
  - getExtInfoTo
```
public final void getExtInfoTo(XString val)
```
    Description copied from interface: IErrorContext
    
    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 IErrorContext.getExtInfo() bec because it can avoid decoding the value into an String.
    
    Specified by:
    
    getExtInfoTo in interface IErrorContext
    
    See Also:
    
    IErrorContext.getExtInfo()
  - getExtInfoUnsafe
```
public final XString getExtInfoUnsafe()
```
    Description copied from interface: IErrorContext
    
    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.
    
    Specified by:
    
    getExtInfoUnsafe in interface IErrorContext
    
    Returns:
    
    the field's raw value
    
    See Also:
    
    IErrorContext.getExtInfo()
  - clearExtInfo
```
public final void clearExtInfo()
```
    Description copied from interface: IErrorContext
    
    Clears the value of 'extInfo'.
    
    Specified by:
    
    clearExtInfo in interface IErrorContext
    
    See Also:
    
    IErrorContext.setExtInfo(String)
  - hasExtInfo
```
public final boolean hasExtInfo()
```
    Description copied from interface: IErrorContext
    
    Checks for the presence of 'extInfo'.
    
    Specified by:
    
    hasExtInfo in interface IErrorContext
    
    See Also:
    
    IErrorContext.getExtInfo()
  - serializeToByteArray
```
public final byte[] serializeToByteArray()
```
  - serializeToByteBuffer
```
public final ByteBuffer serializeToByteBuffer()
```
  - isBufferBacked
```
public final boolean isBufferBacked()
```
  - getSerializeToNativeLength
```
public final int getSerializeToNativeLength()
```
  - serializeToNative
```
public final int serializeToNative(long address,
                                   int addressOffset)
```
  - deserializeFromByteArray
```
public final ErrorContext deserializeFromByteArray(byte[] array)
```
  - deserializeFromByteBuffer
```
public final ErrorContext deserializeFromByteBuffer(ByteBuffer buffer)
```
  - deserializeFromNative
```
public final ErrorContext deserializeFromNative(long address,
                                                int addressOffset,
                                                int length)
```
  - isReferenceCounted
```
public final boolean isReferenceCounted()
```
  - acquire
```
public final ErrorContext acquire()
```
  - getOwnerCount
```
public final int getOwnerCount()
```
  - dispose
```
public final void dispose()
```
  - clone
```
public final Object clone()
```
    Creates a clone of this object.
    This method differs from the copy() method in that:
    - For protobuf and xbuf generated objects pass-through fields are not preserved. Pass through fields are fields not defined by ADM model that generated this class, but may exist in the backing buffer or protobuf message for the object.
    - The copy method may replace empty arrays with a null value whereas this method preserves empty array fields.
    Overrides:
    
    clone in class Object
  - copy
```
public final ErrorContext copy()
```
  - copyInto
```
public final void copyInto(ErrorContext copy)
```
  - isValid
```
public final boolean isValid()
```
    Specified by:
    
    isValid in interface IRogValidatable
  - getValidationErrors
```
public final void getValidationErrors(List<XString> results,
                                      String errorPrefix)
```
    Specified by:
    
    getValidationErrors in interface IRogValidatable
  - toString
```
public final String toString()
```
    Overrides:
    
    toString in class Object

Class ErrorContext

ADM Details

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

EMPTY_ARRAY

Constructor Detail

ErrorContext

Method Detail

create

createFromJson

createFromSerializedJson

createFromSerializedJson

createFrom

clearContent

setAsReadOnly

getIsReadOnly

getTypeFieldId

setType

getType

clearType

hasType

getCodeFieldId

setCode

getCode

clearCode

hasCode

getDescriptionFieldId

setDescription

getDescription

lendDescription

Usage Notes

setDescriptionFrom

getDescriptionTo

setDescriptionFrom

getDescriptionTo

getDescriptionUnsafe

clearDescription

hasDescription

getExtInfoFieldId

setExtInfo

getExtInfo

lendExtInfo

Usage Notes

setExtInfoFrom

getExtInfoTo

setExtInfoFrom

getExtInfoTo

getExtInfoUnsafe

clearExtInfo

hasExtInfo

serializeToByteArray

serializeToByteBuffer

isBufferBacked

getSerializeToNativeLength

serializeToNative

deserializeFromByteArray

deserializeFromByteBuffer

deserializeFromNative

isReferenceCounted

acquire

getOwnerCount

dispose

clone

copy

copyInto

isValid

getValidationErrors

toString