Package org.apache.juneau.uon

Enum ParamFormat

java.lang.Object

java.lang.Enum<ParamFormat>

org.apache.juneau.uon.ParamFormat

All Implemented Interfaces:

Serializable, Comparable<ParamFormat>, java.lang.constant.Constable

public enum ParamFormat
extends Enum<ParamFormat>

Identifies the possible values for the UonSerializer.Builder.paramFormat(ParamFormat) setting.

See Also:

• UON Details

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
PLAINTEXT	Serialize as plain text.
UON	Use UON notation for values.

Method Summary

Modifier and Type	Method	Description
static ParamFormat	valueOf(String name)	Returns the enum constant of this type with the specified name.
static ParamFormat[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

UON

public static final ParamFormat UON

Use UON notation for values.

String values such as "(foo='bar')" will end up being quoted and escaped to "'(foo=bar~'baz~')'".

Boolean strings ("true"/"false") and numeric values ("123") will also end up quoted ("'true'", "'false'", "'123'".

PLAINTEXT

public static final ParamFormat PLAINTEXT

Serialize as plain text.

Strings will never be quoted or escaped.
Maps and array constructs ("(...)", "@(...)") will never be used.

Note that this can cause errors during parsing if you're using the URL-encoding parser to parse the results since UON constructs won't be differentiable.
However, this is not an issue if you're simply creating queries or form posts against 3rd-party interfaces.

Method Details

values

public static ParamFormat[] values()

Returns an array containing the constants of this enum type, in the order they are declared.

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static ParamFormat valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null