Enum Result

java.lang.Object
java.lang.Enum<Result>
org.apache.creadur.whisker.app.Result
All Implemented Interfaces:
Serializable, Comparable<Result>
public enum Result extends Enum<Result>
Names results which might be produced by Whisker.

  • Enum Constant Details

    • LICENSE

      public static final Result LICENSE
      Software license.

    • NOTICE

      public static final Result NOTICE
      Software notice.

    • MISSING_LICENSE_REPORT

      public static final Result MISSING_LICENSE_REPORT
      Describes missing meta-data.

    • XML_TEMPLATE

      public static final Result XML_TEMPLATE
      Starting point for meta-data development.

    • DIRECTORIES_REPORT

      public static final Result DIRECTORIES_REPORT
      Describes the directories in the source.

  • Method Details

    • values

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

    • valueOf

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

    • getName

      public String getName()
      Gets the conventional name for this result.
      Returns:
      not null

    • within

      public File within(File directory)
      Creates the conventional file for storage of this result.
      Parameters:
      directory - not null
      Returns:
      conventional file within directory