Package com.install4j.api.update
Enum UpdateSchedule
- java.lang.Object
-
- java.lang.Enum<UpdateSchedule>
-
- com.install4j.api.update.UpdateSchedule
-
- All Implemented Interfaces:
java.io.Serializable
,java.lang.Comparable<UpdateSchedule>
public enum UpdateSchedule extends java.lang.Enum<UpdateSchedule>
Enumeration class that represents the different update schedules. These values are used in theUpdateScheduleRegistry
class.
-
-
Enum Constant Summary
Enum Constants Enum Constant Description DAILY
UpdateScheduleRegistry.checkAndReset()
always returns true after more than one day has passed since the last updateMONTHLY
UpdateScheduleRegistry.checkAndReset()
always returns true after more than one month has passed since the last updateNEVER
UpdateScheduleRegistry.checkAndReset()
always returns falseON_EVERY_START
UpdateScheduleRegistry.checkAndReset()
always returns trueWEEKLY
UpdateScheduleRegistry.checkAndReset()
always returns true after more than one week has passed since the last update
-
Field Summary
Fields Modifier and Type Field Description static UpdateSchedule[]
ALL_VALUES
Deprecated.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static UpdateSchedule
getById(java.lang.String id)
Returns theUpdateSchedule
for a string ID.java.lang.String
getId()
Returns the string ID for theUpdateSchedule
.java.lang.String
toString()
static UpdateSchedule
valueOf(java.lang.String name)
Returns the enum constant of this type with the specified name.static UpdateSchedule[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.
-
-
-
Enum Constant Detail
-
ON_EVERY_START
public static final UpdateSchedule ON_EVERY_START
UpdateScheduleRegistry.checkAndReset()
always returns true
-
DAILY
public static final UpdateSchedule DAILY
UpdateScheduleRegistry.checkAndReset()
always returns true after more than one day has passed since the last update
-
WEEKLY
public static final UpdateSchedule WEEKLY
UpdateScheduleRegistry.checkAndReset()
always returns true after more than one week has passed since the last update
-
MONTHLY
public static final UpdateSchedule MONTHLY
UpdateScheduleRegistry.checkAndReset()
always returns true after more than one month has passed since the last update
-
NEVER
public static final UpdateSchedule NEVER
UpdateScheduleRegistry.checkAndReset()
always returns false
-
-
Field Detail
-
ALL_VALUES
@Deprecated public static final UpdateSchedule[] ALL_VALUES
Deprecated.All values ofUpdateSchedule
for use in a drop-down list.Not needed since this class became an enum in install4j 6.
-
-
Method Detail
-
values
public static UpdateSchedule[] 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 (UpdateSchedule c : UpdateSchedule.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static UpdateSchedule 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 namejava.lang.NullPointerException
- if the argument is null
-
getById
public static UpdateSchedule getById(java.lang.String id)
Returns theUpdateSchedule
for a string ID. String IDs forUpdateSchedule
s are returned bygetId()
}.- Parameters:
id
- the ID- Returns:
- the
UpdateSchedule
or null if the ID is invalid
-
getId
public java.lang.String getId()
Returns the string ID for theUpdateSchedule
. This string value can be saved and restored later with thegetById(String)
} method.- Returns:
- the ID
-
toString
public java.lang.String toString()
- Overrides:
toString
in classjava.lang.Enum<UpdateSchedule>
-
-