Package com.google.googlejavaformat.java.javadoc

Enum JavadocWriter.RequestedWhitespace

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<JavadocWriter.RequestedWhitespace>
    Enclosing class:
    JavadocWriter
    static enum JavadocWriter.RequestedWhitespace
extends java.lang.Enum<JavadocWriter.RequestedWhitespace>
    The kind of whitespace that has been requested between the previous and next tokens. The order of the values is significant: It goes from lowest priority to highest. For example, if the previous token requests BLANK_LINE after it but the next token requests only NEWLINE before it, we insert BLANK_LINE.

    • Constructor Summary

      Constructors 
      Modifier Constructor Description
      private RequestedWhitespace()  

    • Method Summary

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

    • Constructor Detail

      • RequestedWhitespace

        private RequestedWhitespace()

    • Method Detail

      • values

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

      • valueOf

        public static JavadocWriter.RequestedWhitespace 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