Package org.apache.juneau.http

Class HttpParts

java.lang.Object

org.apache.juneau.http.HttpParts

public class HttpParts
extends Object

Standard predefined HTTP parts.

See Also:

• juneau-rest-common

Constructor Summary

Constructors

Constructor	Description
HttpParts()

Method Summary

Modifier and Type	Method	Description
static final BasicPart	basicPart(String pair)	Creates a BasicPart from a name/value pair string (e.g.
static final BasicPart	basicPart(String name, Object value)	Creates a new BasicPart part.
static final BasicPart	basicPart(String name, Supplier<?> value)	Creates a new BasicPart part with a delayed value.
static final BasicBooleanPart	booleanPart(String name, Boolean value)	Creates a new BasicBooleanPart part.
static final BasicBooleanPart	booleanPart(String name, Supplier<Boolean> value)	Creates a new BasicBooleanPart part with a delayed value.
static boolean	canCast(Object o)	Returns true if the cast(Object) method can be used on the specified object.
static NameValuePair	cast(Object o)	Utility method for converting an arbitrary object to a NameValuePair.
static final BasicCsvArrayPart	csvArrayPart(String name, String... value)	Creates a new BasicCsvArrayPart part.
static final BasicCsvArrayPart	csvArrayPart(String name, Supplier<String[]> value)	Creates a new BasicCsvArrayPart part with a delayed value.
static final BasicDatePart	datePart(String name, ZonedDateTime value)	Creates a new BasicDatePart part.
static final BasicDatePart	datePart(String name, Supplier<ZonedDateTime> value)	Creates a new BasicDatePart part with a delayed value.
static Optional<ConstructorInfo>	getConstructor(ClassMeta<?> type)	Returns the constructor for the specified type.
static Optional<String>	getName(HttpPartType partType, ClassMeta<?> type)	Returns the name of the specified part type.
static final BasicIntegerPart	integerPart(String name, Integer value)	Creates a new BasicIntegerPart part.
static final BasicIntegerPart	integerPart(String name, Supplier<Integer> value)	Creates a new BasicIntegerPart part with a delayed value.
static boolean	isHttpPart(HttpPartType partType, ClassMeta<?> type)	Returns true if the specified type is a part type.
static final BasicLongPart	longPart(String name, Long value)	Creates a new BasicLongPart part.
static final BasicLongPart	longPart(String name, Supplier<Long> value)	Creates a new BasicLongPart part with a delayed value.
static final PartList	partList()	Instantiates a new PartList.
static PartList	partList(String... pairs)	Creates a new PartList initialized with the specified name/value pairs.
static final PartList	partList(List<NameValuePair> parts)	Creates a new PartList initialized with the specified parts.
static final PartList	partList(NameValuePair... parts)	Creates a new PartList initialized with the specified parts.
static final SerializedPart	serializedPart(String name, Object value)	Creates a new SerializedPart part.
static final SerializedPart	serializedPart(String name, Supplier<?> value)	Creates a new SerializedPart part with a delayed value.
static final BasicStringPart	stringPart(String name, String value)	Creates a new BasicStringPart part.
static final BasicStringPart	stringPart(String name, Supplier<String> value)	Creates a new BasicStringPart part with a delayed value.
static final BasicUriPart	uriPart(String name, URI value)	Creates a new BasicUriPart part.
static final BasicUriPart	uriPart(String name, Supplier<URI> value)	Creates a new BasicUriPart part with a delayed value.

Methods inherited from class java.lang.Object

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

Constructor Details

HttpParts

public HttpParts()

Method Details

booleanPart

public static final BasicBooleanPart booleanPart(String name,
 Boolean value)

Creates a new BasicBooleanPart part.

Parameters:

name - The part name.

value - The part value.
Can be any of the following:

• Boolean - As-is.
• String - Parsed using Boolean.parseBoolean(String).
• Anything else - Converted to String and then parsed.

Returns:

A new BasicBooleanPart object, or null if the name or value is null.

booleanPart

public static final BasicBooleanPart booleanPart(String name,
 Supplier<Boolean> value)

Creates a new BasicBooleanPart part with a delayed value.

Part value is re-evaluated on each call to NameValuePair.getValue().

Parameters:

name - The part name.

value - The part value supplier.
Can be any of the following:

• Boolean - As-is.
• String - Parsed using Boolean.parseBoolean(String).
• Anything else - Converted to String and then parsed.

Returns:

A new BasicBooleanPart object, or null if the name or value is null.

csvArrayPart

public static final BasicCsvArrayPart csvArrayPart(String name,
 String... value)

Creates a new BasicCsvArrayPart part.

Parameters:

name - The part name.

value - The part value.
Can be any of the following:

• String - A comma-delimited string.
• String[] - A pre-parsed value.
• Any other array type - Converted to String[].
• Any Collection - Converted to String[].
• Anything else - Converted to String.

Returns:

A new BasicCsvArrayPart object, or null if the name or value is null.

csvArrayPart

public static final BasicCsvArrayPart csvArrayPart(String name,
 Supplier<String[]> value)

Creates a new BasicCsvArrayPart part with a delayed value.

Part value is re-evaluated on each call to NameValuePair.getValue().

Parameters:

name - The part name.

value - The part value supplier.
Can be any of the following:

• String - A comma-delimited string.
• String[] - A pre-parsed value.
• Any other array type - Converted to String[].
• Any Collection - Converted to String[].
• Anything else - Converted to String.

Returns:

A new BasicCsvArrayPart object, or null if the name or value is null.

datePart

public static final BasicDatePart datePart(String name,
 ZonedDateTime value)

Creates a new BasicDatePart part.

Parameters:

name - The part name.

value - The part value.
Can be any of the following:

• String - An ISO-8601 formated string (e.g. "1994-10-29T19:43:31Z").
• ZonedDateTime
• Calendar
• Anything else - Converted to String.

Returns:

A new BasicDatePart object, or null if the name or value is null.

datePart

public static final BasicDatePart datePart(String name,
 Supplier<ZonedDateTime> value)

Creates a new BasicDatePart part with a delayed value.

Part value is re-evaluated on each call to NameValuePair.getValue().

Parameters:

name - The part name.

value - The part value supplier.
Can be any of the following:

• String - An ISO-8601 formated string (e.g. "1994-10-29T19:43:31Z").
• ZonedDateTime
• Calendar
• Anything else - Converted to String.

Returns:

A new BasicDatePart object, or null if the name or value is null.

integerPart

public static final BasicIntegerPart integerPart(String name,
 Integer value)

Creates a new BasicIntegerPart part.

Parameters:

name - The part name.

value - The part value.
Can be any of the following:

• Number - Converted to an integer using Number.intValue().
• String - Parsed using Integer.parseInt(String).
• Anything else - Converted to String.

Returns:

A new BasicIntegerPart object, or null if the name or value is null.

integerPart

public static final BasicIntegerPart integerPart(String name,
 Supplier<Integer> value)

Creates a new BasicIntegerPart part with a delayed value.

Part value is re-evaluated on each call to NameValuePair.getValue().

Parameters:

name - The part name.

value - The part value supplier.
Can be any of the following:

• Number - Converted to an integer using Number.intValue().
• String - Parsed using Integer.parseInt(String).
• Anything else - Converted to String.

Returns:

A new BasicIntegerPart object, or null if the name or value is null.

longPart

public static final BasicLongPart longPart(String name,
 Long value)

Creates a new BasicLongPart part.

Parameters:

name - The part name.

value - The part value.
Can be any of the following:

• Number - Converted to a long using Number.longValue().
• String - Parsed using Long.parseLong(String).
• Anything else - Converted to String.

Returns:

A new BasicLongPart object, or null if the name or value is null.

longPart

public static final BasicLongPart longPart(String name,
 Supplier<Long> value)

Creates a new BasicLongPart part with a delayed value.

Part value is re-evaluated on each call to NameValuePair.getValue().

Parameters:

name - The part name.

value - The part value supplier.
Can be any of the following:

• Number - Converted to a long using Number.longValue().
• String - Parsed using Long.parseLong(String).
• Anything else - Converted to String.

Returns:

A new BasicLongPart object, or null if the name or value is null.

uriPart

public static final BasicUriPart uriPart(String name,
 URI value)

Creates a new BasicUriPart part.

Parameters:

name - The header name.

value - The header value.
Can be any of the following:

• String
• Anything else - Converted to String then parsed.

Returns:

A new BasicUriPart object, or null if the name or value is null.

uriPart

public static final BasicUriPart uriPart(String name,
 Supplier<URI> value)

Creates a new BasicUriPart part with a delayed value.

Part value is re-evaluated on each call to NameValuePair.getValue().

Parameters:

name - The header name.

value - The header value supplier.
Can be any of the following:

• String
• Anything else - Converted to String then parsed.

Returns:

A new BasicUriPart object, or null if the name or value is null.

basicPart

public static final BasicPart basicPart(String pair)

Creates a BasicPart from a name/value pair string (e.g. "Foo: bar")

Parameters:

pair - The pair string.

Returns:

A new BasicPart object.

basicPart

public static final BasicPart basicPart(String name,
 Object value)

Creates a new BasicPart part.

Parameters:

name - The part name.

value - The part value.

Returns:

A new BasicPart object.

basicPart

public static final BasicPart basicPart(String name,
 Supplier<?> value)

Creates a new BasicPart part with a delayed value.

Part value is re-evaluated on each call to NameValuePair.getValue().

Parameters:

name - The part name.

value - The part value supplier.

Returns:

A new BasicPart object.

stringPart

public static final BasicStringPart stringPart(String name,
 String value)

Creates a new BasicStringPart part.

Parameters:

name - The part name.

value - The part value.
Can be any of the following:

• String
• Anything else - Converted to String then parsed.

Returns:

A new BasicStringPart object, or null if the name or value is null.

stringPart

public static final BasicStringPart stringPart(String name,
 Supplier<String> value)

Creates a new BasicStringPart part with a delayed value.

Part value is re-evaluated on each call to NameValuePair.getValue().

Parameters:

name - The part name.

value - The part value supplier.
Can be any of the following:

• String
• Anything else - Converted to String then parsed.

Returns:

A new BasicStringPart object, or null if the name or value is null.

serializedPart

public static final SerializedPart serializedPart(String name,
 Object value)

Creates a new SerializedPart part.

Parameters:

name - The part name.

value - The part value.
Can be any POJO.

Returns:

A new SerializedPart object, never null.

serializedPart

public static final SerializedPart serializedPart(String name,
 Supplier<?> value)

Creates a new SerializedPart part with a delayed value.

Parameters:

name - The part name.

value - The part value supplier.
Can be a supplier of any POJO.

Returns:

A new SerializedPart object, never null.

partList

public static final PartList partList()

Instantiates a new PartList.

Returns:

A new part list.

partList

public static final PartList partList(List<NameValuePair> parts)

Creates a new PartList initialized with the specified parts.

Parameters:

parts - The parts to add to the list. Can be null. null entries are ignored.

Returns:

A new unmodifiable instance, never null.

partList

public static final PartList partList(NameValuePair... parts)

Creates a new PartList initialized with the specified parts.

Parameters:

parts - The parts to add to the list. null entries are ignored.

Returns:

A new unmodifiable instance, never null.

partList

public static PartList partList(String... pairs)

Creates a new PartList initialized with the specified name/value pairs.

Parameters:

pairs - Initial list of pairs.
Must be an even number of parameters representing key/value pairs.

Returns:

A new instance.

Throws:

RuntimeException - If odd number of parameters were specified.

getName

public static Optional<String> getName(HttpPartType partType,
 ClassMeta<?> type)

Returns the name of the specified part type.

Gets the name from one of the following annotations:

• Header
• Query
• FormData
• Path

Parameters:

partType - The part type.

type - The type to check.

Returns:

The part name. Never null.

isHttpPart

public static boolean isHttpPart(HttpPartType partType,
 ClassMeta<?> type)

Returns true if the specified type is a part type.

A part type extends from either Header or NameValuePair or is annotated with Header, Query, FormData, or Path.

Parameters:

partType - The part type.

type - The type to check.

Returns:

true if the specified type is a part type.

getConstructor

public static Optional<ConstructorInfo> getConstructor(ClassMeta<?> type)

Returns the constructor for the specified type.

Looks for one of the following constructors:

• public T(String name, String value);

Parameters:

type - The header type to find the constructor on.

Returns:

The constructor. Never null.

cast

public static NameValuePair cast(Object o)

Utility method for converting an arbitrary object to a NameValuePair.

Parameters:

o - The object to cast or convert to a NameValuePair.

Returns:

Either the same object cast as a NameValuePair or converted to a NameValuePair.

canCast

public static boolean canCast(Object o)

Returns true if the cast(Object) method can be used on the specified object.

Parameters:

o - The object to check.

Returns:

true if the cast(Object) method can be used on the specified object.