org.springframework.data.rest.webmvc.spi

Enum BackendIdConverter.DefaultIdConverter

java.lang.Object

java.lang.Enum<BackendIdConverter.DefaultIdConverter>

org.springframework.data.rest.webmvc.spi.BackendIdConverter.DefaultIdConverter

All Implemented Interfaces:

Serializable, Comparable<BackendIdConverter.DefaultIdConverter>, BackendIdConverter, org.springframework.plugin.core.Plugin<Class<?>>

Enclosing interface:

BackendIdConverter

public static enum BackendIdConverter.DefaultIdConverter
extends Enum<BackendIdConverter.DefaultIdConverter>
implements BackendIdConverter

The default BackendIdConverter that will simply use ids as they are.

Author:

Oliver Gierke

Nested Class Summary

Nested classes/interfaces inherited from interface org.springframework.data.rest.webmvc.spi.BackendIdConverter

BackendIdConverter.DefaultIdConverter

Enum Constant Summary

Enum Constants

Enum Constant and Description
INSTANCE

Method Summary

Modifier and Type	Method and Description
Serializable	fromRequestId(String id, Class<?> entityType) Returns the id of the entity to be looked up eventually.
boolean	supports(Class<?> delimiter)
String	toRequestId(Serializable id, Class<?> entityType) Returns the id to be used in the URI generated to point to an entity of the given type with the given id.
static BackendIdConverter.DefaultIdConverter	valueOf(String name) Returns the enum constant of this type with the specified name.
static BackendIdConverter.DefaultIdConverter[]	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

INSTANCE

public static final BackendIdConverter.DefaultIdConverter INSTANCE

Method Detail

values

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

Returns:

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

valueOf

public static BackendIdConverter.DefaultIdConverter 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

fromRequestId

public Serializable fromRequestId(String id,
                                  Class<?> entityType)

Description copied from interface: BackendIdConverter

Returns the id of the entity to be looked up eventually.

Specified by:

fromRequestId in interface BackendIdConverter

Parameters:

id - the source id as it was parsed from the incoming request, will never be null.

entityType - the type of the object to be resolved, will never be null.

Returns:

must not be null.

toRequestId

public String toRequestId(Serializable id,
                          Class<?> entityType)

Description copied from interface: BackendIdConverter

Returns the id to be used in the URI generated to point to an entity of the given type with the given id.

Specified by:

toRequestId in interface BackendIdConverter

Parameters:

id - the entity's id, will never be null.

entityType - the type of the entity to expose.

Returns:

supports

public boolean supports(Class<?> delimiter)

Specified by:

supports in interface org.springframework.plugin.core.Plugin<Class<?>>