org.springframework.mobile.device.site
Enum SitePreference

java.lang.Object
  java.lang.Enum<SitePreference>
      org.springframework.mobile.device.site.SitePreference

All Implemented Interfaces:

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

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

Possible site preference values.

Author:

Keith Donald

Enum Constant Summary

MOBILE
The user prefers the 'mobile' site.

NORMAL
The user prefers the 'normal' site.

Method Summary

boolean	isMobile() Tests if this is the 'mobile' SitePreference.
static SitePreference	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static SitePreference[]	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

NORMAL

public static final SitePreference NORMAL

The user prefers the 'normal' site.

MOBILE

public static final SitePreference MOBILE

The user prefers the 'mobile' site.

Method Detail

values

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

Returns:

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

valueOf

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

isMobile

public boolean isMobile()

Tests if this is the 'mobile' SitePreference. Designed to support concise SitePreference boolean expressions e.g. <c:if test="${currentSitePreference.mobile}"></c:if>.