com.github.kaiwinter.androidremotenotifications.model

Enum UpdatePolicy

java.lang.Object

java.lang.Enum<UpdatePolicy>

com.github.kaiwinter.androidremotenotifications.model.UpdatePolicy

All Implemented Interfaces:

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

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

Defines how often the notifications are updated from the server. Doing this on each start of your app (NOW) might lead to too many server calls. You can reduce them by using WEEKLY or MONTHLY.

Enum Constant Summary

Enum Constants

Enum Constant and Description
BI_WEEKLY The update is made every second week.
MONTHLY The update is made once a month.
NOW The update is made now, regardless when the last one was.
WEEKLY The update is made once a week.

Method Summary

Modifier and Type	Method and Description
boolean	shouldUpdate(java.util.Date lastUpdate) Checks if the interval of this UpdatePolicy is over in regard to the lastUpdate.
static UpdatePolicy	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static UpdatePolicy[]	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

NOW

public static final UpdatePolicy NOW

The update is made now, regardless when the last one was.

WEEKLY

public static final UpdatePolicy WEEKLY

The update is made once a week. RemoteNotifications uses an internal shared preference to track when the last update was.

BI_WEEKLY

public static final UpdatePolicy BI_WEEKLY

The update is made every second week. RemoteNotifications uses an internal shared preference to track when the last update was.

MONTHLY

public static final UpdatePolicy MONTHLY

The update is made once a month. RemoteNotifications uses an internal shared preference to track when the last update was.

Method Detail

values

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

Returns:

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

valueOf

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

shouldUpdate

public boolean shouldUpdate(java.util.Date lastUpdate)

Checks if the interval of this UpdatePolicy is over in regard to the lastUpdate.

Parameters:

lastUpdate - The Date of the last update.

Returns:

true if an update should be done, else false.