Package Torello.Java

Enum Verbosity

  • All Implemented Interfaces:, java.lang.Comparable<Verbosity>

    public enum Verbosity
    extends java.lang.Enum<Verbosity>
    A Java 'enum' that is used in several locations in the Java-HTML JAR Library to allow an end-user to request the quantity of text being produced by a tool or application. The Verbose flag / constant is designed to request the maximum amount of information when running a tool, while the Silent constant may be used to ask that no textual output be sent to Standard-Output

    Primarily for convenience and ease-of-use, each of the four constants in this enum are assigned an integer depicting the verbosity. When deciding whether or not to print a message to the user using this enum, using the level integer is usually a more exedient coding-solution.

    The following example should help elucidate using the level field. Note that in this particular example, the settings for Quiet and for Silent are simply not being used. In this example, keep in mind that the programmer may simply include a message for the Quiet setting someplace else in the code, entirely!

     // This is an extremely verbose way of coding!
     switch (verbosity)
          case Silent:    
          case Quiet:     break;
          case Normal:
          case Verbose:   System.out.println("Starting New Program Section");
     // From a programming-analysis perspective alone, this is a lot more succint
     if (verbosity.level >= 2) System.out.println("Starting New Program Section");

    • Field Summary

      Modifier and Type Field
      int level
    • Method Summary

      Convert String to Enum Constant
      Modifier and Type Method
      static Verbosity valueOf​(String name)
      List all Enum Constants
      Modifier and Type Method
      static Verbosity[] values()
      • 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

      • Silent

        public static final Verbosity Silent
        Indicates a user-request that an application or program should not produce any output, other than error-output. In the Java-HTML JAR Library, error output is rarely abbreviated or eliminated.

        This constant is assigned "Level 0", and the level constant-field will always be zero.
      • Quiet

        🡅  🡇    
        public static final Verbosity Quiet
        Indicates a user-request for an application or program to run producing the minimum amount of text-output possible. Error output may (or may not) be shunted, as per the capricious whims of the software guys.

        This constant is assigned "Level 1", and the level constant-field will always be one.
      • Normal

        🡅  🡇    
        public static final Verbosity Normal
        The enum-constant should be used to indicate that the default output-text be sent to Standard-Output and Error-Output.

        This constant is assigned "Level 2", and the level constant-field will always be two.
      • Verbose

        🡅  🡇    
        public static final Verbosity Verbose
        If a programmer can produce additional information about the state of a program as it runs, then the 'Verbose' constant / flag may be used to indicate a user-request as such.

        This constant is assigned "Level 3", and the level constant-field will always be three.
    • Field Detail

      • level

        🡅  🡇    
        public final int level
        There are quite a number of situations where an integer is easier for doing the comparisons an actual instance of 'Verbosity'. Each of the four constants of this enum have their own, ordered, 'level' setting (which is a number between '0' and '3').
        Exact Field Declaration Expression:
         public final int level;
    • Method Detail

      • values

        🡅  🡇    
        public static Verbosity[] 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 (Verbosity c : Verbosity.values())
        an array containing the constants of this enum type, in the order they are declared
      • valueOf

        public static Verbosity 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.)
        name - the name of the enum constant to be returned.
        the enum constant with the specified name
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.NullPointerException - if the argument is null