Enum Class BlockCommentEndPositionOption

java.lang.Object
java.lang.Enum<BlockCommentEndPositionOption>
com.puppycrawl.tools.checkstyle.checks.javadoc.BlockCommentEndPositionOption
All Implemented Interfaces:
Serializable, Comparable<BlockCommentEndPositionOption>, Constable

public enum BlockCommentEndPositionOption extends Enum<BlockCommentEndPositionOption>
Represents the options for the position of the block comment end delimiter.
  • Enum Constant Details

    • ALONE

      public static final BlockCommentEndPositionOption ALONE
      Represents the policy that the block comment end must be alone on its own line. For example:
      &#47;**
       * Multiple lines of Javadoc text are written here,
       * wrapped normally...
       *&#47;
      public void method();
      
    • ALONE_OR_SINGLELINE

      public static final BlockCommentEndPositionOption ALONE_OR_SINGLELINE
      Represents the policy that the block comment end must be alone on its own line or on the same line as the block comment begin. For example:
      // Block comment end is alone on its own line
      &#47;**
       * Multiple lines of Javadoc text are written here,
       * wrapped normally...
       *&#47;
      public void method();
      
      // Single-line Javadoc
      &#47;** Javadoc summary. *&#47;
      public void method1();
      
  • Constructor Details

    • BlockCommentEndPositionOption

      private BlockCommentEndPositionOption()
  • Method Details

    • values

      public static BlockCommentEndPositionOption[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared
    • valueOf

      public static BlockCommentEndPositionOption valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null