Class ResourceResponse.Builder

java.lang.Object

com.thecsdev.common.resource.ResourceResponse.Builder

Enclosing class:

ResourceResponse

public static final class ResourceResponse.Builder
extends Object

A builder class for constructing instances of ResourceResponse.

Field Summary

Fields

Modifier and Type	Field	Description
protected byte[]	data
protected final Map<String, List<String>>	metadata
protected final URI	uri

Constructor Summary

Constructors

Constructor	Description
Builder(@NotNull URI uri)
Builder(@NotNull URI uri, int status)

Method Summary

Modifier and Type	Method	Description
final @NotNull ResourceResponse.Builder	add(@NotNull String metadataName, @NotNull String metadataValue)	Adds a metadata entry to this ResourceMessage.
final ResourceResponse.Builder	addAll(@NotNull String metadataName, @NotNull com.google.gson.JsonArray metadataValues)	Adds multiple metadata values for the specified metadata name from a JsonArray.
final ResourceResponse.Builder	addAll(@NotNull String metadataName, @NotNull Collection<String> metadataValues)	Adds multiple metadata values for the specified metadata name.
ResourceResponse	build()	Builds and returns a new ResourceResponse instance based on the configured properties.
final @NotNull URI	getUri()	Returns the URI this ResourceMessage.AbstractBuilder is for.
final @NotNull ResourceResponse.Builder	set(@NotNull String metadataName, @NotNull String metadataValue)	Sets a metadata entry for this ResourceMessage, replacing any existing values associated with the specified metadata name.
final ResourceResponse.Builder	setData(byte @NotNull [] data)	Sets the raw byte data for the resource response.
final ResourceResponse.Builder	setStatus(int status)	Sets the status code for this ResourceResponse.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

uri

protected final URI uri

metadata

protected final Map<String, List<String>> metadata

data

protected byte[] data

Constructor Details

Builder

public Builder(@NotNull
 @NotNull URI uri)
        throws NullPointerException

Throws:

NullPointerException

Builder

public Builder(@NotNull
 @NotNull URI uri,
 int status)
        throws NullPointerException

Throws:

NullPointerException

Method Details

setStatus

public final ResourceResponse.Builder setStatus(int status)
                                         throws IllegalStateException

Sets the status code for this ResourceResponse.

Parameters:

status - The status code to set.

Returns:

The current ResourceResponse.Builder instance for method chaining.

Throws:

IllegalStateException - If this ResourceResponse.Builder already built a ResourceResponse.

add

@NotNull
public final @NotNull ResourceResponse.Builder add(@NotNull
 @NotNull String metadataName,
 @NotNull
 @NotNull String metadataValue)
                                            throws NullPointerException,
IllegalStateException

Adds a metadata entry to this ResourceMessage.

Parameters:

metadataName - The name of the metadata entry.

metadataValue - The value of the metadata entry.

Returns:

The current ResourceMessage.AbstractBuilder instance for method chaining.

Throws:

NullPointerException - If any argument is null.

IllegalStateException - If this ResourceMessage.AbstractBuilder already built a ResourceMessage.

addAll

public final ResourceResponse.Builder addAll(@NotNull
 @NotNull String metadataName,
 @NotNull
 @NotNull Collection<String> metadataValues)
                                      throws NullPointerException,
IllegalStateException

Adds multiple metadata values for the specified metadata name.

Parameters:

metadataName - The name of the metadata entry.

metadataValues - A collection of metadata values to add.

Returns:

The current ResourceMessage.AbstractBuilder instance for method chaining.

Throws:

NullPointerException - If any argument is null.

IllegalStateException - If this ResourceMessage.AbstractBuilder already built a ResourceMessage.

addAll

public final ResourceResponse.Builder addAll(@NotNull
 @NotNull String metadataName,
 @NotNull
 @NotNull com.google.gson.JsonArray metadataValues)
                                      throws NullPointerException,
IllegalStateException

Adds multiple metadata values for the specified metadata name from a JsonArray.

Parameters:

metadataName - The name of the metadata entry.

metadataValues - A JsonArray containing metadata values to add.

Returns:

The current ResourceMessage.AbstractBuilder instance for method chaining.

Throws:

NullPointerException - If any argument is null.

IllegalStateException - If this ResourceMessage.AbstractBuilder already built a ResourceMessage.

set

@NotNull
public final @NotNull ResourceResponse.Builder set(@NotNull
 @NotNull String metadataName,
 @NotNull
 @NotNull String metadataValue)
                                            throws NullPointerException,
IllegalStateException

Sets a metadata entry for this ResourceMessage, replacing any existing values associated with the specified metadata name.

Parameters:

metadataName - The name of the metadata entry.

metadataValue - The value of the metadata entry.

Returns:

The current ResourceMessage.AbstractBuilder instance for method chaining.

Throws:

NullPointerException - If any argument is null.

IllegalStateException - If this ResourceMessage.AbstractBuilder already built a ResourceMessage.

setData

public final ResourceResponse.Builder setData(byte @NotNull [] data)
                                       throws NullPointerException,
IllegalStateException

Sets the raw byte data for the resource response.

Parameters:

data - A byte array containing the resource data.

Returns:

The current ResourceMessage.AbstractBuilder instance for method chaining.

Throws:

NullPointerException - If the argument is null.

IllegalStateException - If this ResourceMessage.AbstractBuilder already built a ResourceMessage.

build

public ResourceResponse build()

Builds and returns a new ResourceResponse instance based on the configured properties.

Returns:

A new ResourceResponse instance.

getUri

@NotNull
public final @NotNull URI getUri()

Returns the URI this ResourceMessage.AbstractBuilder is for.