Package org.apache.juneau.rest.arg

Class ArgException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

org.apache.juneau.BasicRuntimeException

org.apache.juneau.http.response.BasicHttpException

org.apache.juneau.http.response.InternalServerError

org.apache.juneau.rest.arg.ArgException

All Implemented Interfaces:

Serializable, HttpMessage, HttpResponse

public class ArgException
extends InternalServerError

General exception due to a malformed Java parameter.

See Also:

• Java Method Parameters

Field Summary

Fields inherited from class org.apache.juneau.http.response.InternalServerError

INSTANCE, REASON_PHRASE, STATUS_CODE

Constructor Summary

Constructors

Modifier	Constructor	Description
	ArgException(ParameterInfo pi, String msg, Object... args)	Constructor.
protected	ArgException(ArgException copyFrom)	Copy constructor.

Method Summary

Modifier and Type	Method	Description
ArgException	copy()	Creates a modifiable copy of this bean.
ArgException	setContent(String value)	Sets the body on this response.
ArgException	setContent(HttpEntity value)	Sets the body on this response.
ArgException	setHeader2(String name, Object value)	Sets a header on this response.
ArgException	setHeaders(List<Header> values)	Sets the specified headers on this response.
ArgException	setHeaders(HeaderList value)	Sets the specified headers on this response.
ArgException	setHeaders2(Header... values)	Sets multiple headers on this response.
ArgException	setLocale2(Locale value)	Sets the locale used to retrieve reason phrases.
ArgException	setMessage(String message, Object... args)	Sets the detail message on this exception.
ArgException	setProtocolVersion(ProtocolVersion value)	Sets the protocol version on the status line.
ArgException	setReasonPhrase2(String value)	Sets the reason phrase on the status line.
ArgException	setReasonPhraseCatalog(ReasonPhraseCatalog value)	Sets the reason phrase catalog used to retrieve reason phrases.
ArgException	setStatusLine(BasicStatusLine value)	Sets the protocol version on the status line.
ArgException	setUnmodifiable()	Specifies whether this bean should be unmodifiable.

Methods inherited from class org.apache.juneau.http.response.InternalServerError

setStatusCode2

Methods inherited from class org.apache.juneau.http.response.BasicHttpException

addHeader, addHeader, assertStatusCode, containsHeader, getAllHeaders, getEntity, getFirstHeader, getFullStackMessage, getHeaders, getHeaders, getLastHeader, getLocale, getMessage, getParams, getProtocolVersion, getRootCause, getStatusLine, hashCode, headerIterator, headerIterator, removeHeader, removeHeaders, setEntity, setHeader, setHeader, setHeaders, setLocale, setParams, setReasonPhrase, setStatusCode, setStatusLine, setStatusLine, setStatusLine, toString

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace

Methods inherited from class java.lang.Object

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

Constructor Details

ArgException

public ArgException(ParameterInfo pi,
 String msg,
 Object... args)

Constructor.

Parameters:

pi - The parameter with the issue.

msg - The message.

args - The message args.

ArgException

protected ArgException(ArgException copyFrom)

Copy constructor.

Parameters:

copyFrom - The object to copy.

Method Details

copy

public ArgException copy()

Description copied from class: InternalServerError

Creates a modifiable copy of this bean.

Overrides:

copy in class InternalServerError

Returns:

A new modifiable bean.

setContent

public ArgException setContent(HttpEntity value)

Description copied from class: BasicHttpException

Sets the body on this response.

Overrides:

setContent in class InternalServerError

Parameters:

value - The body on this response.

Returns:

This object.

setContent

public ArgException setContent(String value)

Description copied from class: BasicHttpException

Sets the body on this response.

Overrides:

setContent in class InternalServerError

Parameters:

value - The body on this response.

Returns:

This object.

setHeader2

public ArgException setHeader2(String name,
 Object value)

Description copied from class: BasicHttpException

Sets a header on this response.

Overrides:

setHeader2 in class InternalServerError

Parameters:

name - The header name.

value - The header value.

Returns:

This object.

setHeaders

public ArgException setHeaders(HeaderList value)

Description copied from class: BasicHttpException

Sets the specified headers on this response.

Overrides:

setHeaders in class InternalServerError

Parameters:

value - The new value.

Returns:

This object.

setHeaders

public ArgException setHeaders(List<Header> values)

Description copied from class: BasicHttpException

Sets the specified headers on this response.

Overrides:

setHeaders in class InternalServerError

Parameters:

values - The headers to set. null values are ignored.

Returns:

This object.

setHeaders2

public ArgException setHeaders2(Header... values)

Description copied from class: BasicHttpException

Sets multiple headers on this response.

Overrides:

setHeaders2 in class InternalServerError

Parameters:

values - The headers to add.

Returns:

This object.

setLocale2

public ArgException setLocale2(Locale value)

Description copied from class: BasicHttpException

Sets the locale used to retrieve reason phrases.

If not specified, uses Locale.getDefault().

Overrides:

setLocale2 in class InternalServerError

Parameters:

value - The new value.

Returns:

This object.

setMessage

public ArgException setMessage(String message,
 Object... args)

Description copied from class: BasicRuntimeException

Sets the detail message on this exception.

Overrides:

setMessage in class InternalServerError

Parameters:

message - The message.

args - The message args.

Returns:

This object.

setProtocolVersion

public ArgException setProtocolVersion(ProtocolVersion value)

Description copied from class: BasicHttpException

Sets the protocol version on the status line.

If not specified, "HTTP/1.1" will be used.

Overrides:

setProtocolVersion in class InternalServerError

Parameters:

value - The new value.

Returns:

This object.

setReasonPhrase2

public ArgException setReasonPhrase2(String value)

Description copied from class: BasicHttpException

Sets the reason phrase on the status line.

If not specified, the reason phrase will be retrieved from the reason phrase catalog using the locale on this builder.

Overrides:

setReasonPhrase2 in class InternalServerError

Parameters:

value - The new value.

Returns:

This object.

setReasonPhraseCatalog

public ArgException setReasonPhraseCatalog(ReasonPhraseCatalog value)

Description copied from class: BasicHttpException

Sets the reason phrase catalog used to retrieve reason phrases.

If not specified, uses EnglishReasonPhraseCatalog.

Overrides:

setReasonPhraseCatalog in class InternalServerError

Parameters:

value - The new value.

Returns:

This object.

setStatusLine

public ArgException setStatusLine(BasicStatusLine value)

Description copied from class: BasicHttpException

Sets the protocol version on the status line.

If not specified, "HTTP/1.1" will be used.

Overrides:

setStatusLine in class InternalServerError

Parameters:

value - The new value.

Returns:

This object.

setUnmodifiable

public ArgException setUnmodifiable()

Description copied from class: BasicHttpException

Specifies whether this bean should be unmodifiable.

When enabled, attempting to set any properties on this bean will cause an UnsupportedOperationException.

Overrides:

setUnmodifiable in class InternalServerError

Returns:

This object.