com.flyingspaniel.nava.net

Enum URLEncoding.Impl

java.lang.Object

java.lang.Enum<URLEncoding.Impl>

com.flyingspaniel.nava.net.URLEncoding.Impl

All Implemented Interfaces:

URLEncoding, Serializable, Comparable<URLEncoding.Impl>

Enclosing interface:

URLEncoding

public static enum URLEncoding.Impl
extends Enum<URLEncoding.Impl>
implements URLEncoding

Enum holding three implementations of URLEncoding

Nested Class Summary

Nested classes/interfaces inherited from interface com.flyingspaniel.nava.net.URLEncoding

URLEncoding.Impl

Enum Constant Summary

Enum Constants

Enum Constant and Description
JAVA uses Java's URLEncoder and URLDecoder.
NONE Does nothing
RFC3986 strict RFC3986, e.g.

Field Summary

Fields inherited from interface com.flyingspaniel.nava.net.URLEncoding

COMMA, EMPTY, EQUALS, RFC3986_CHANGES, UTF8_CHARSET

Method Summary

Methods

Modifier and Type	Method and Description
Map.Entry<String,String[]>	decodeKVs(String keyPlusValues) Decodes a String of the format key[=][value1][,value2...]
String	encodeKVs(String key, Object... values) Encodes into key=value1,value2...
static URLEncoding	getInstance(boolean doEncode, boolean useStrictRFC3986) Utility to obtain the correct encoder
static String	toStringNullsBecome(Object o, String nullsBecome) Like @link String.valueOf(Object) but you get to pick the result for nulls
static URLEncoding.Impl	valueOf(String name) Returns the enum constant of this type with the specified name.
static URLEncoding.Impl[]	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, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.flyingspaniel.nava.net.URLEncoding

decode, encode

Enum Constant Detail

NONE

public static final URLEncoding.Impl NONE

Does nothing

JAVA

public static final URLEncoding.Impl JAVA

uses Java's URLEncoder and URLDecoder. ' ' -> '+'

See Also:

URLEncoder, URLDecoder

RFC3986

public static final URLEncoding.Impl RFC3986

strict RFC3986, e.g. ' ' -> "%20" Based upon Amazon's example code.

Method Detail

values

public static URLEncoding.Impl[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (URLEncoding.Impl c : URLEncoding.Impl.values())
    System.out.println(c);

Returns:

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

valueOf

public static URLEncoding.Impl 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

decodeKVs

public Map.Entry<String,String[]> decodeKVs(String keyPlusValues)

Description copied from interface: URLEncoding

Decodes a String of the format key[=][value1][,value2...]

Specified by:

decodeKVs in interface URLEncoding

Returns:

.getKey() has key, .getValues has String[], possibly empty

encodeKVs

public String encodeKVs(String key,
               Object... values)

Description copied from interface: URLEncoding

Encodes into key=value1,value2...

Specified by:

encodeKVs in interface URLEncoding

Returns:

String

getInstance

public static URLEncoding getInstance(boolean doEncode,
                      boolean useStrictRFC3986)

Utility to obtain the correct encoder

Parameters:

doEncode -

useStrictRFC3986 -

Returns:

never null

toStringNullsBecome

public static String toStringNullsBecome(Object o,
                         String nullsBecome)

Like @link String.valueOf(Object) but you get to pick the result for nulls

Parameters:

o -

nullsBecome - what String to return if o is null

Returns:

String