org.springframework.web.util

Enum DefaultUriBuilderFactory.EncodingMode

java.lang.Object

java.lang.Enum<DefaultUriBuilderFactory.EncodingMode>

org.springframework.web.util.DefaultUriBuilderFactory.EncodingMode

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<DefaultUriBuilderFactory.EncodingMode>

Enclosing class:

DefaultUriBuilderFactory

public static enum DefaultUriBuilderFactory.EncodingMode
extends java.lang.Enum<DefaultUriBuilderFactory.EncodingMode>

Constants that represent different URI encoding strategies.

See Also:

DefaultUriBuilderFactory.setEncodingMode(org.springframework.web.util.DefaultUriBuilderFactory.EncodingMode)

Enum Constant Summary

Enum Constants

Enum Constant and Description
NONE No encoding should be applied.
URI_COMPONENT The default way of encoding that UriComponents supports: Expand URI variables.
VALUES_ONLY Comprehensive encoding of URI variable values prior to expanding: Apply UriUtils.encode(String, Charset) to each URI variable value.

Method Summary

Modifier and Type	Method and Description
static DefaultUriBuilderFactory.EncodingMode	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static DefaultUriBuilderFactory.EncodingMode[]	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

Enum Constant Detail

URI_COMPONENT

public static final DefaultUriBuilderFactory.EncodingMode URI_COMPONENT

The default way of encoding that UriComponents supports:

1. Expand URI variables.
2. Encode individual URI components as described in UriComponents.encode(Charset).

This mode does not encode all characters with reserved meaning but only the ones that are illegal within a given URI component as defined in RFC 396. This matches the way the multi-argument URI constructor does encoding.

VALUES_ONLY

public static final DefaultUriBuilderFactory.EncodingMode VALUES_ONLY

Comprehensive encoding of URI variable values prior to expanding:

1. Apply UriUtils.encode(String, Charset) to each URI variable value.
2. Expand URI variable values.

This mode encodes all characters with reserved meaning, therefore ensuring that expanded URI variable do not have any impact on the structure or meaning of the URI.

NONE

public static final DefaultUriBuilderFactory.EncodingMode NONE

No encoding should be applied.

Method Detail

values

public static DefaultUriBuilderFactory.EncodingMode[] 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 (DefaultUriBuilderFactory.EncodingMode c : DefaultUriBuilderFactory.EncodingMode.values())
    System.out.println(c);

Returns:

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

valueOf

public static DefaultUriBuilderFactory.EncodingMode valueOf(java.lang.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:

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

java.lang.NullPointerException - if the argument is null