Package org.apache.juneau.http.classic.response

Class MultipleChoices

java.lang.Object

org.apache.juneau.http.classic.response.BasicHttpResponse<MultipleChoices>

org.apache.juneau.http.classic.response.MultipleChoices

All Implemented Interfaces:

HttpMessage, HttpResponse

Direct Known Subclasses:

MultipleChoices.Unmodifiable

@Response
@StatusCode(300)
@Schema(description="Multiple Choices")
public class MultipleChoices
extends BasicHttpResponse<MultipleChoices>

Represents an HTTP 300 Multiple Choices response.

Indicates multiple options for the resource from which the client may choose (via agent-driven content negotiation). For example, this code could be used to present multiple video format options, to list files with different filename extensions, or to suggest word-sense disambiguation.

See Also:

• juneau-rest-common

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	MultipleChoices.Unmodifiable	Unmodifiable point-in-time snapshot of the enclosing MultipleChoices response.

Field Summary

Fields

Modifier and Type	Field	Description
static final MultipleChoices	INSTANCE	Default unmodifiable instance
static final String	REASON_PHRASE	Reason phrase
static final int	STATUS_CODE	HTTP status code

Constructor Summary

Constructors

Constructor	Description
MultipleChoices()	Constructor.
MultipleChoices(HttpResponse response)	Constructor.
MultipleChoices(MultipleChoices copyFrom)	Copy constructor.

Method Summary

Modifier and Type	Method	Description
MultipleChoices	copy()	Creates a builder for this class initialized with the contents of this bean.
MultipleChoices	unmodifiable()	Returns an unmodifiable snapshot of this bean.

Methods inherited from class org.apache.juneau.http.classic.response.BasicHttpResponse

addHeader, addHeader, assertStatusCode, containsHeader, equals, freeze, getAllHeaders, getEntity, getFirstHeader, getHeaders, getHeaders, getLastHeader, getLocale, getParams, getProtocolVersion, getStatusLine, hashCode, headerIterator, headerIterator, isUnmodifiable, modify, removeHeader, removeHeaders, self, setContent, setContent, setEntity, setHeader, setHeader, setHeader2, setHeader2, setHeaders, setHeaders, setHeaders, setHeaders2, setLocale, setLocale2, setLocation, setLocation, setParams, setProtocolVersion, setReasonPhrase, setReasonPhrase2, setReasonPhraseCatalog, setStatusCode, setStatusCode2, setStatusLine, setStatusLine, setStatusLine, setStatusLine, toString

Methods inherited from class java.lang.Object

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

Field Details

STATUS_CODE

public static final int STATUS_CODE

HTTP status code

See Also:

• Constant Field Values

REASON_PHRASE

public static final String REASON_PHRASE

Reason phrase

See Also:

• Constant Field Values

INSTANCE

public static final MultipleChoices INSTANCE

Default unmodifiable instance

Constructor Details

MultipleChoices

public MultipleChoices()

Constructor.

MultipleChoices

public MultipleChoices(HttpResponse response)

Constructor.

This is the constructor used when parsing an HTTP response.

Parameters:

response - The HTTP response to copy from. Must not be null.

Throws:

IllegalArgumentException - If HTTP response status code does not match what was expected.

MultipleChoices

public MultipleChoices(MultipleChoices copyFrom)

Copy constructor.

Parameters:

copyFrom - The bean to copy from. Must not be null.

Method Details

copy

public MultipleChoices copy()

Creates a builder for this class initialized with the contents of this bean.

Returns:

A new builder bean.

unmodifiable

public MultipleChoices unmodifiable()

Description copied from class: BasicHttpResponse

Returns an unmodifiable snapshot of this bean.

The returned instance is a point-in-time copy of the leaf's nested Unmodifiable type; any attempt to set a property on it throws an UnsupportedOperationException. This method is idempotent: if this bean is already unmodifiable it returns itself rather than taking another snapshot. The receiver is left unchanged (and still modifiable unless it was already unmodifiable).

Specified by:

unmodifiable in class BasicHttpResponse<MultipleChoices>

Returns:

An unmodifiable snapshot of this bean, or this bean if it is already unmodifiable.