Record Class RequestResult<REQ extends Request<?>, REP extends Result<REQ>>

java.lang.Object

java.lang.Record

org.apache.maven.api.cache.RequestResult<REQ,REP>

Type Parameters:

REQ - The type of the request

REP - The type of the response, which must extend Result<REQ>

Record Components:

request - The original request that was processed

result - The result of the request, if successful; may be null if an error occurred

error - Any error that occurred during processing; null if the request was successful

@Experimental
public record RequestResult<REQ extends Request<?>, REP extends Result<REQ>>(REQ extends Request<?> request, REP extends Result<REQ> result, Throwable error)
extends Record

A record representing the result of a single request operation, containing the original request, the result (if successful), and any error that occurred during processing.

This class is immutable and thread-safe, suitable for use in concurrent operations.

Since:

4.0.0

Constructor Summary

Constructors

Constructor	Description
RequestResult(REQ request, REP result, Throwable error)	Creates an instance of a RequestResult record class.

Method Summary

Modifier and Type	Method	Description
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
Throwable	error()	Returns the value of the error record component.
final int	hashCode()	Returns a hash code value for this object.
boolean	isSuccess()	Determines if the request was processed successfully.
REQ	request()	Returns the value of the request record component.
REP	result()	Returns the value of the result record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class java.lang.Object

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

Constructor Details

RequestResult

public RequestResult(REQ request,
 REP result,
 Throwable error)

Creates an instance of a RequestResult record class.

Parameters:

request - the value for the request record component

result - the value for the result record component

error - the value for the error record component

Method Details

isSuccess

public boolean isSuccess()

Determines if the request was processed successfully.

Returns:

true if no error occurred during processing (error is null), false otherwise

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

request

public REQ request()

Returns the value of the request record component.

Returns:

the value of the request record component

result

public REP result()

Returns the value of the result record component.

Returns:

the value of the result record component

error

public Throwable error()

Returns the value of the error record component.

Returns:

the value of the error record component