com.teamdev.jxmaps

Enum RankBy

java.lang.Object

java.lang.Enum<RankBy>

com.teamdev.jxmaps.RankBy

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<RankBy>

public enum RankBy
extends java.lang.Enum<RankBy>

Represents enum of ranking options for a PlaceSearchRequest.

Enum Constant Summary

Enum Constants

Enum Constant and Description
DISTANCE Ranks place results by distance from the location.
PROMINENCE Ranks place results by their prominence.

Method Summary

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

DISTANCE

public static final RankBy DISTANCE

Ranks place results by distance from the location.

PROMINENCE

public static final RankBy PROMINENCE

Ranks place results by their prominence.

Method Detail

values

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

Returns:

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

valueOf

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