Package com.deltawalker.script

Enum Class ReportKind

java.lang.Object
java.lang.Enum<ReportKind>
com.deltawalker.script.ReportKind
All Implemented Interfaces:
Serializable, Comparable<ReportKind>, Constable
public enum ReportKind extends Enum<ReportKind>
The kinds of report a comparison can write.
Since:
2.0
See Also:

  • Nested Class Summary

    Nested classes/interfaces inherited from class java.lang.Enum

    Enum.EnumDesc<E extends Enum<E>>

  • Enum Constant Summary

    Enum Constants
    Enum Constant
    Description
    HTML
    An HTML report, viewable in a web browser.
    JSON
    A JSON snapshot of a folder comparison: the names and attributes of the resources of every node, for one or more roles, together with the comparison's settings.
    PATCH
    A patch: a plain-text report, in one of several PatchFormats, from which a patch program can recreate the modified text from the original.

  • Method Summary

    Modifier and Type
    Method
    Description
    static ReportKind
    valueOf(String name)
    Returns the enum constant of this class with the specified name.
    static ReportKind[]
    values()
    Returns an array containing the constants of this enum class, in the order they are declared.

    Methods inherited from class java.lang.Enum

    compareTo, describeConstable, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Enum Constant Details

    • HTML

      public static final ReportKind HTML
      An HTML report, viewable in a web browser.

    • JSON

      public static final ReportKind JSON
      A JSON snapshot of a folder comparison: the names and attributes of the resources of every node, for one or more roles, together with the comparison's settings. A snapshot can be reopened with Comparisons.createFromReport(String, ComparisonListener). Folder comparisons only.

    • PATCH

      public static final ReportKind PATCH
      A patch: a plain-text report, in one of several PatchFormats, from which a patch program can recreate the modified text from the original. Not implemented in the current release: folder comparisons write no file, and text comparisons write an HTML report.

  • Method Details

    • values

      public static ReportKind[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static ReportKind valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name
      NullPointerException - if the argument is null