org.springframework.data.rest.webmvc.convert

Enum StringToDistanceConverter

java.lang.Object

java.lang.Enum<StringToDistanceConverter>

org.springframework.data.rest.webmvc.convert.StringToDistanceConverter

All Implemented Interfaces:

Serializable, Comparable<StringToDistanceConverter>, Converter<String,org.springframework.data.geo.Distance>

public enum StringToDistanceConverter
extends Enum<StringToDistanceConverter>
implements Converter<String,org.springframework.data.geo.Distance>

Converter to create Distance instances from String representations. The supported format is a decimal followed by whitespace and a metric abbreviation. We currently support the following abbreviations: .

Author:

Oliver Gierke

Enum Constant Summary

Enum Constants

Enum Constant and Description
INSTANCE

Method Summary

Methods

Modifier and Type	Method and Description
org.springframework.data.geo.Distance	convert(String source)
static StringToDistanceConverter	valueOf(String name) Returns the enum constant of this type with the specified name.
static StringToDistanceConverter[]	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 StringToDistanceConverter INSTANCE

Method Detail

values

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

Returns:

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

valueOf

public static StringToDistanceConverter 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

convert

public org.springframework.data.geo.Distance convert(String source)

Specified by:

convert in interface Converter<String,org.springframework.data.geo.Distance>