Package com.acrolinx.client.sdk.check

Enum CheckType

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<CheckType>
    public enum CheckType
extends java.lang.Enum<CheckType>
    How to choose a correct Check Type? Following are different use cases of the check with corresponding check type:
    Check Type overview
    Check Type Ux Use case
    interactive Interactive User checks her own document.
    batch Interactive User checks set of her own documents.
    baseline Noninteractive A repository of documents are checked as part of build job running nightly and the user doesn't own the documents.
    automated Noninteractive Check of a single document for automated scenarios as for example a git hook or save a document.

    • Method Summary

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

      • interactive

        public static final CheckType interactive

      • baseline

        public static final CheckType baseline

      • automated

        public static final CheckType automated

    • Method Detail

      • values

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

      • valueOf

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