Package org.cyclos.model.users.addresses

Enum AdAddressResult

java.lang.Object

java.lang.Enum<AdAddressResult>

org.cyclos.model.users.addresses.AdAddressResult

All Implemented Interfaces:

Serializable, Comparable<AdAddressResult>

public enum AdAddressResult
extends Enum<AdAddressResult>

Contains the possible ways to handle ad addresses

Enum Constant Summary

Enum Constants

Enum Constant	Description
ALL_LOCATED_ADDRESSES	All located addresses will be returned, effectively making results show up multiple times if there are multiple located addresses
NEAREST_ADDRESS	Results will be returned with the nearest address for a distance filter.
NO_ADDRESSES	Results will be returned without address information

Method Summary

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

NO_ADDRESSES

public static final AdAddressResult NO_ADDRESSES

Results will be returned without address information

NEAREST_ADDRESS

public static final AdAddressResult NEAREST_ADDRESS

Results will be returned with the nearest address for a distance filter. If distance is not used, will have the same result as NO_ADDRESSES

ALL_LOCATED_ADDRESSES

public static final AdAddressResult ALL_LOCATED_ADDRESSES

All located addresses will be returned, effectively making results show up multiple times if there are multiple located addresses

Method Detail

values

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

Returns:

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

valueOf

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