org.cyclos.model.users.addresses

Enum UserAddressResult

java.lang.Object

java.lang.Enum<UserAddressResult>

org.cyclos.model.users.addresses.UserAddressResult

All Implemented Interfaces:

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

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

Contains the possible ways to handle addresses

Author:

luis

Enum Constant Summary

Enum Constants

Enum Constant and Description
ALL_LOCATED_ADDRESSES All located addresses will be returned, effectively making results show up multiple times if there are multiple located addresses
DEFAULT_ADDRESS Results will be returned with the default user address
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

Methods

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

Results will be returned without address information

NEAREST_ADDRESS

public static final UserAddressResult 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

DEFAULT_ADDRESS

public static final UserAddressResult DEFAULT_ADDRESS

Results will be returned with the default user address

ALL_LOCATED_ADDRESSES

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

Returns:

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

valueOf

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