org.takes.rq

Class RqHeaders.Smart

java.lang.Object

org.takes.rq.RqHeaders.Smart

All Implemented Interfaces:

Request, RqHeaders

Enclosing interface:

RqHeaders

public static final class RqHeaders.Smart
extends Object
implements RqHeaders

Smart decorator, with extra features.

The class is immutable and thread-safe.

Since:

0.16

Author:

Yegor Bugayenko ([email protected])

Nested Class Summary

Nested classes/interfaces inherited from interface org.takes.rq.RqHeaders

RqHeaders.Base, RqHeaders.Smart

Constructor Summary

Constructors

Constructor and Description
RqHeaders.Smart(Request req) Ctor.
RqHeaders.Smart(RqHeaders req) Ctor.

Method Summary

Methods

Modifier and Type	Method and Description
InputStream	body() HTTP request body.
Iterable<String>	head() All lines above the body.
List<String>	header(CharSequence name) Get single header.
Set<String>	names() Get all header names.
String	single(CharSequence name) Get single header or throw HTTP exception.
String	single(CharSequence name, CharSequence def) If header is present, returns the first header value.

Methods inherited from class java.lang.Object

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

Constructor Detail

RqHeaders.Smart

public RqHeaders.Smart(RqHeaders req)

Ctor.

Parameters:

req - Original request

RqHeaders.Smart

public RqHeaders.Smart(Request req)

Ctor.

Parameters:

req - Original request

Method Detail

header

public List<String> header(CharSequence name)
                    throws IOException

Description copied from interface: RqHeaders

Get single header.

Specified by:

header in interface RqHeaders

Parameters:

name - Header name

Returns:

List of values (can be empty)

Throws:

IOException - If fails

names

public Set<String> names()
                  throws IOException

Description copied from interface: RqHeaders

Get all header names.

Specified by:

names in interface RqHeaders

Returns:

All names

Throws:

IOException - If fails

head

public Iterable<String> head()
                      throws IOException

Description copied from interface: Request

All lines above the body.

Specified by:

head in interface Request

Returns:

List of lines

Throws:

IOException - If something goes wrong

body

public InputStream body()
                 throws IOException

Description copied from interface: Request

HTTP request body.

Specified by:

body in interface Request

Returns:

Stream with body

Throws:

IOException - If something goes wrong

single

public String single(CharSequence name)
              throws IOException

Get single header or throw HTTP exception.

Parameters:

name - Name of header

Returns:

Value of it

Throws:

IOException - If fails

single

public String single(CharSequence name,
            CharSequence def)
              throws IOException

If header is present, returns the first header value. If not, returns a default value.

Parameters:

name - Name of header key

def - Default value

Returns:

Header Value or default value

Throws:

IOException - If fails