Package com.adobe.cq.wcm.core.components.models

Enum TableOfContents.ListType

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<TableOfContents.ListType>
    Enclosing interface:
    TableOfContents
    public static enum TableOfContents.ListType
extends java.lang.Enum<TableOfContents.ListType>
    Defines the possible list types for table of contents
    Since:
    com.adobe.cq.wcm.core.components.models.tableofcontents 1.0

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      bulleted
      Bulleted list type
      numbered
      Numbered list type

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      static TableOfContents.ListType fromString​(java.lang.String value)
      Given a String value, this method returns the enum's value that corresponds to the provided string representation.
      java.lang.String getTagName()
      Returns the HTML tag name for this enum type of list
      java.lang.String getValue()  
      static TableOfContents.ListType valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static TableOfContents.ListType[] 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

    • Enum Constant Detail

      • bulleted

        public static final TableOfContents.ListType bulleted
        Bulleted list type
        Since:
        com.adobe.cq.wcm.core.components.models.tableofcontents 1.0

      • numbered

        public static final TableOfContents.ListType numbered
        Numbered list type
        Since:
        com.adobe.cq.wcm.core.components.models.tableofcontents 1.0

    • Method Detail

      • values

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

      • valueOf

        public static TableOfContents.ListType 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

      • getValue

        public java.lang.String getValue()

      • getTagName

        public java.lang.String getTagName()
        Returns the HTML tag name for this enum type of list
        Returns:
        HTML tag name
        Since:
        com.adobe.cq.wcm.core.components.models.tableofcontents 1.0

      • fromString

        public static TableOfContents.ListType fromString​(java.lang.String value)
        Given a String value, this method returns the enum's value that corresponds to the provided string representation. If no representation is found, bulleted will be returned.
        Parameters:
        value - the string representation for which an enum value should be returned
        Returns:
        the corresponding enum value, if one was found, or bulleted
        Since:
        com.adobe.cq.wcm.core.components.models.tableofcontents 1.0