Package org.projectnessie.error

Class ImmutableNessieError

java.lang.Object

org.projectnessie.error.ImmutableNessieError

All Implemented Interfaces:

NessieError

@ParametersAreNonnullByDefault
@Generated("org.immutables.processor.ProxyProcessor")
@Immutable
@CheckReturnValue
public final class ImmutableNessieError
extends Object
implements NessieError

Immutable implementation of NessieError.

Use the builder to create immutable instances: ImmutableNessieError.builder().

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ImmutableNessieError.Builder	Builds instances of type ImmutableNessieError.

Method Summary

Modifier and Type	Method	Description
static ImmutableNessieError.Builder	builder()	Creates a builder for ImmutableNessieError.
static ImmutableNessieError	copyOf(NessieError instance)	Creates an immutable copy of a NessieError value.
boolean	equals(Object another)	This instance is equal to all instances of ImmutableNessieError that have equal attribute values.
Exception	getClientProcessingException()	Client-side Exception related to the processing of the error response.
ErrorCode	getErrorCode()	Nessie-specific error code.
String	getMessage()	Nessie-specific Error message.
String	getReason()	Reason phrase for the HTTP status code.
String	getServerStackTrace()	Server-side exception stack trace related to this error (if available).
int	getStatus()	HTTP status code of this error.
int	hashCode()	Computes a hash code from attributes: status, reason, message, errorCode, serverStackTrace.
String	toString()	Prints the immutable value NessieError with attribute values.
ImmutableNessieError	withClientProcessingException(Exception value)	Copy the current immutable object by setting a value for the clientProcessingException attribute.
ImmutableNessieError	withErrorCode(ErrorCode value)	Copy the current immutable object by setting a value for the errorCode attribute.
ImmutableNessieError	withMessage(String value)	Copy the current immutable object by setting a value for the message attribute.
ImmutableNessieError	withReason(String value)	Copy the current immutable object by setting a value for the reason attribute.
ImmutableNessieError	withServerStackTrace(String value)	Copy the current immutable object by setting a value for the serverStackTrace attribute.
ImmutableNessieError	withStatus(int value)	Copy the current immutable object by setting a value for the status attribute.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.projectnessie.error.NessieError

getFullMessage

Method Detail

getStatus

public int getStatus()

HTTP status code of this error.

Specified by:

getStatus in interface NessieError

getReason

public String getReason()

Reason phrase for the HTTP status code.

Specified by:

getReason in interface NessieError

getMessage

public String getMessage()

Nessie-specific Error message.

Specified by:

getMessage in interface NessieError

getErrorCode

public ErrorCode getErrorCode()

Nessie-specific error code.

Specified by:

getErrorCode in interface NessieError

getServerStackTrace

@Nullable
public String getServerStackTrace()

Server-side exception stack trace related to this error (if available).

Specified by:

getServerStackTrace in interface NessieError

getClientProcessingException

@Nullable
public Exception getClientProcessingException()

Client-side Exception related to the processing of the error response.

This Exception generally represents any errors related to the decoding of the payload returned by the server to describe the error.

Specified by:

getClientProcessingException in interface NessieError

withStatus

public final ImmutableNessieError withStatus(int value)

Copy the current immutable object by setting a value for the status attribute. A value equality check is used to prevent copying of the same value by returning this.

Parameters:

value - A new value for status

Returns:

A modified copy of the this object

withReason

public final ImmutableNessieError withReason(String value)

Copy the current immutable object by setting a value for the reason attribute. An equals check used to prevent copying of the same value by returning this.

Parameters:

value - A new value for reason

Returns:

A modified copy of the this object

withMessage

public final ImmutableNessieError withMessage(String value)

Copy the current immutable object by setting a value for the message attribute. An equals check used to prevent copying of the same value by returning this.

Parameters:

value - A new value for message

Returns:

A modified copy of the this object

withErrorCode

public final ImmutableNessieError withErrorCode(ErrorCode value)

Copy the current immutable object by setting a value for the errorCode attribute. A value equality check is used to prevent copying of the same value by returning this.

Parameters:

value - A new value for errorCode

Returns:

A modified copy of the this object

withServerStackTrace

public final ImmutableNessieError withServerStackTrace(@Nullable
                                                       String value)

Copy the current immutable object by setting a value for the serverStackTrace attribute. An equals check used to prevent copying of the same value by returning this.

Parameters:

value - A new value for serverStackTrace (can be null)

Returns:

A modified copy of the this object

withClientProcessingException

public final ImmutableNessieError withClientProcessingException(@Nullable
                                                                Exception value)

Copy the current immutable object by setting a value for the clientProcessingException attribute. A shallow reference equality check is used to prevent copying of the same value by returning this.

Parameters:

value - A new value for clientProcessingException (can be null)

Returns:

A modified copy of the this object

equals

public boolean equals(@Nullable
                      Object another)

This instance is equal to all instances of ImmutableNessieError that have equal attribute values.

Overrides:

equals in class Object

Returns:

true if this is equal to another instance

hashCode

public int hashCode()

Computes a hash code from attributes: status, reason, message, errorCode, serverStackTrace.

Overrides:

hashCode in class Object

Returns:

hashCode value

toString

public String toString()

Prints the immutable value NessieError with attribute values.

Overrides:

toString in class Object

Returns:

A string representation of the value

copyOf

public static ImmutableNessieError copyOf(NessieError instance)

Creates an immutable copy of a NessieError value. Uses accessors to get values to initialize the new immutable instance. If an instance is already immutable, it is returned as is.

Parameters:

instance - The instance to copy

Returns:

A copied immutable NessieError instance

builder

public static ImmutableNessieError.Builder builder()

Creates a builder for ImmutableNessieError.

 ImmutableNessieError.builder()
    .status(int) // required status
    .reason(String) // required reason
    .message(String) // optional message
    .errorCode(org.projectnessie.error.ErrorCode) // optional errorCode
    .serverStackTrace(String | null) // nullable serverStackTrace
    .clientProcessingException(Exception | null) // nullable clientProcessingException
    .build();
 

Returns:

A new ImmutableNessieError builder