Package org.intermine.template

Enum SwitchOffAbility

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<SwitchOffAbility>
    public enum SwitchOffAbility
extends java.lang.Enum<SwitchOffAbility>
    Enumeration for describing the configuration on constraints on a TemplateQuery that determines whether a user is allowed to switch off a constraint, and if so what state it is in.
    Author:
    Matthew Wakeling

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      LOCKED
      template constraint can't be edited by the user
      OFF
      template constraint is not active
      ON
      the template constraint is active

    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static SwitchOffAbility valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static SwitchOffAbility[] 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, toString, valueOf

      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait

    • Enum Constant Detail

      • OFF

        public static final SwitchOffAbility OFF
        template constraint is not active

      • LOCKED

        public static final SwitchOffAbility LOCKED
        template constraint can't be edited by the user

    • Method Detail

      • values

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

      • valueOf

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