Package com.day.cq.reporting

Enum SnapshotType

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<SnapshotType>
    public enum SnapshotType
extends java.lang.Enum<SnapshotType>
    This enumerations defines the snapshot types available.

    • Enum Constant Summary

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

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      static SnapshotType fromStringRep​(java.lang.String stringRep)
      Creates a suitable SnapshotType from the specified string representation.
      java.lang.String getStringRep()
      Gets the string representation of the snapshot type.
      static SnapshotType valueOf​(java.lang.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

      • 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​(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

      • getStringRep

        public java.lang.String getStringRep()
        Gets the string representation of the snapshot type.
        Returns:
        The string representation of the snapshot type

      • fromStringRep

        public static SnapshotType fromStringRep​(java.lang.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