org.springframework.richclient.widget.editor.provider
Enum DataProvider.RefreshPolicy

Show UML class diagram

java.lang.Object
  java.lang.Enum<DataProvider.RefreshPolicy>
      org.springframework.richclient.widget.editor.provider.DataProvider.RefreshPolicy

All Implemented Interfaces:

Serializable, Comparable<DataProvider.RefreshPolicy>

Enclosing interface:

DataProvider

public static enum DataProvider.RefreshPolicy
extends Enum<DataProvider.RefreshPolicy>

Each DataProvider can specify a policy that dictates when to refresh the data list. This policy must be taken into account by any class using the DataProvider in order to keep the data in a consistent state.

• NEVER No automatic refresh, user should trigger a refresh when needed.
• ON_EMPTY Fetch the data once. This usually means when your client-side data list is empty.
• ON_USER_SWITCH Data needs to be refreshed when a user switch is detected. The data may contain user specific entries.
• ALLWAYS Data needs to be refreshed whenever the user views the list (on switching to that screen).

Enum Constant Summary

ALLWAYS

NEVER

ON_EMPTY

ON_USER_SWITCH

Method Summary

static DataProvider.RefreshPolicy	valueOf(String name) Returns the enum constant of this type with the specified name.
static DataProvider.RefreshPolicy[]	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

NEVER

public static final DataProvider.RefreshPolicy NEVER

ON_EMPTY

public static final DataProvider.RefreshPolicy ON_EMPTY

ON_USER_SWITCH

public static final DataProvider.RefreshPolicy ON_USER_SWITCH

ALLWAYS

public static final DataProvider.RefreshPolicy ALLWAYS

Method Detail

values

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

Returns:

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

valueOf

public static DataProvider.RefreshPolicy 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