Package org.apache.juneau.rest.httppart

Class RequestAttribute

java.lang.Object

org.apache.juneau.rest.httppart.BasicNamedAttribute

org.apache.juneau.rest.httppart.RequestAttribute

All Implemented Interfaces:

NamedAttribute

public class RequestAttribute
extends BasicNamedAttribute

Represents a single request attribute on an HTTP request.

Typically accessed through the RequestAttributes class.

Some important methods on this class are:

• RequestAttribute
  • Methods for retrieving simple string values:
    • asString()
    • get()
    • isPresent()
    • orElse(Object)
  • Methods for retrieving as custom types:
    • as(Class)
  • Methods for performing assertion checks:
    • assertName()
    • assertValue()
  • Other methods:
    • getName()
    • getValue()

  See Also:

  • HTTP Parts

Constructor Summary

Constructors

Constructor	Description
RequestAttribute(RestRequest request, String name, Object value)	Constructor.

Method Summary

Modifier and Type	Method	Description
<T> Optional<T>	as(Class<T> type)	Converts this part to the specified POJO.
Optional<String>	asString()	Returns the value of this part as a string.

Methods inherited from class org.apache.juneau.rest.httppart.BasicNamedAttribute

assertName, assertValue, get, getName, getValue, isPresent, of, of, ofPair, orElse, toString

Methods inherited from class java.lang.Object

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

Constructor Details

RequestAttribute

public RequestAttribute(RestRequest request,
 String name,
 Object value)

Constructor.

Parameters:

request - The request object.

name - The parameter name.

value - The parameter value.

Method Details

asString

public Optional<String> asString()

Returns the value of this part as a string.

Returns:

The value of this part as a string, or Optional.empty() if the part was not present.

as

public <T> Optional<T> as(Class<T> type)

Converts this part to the specified POJO.

Type Parameters:

T - The type to convert to.

Parameters:

type - The type to convert to.

Returns:

The converted type, or Optional.empty() if the part is not present.

Throws:

BasicHttpException - If value could not be parsed.