Package org.apache.juneau.http.part

Class BasicPart

java.lang.Object

org.apache.juneau.http.part.BasicPart

All Implemented Interfaces:

NameValuePair, Headerable

Direct Known Subclasses:

BasicBooleanPart, BasicCsvArrayPart, BasicDatePart, BasicIntegerPart, BasicLongPart, BasicStringPart, BasicUriPart, SerializedPart

@BeanIgnore
public class BasicPart
extends Object
implements NameValuePair, Headerable

Implementation of NameValuePair for serializing POJOs as URL-encoded form post entries. Provides the following features:

• Values from Suppliers.
• Caching.
• Fluent setters.
• Fluent assertions.

See Also:

• juneau-rest-common

Constructor Summary

Constructors

Modifier	Constructor	Description
	BasicPart(String name, Object value)	Constructor.
protected	BasicPart(BasicPart copyFrom)	Copy constructor.

Method Summary

Modifier and Type	Method	Description
BasicHeader	asHeader()	Convert the object to a Header.
org.apache.juneau.assertions.FluentStringAssertion<BasicPart>	assertName()	Provides an object for performing assertions against the name of this pair.
org.apache.juneau.assertions.FluentStringAssertion<BasicPart>	assertValue()	Provides an object for performing assertions against the value of this pair.
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.
String	getName()
Object	getRawValue()	Returns the raw value of the part.
String	getValue()
static BasicPart	of(String name, Object value)	Static creator.
static BasicPart	ofPair(String pair)	Creates a NameValuePair from a name/value pair string (e.g.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

BasicPart

public BasicPart(String name,
 Object value)

Constructor.

Parameters:

name - The part name.

value - The POJO to serialize to The part value.

BasicPart

protected BasicPart(BasicPart copyFrom)

Copy constructor.

Parameters:

copyFrom - The object to copy.

Method Details

of

public static BasicPart of(String name,
 Object value)

Static creator.

Parameters:

name - The part name.

value - The part value.

Returns:

A new BasicPart object.

ofPair

public static BasicPart ofPair(String pair)

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

Parameters:

pair - The pair string.

Returns:

A new NameValuePair object.

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.

assertName

public org.apache.juneau.assertions.FluentStringAssertion<BasicPart> assertName()

Provides an object for performing assertions against the name of this pair.

Returns:

An object for performing assertions against the name of this pair.

assertValue

public org.apache.juneau.assertions.FluentStringAssertion<BasicPart> assertValue()

Provides an object for performing assertions against the value of this pair.

Returns:

An object for performing assertions against the value of this pair.

asHeader

public BasicHeader asHeader()

Description copied from interface: Headerable

Convert the object to a Header.

Specified by:

asHeader in interface Headerable

Returns:

The object converted to a Header.

getName

public String getName()

Specified by:

getName in interface NameValuePair

getValue

public String getValue()

Specified by:

getValue in interface NameValuePair

getRawValue

public Object getRawValue()

Returns the raw value of the part.

Returns:

The raw value of the part.

toString

public String toString()

Overrides:

toString in class Object