com.day.cq.reporting

Enum SnapshotType

java.lang.Object

java.lang.Enum<SnapshotType>

com.day.cq.reporting.SnapshotType

All Implemented Interfaces:

Serializable, Comparable<SnapshotType>

public enum SnapshotType
extends Enum<SnapshotType>

This enumerations defines the snapshot types available.

Enum Constant Summary

Enum Constants

Enum Constant and Description
DAILY Daily snapshots
FORCED Forced snapshot
HOURLY Hourly snapshots
NEVER No snapshot

Method Summary

Modifier and Type	Method and Description
static SnapshotType	fromStringRep(String stringRep) Creates a suitable SnapshotType from the specified string representation.
String	getStringRep() Gets the string representation of the snapshot type.
static SnapshotType	valueOf(String name) Returns the enum constant of this type with the specified name.
static SnapshotType[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, equals, 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 SnapshotType NEVER

No snapshot

HOURLY

public static final SnapshotType HOURLY

Hourly snapshots

DAILY

public static final SnapshotType DAILY

Daily snapshots

FORCED

public static final SnapshotType FORCED

Forced snapshot

Method Detail

values

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

Returns:

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

valueOf

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

getStringRep

public String getStringRep()

Gets the string representation of the snapshot type.

Returns:

The string representation of the snapshot type

fromStringRep

public static SnapshotType fromStringRep(String stringRep)

Creates a suitable SnapshotType from the specified string representation.

Parameters:

stringRep - The string representation

Returns:

The snapshot type; null if an invalid string representation has been specified