Package ca.corefacility.bioinformatics.irida.model.enums

Enum AnalysisCleanedState

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<AnalysisCleanedState>
    public enum AnalysisCleanedState
extends java.lang.Enum<AnalysisCleanedState>
    Defines the state for cleaning up intermediate files of an analysis.

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      CLEANED
      Set when an analysis is finished being cleaned.
      CLEANING
      Indicates this analysis is in the process of being cleaned.
      CLEANING_ERROR
      Indicates that there was an error while cleaning a submission.
      NOT_CLEANED
      A state where intermediate files exists for this analysis.

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String toString()
      static AnalysisCleanedState valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static AnalysisCleanedState[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.

      • Methods inherited from class java.lang.Enum

        clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait

    • Enum Constant Detail

      • NOT_CLEANED

        public static final AnalysisCleanedState NOT_CLEANED
        A state where intermediate files exists for this analysis.

      • CLEANING

        public static final AnalysisCleanedState CLEANING
        Indicates this analysis is in the process of being cleaned.

      • CLEANED

        public static final AnalysisCleanedState CLEANED
        Set when an analysis is finished being cleaned.

      • CLEANING_ERROR

        public static final AnalysisCleanedState CLEANING_ERROR
        Indicates that there was an error while cleaning a submission.

    • Method Detail

      • values

        public static AnalysisCleanedState[] 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 (AnalysisCleanedState c : AnalysisCleanedState.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

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

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Enum<AnalysisCleanedState>