Package examples.testudtlib

Enum Comment.RuleNames

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<Comment.RuleNames>
    Enclosing class:
    Comment
    public static enum Comment.RuleNames
extends java.lang.Enum<Comment.RuleNames>
    This enum provides easy to remember enum constants for locating the rule identifiers and names. The enum constants have the same spelling as the rule names rendered in all caps with underscores replacing hyphens.

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      ANY
      id = 3, name = "any"
      ANYLF
      id = 4, name = "anyLF"
      C_COMMENT
      id = 2, name = "c-comment"
      CPP_COMMENT
      id = 1, name = "cpp-comment"
      SEMI_COMMENT
      id = 0, name = "semi-comment"

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      int ruleID()
      Associates the enum with an identifier for the grammar rule it represents.
      java.lang.String ruleName()
      Associates the enum with the original grammar name of the rule it represents.
      static Comment.RuleNames valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static Comment.RuleNames[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.

      • Methods inherited from class java.lang.Enum

        compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait

    • Method Detail

      • values

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

      • valueOf

        public static Comment.RuleNames 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

      • ruleName

        public java.lang.String ruleName()
        Associates the enum with the original grammar name of the rule it represents.
        Returns:
        the original grammar rule name.

      • ruleID

        public int ruleID()
        Associates the enum with an identifier for the grammar rule it represents.
        Returns:
        the rule name identifier.