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

Enum TableOfContents.HeadingLevel

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<TableOfContents.HeadingLevel>
    Enclosing interface:
    TableOfContents
    public static enum TableOfContents.HeadingLevel
extends java.lang.Enum<TableOfContents.HeadingLevel>
    Defines the possible heading levels for table of contents corresponding to 'h1' till 'h6'
    Since:
    com.adobe.cq.wcm.core.components.models.tableofcontents 1.0

    • Method Detail

      • values

        public static TableOfContents.HeadingLevel[] 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.HeadingLevel c : TableOfContents.HeadingLevel.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.HeadingLevel 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()

      • getIntValue

        public java.lang.Integer getIntValue()

      • getTagName

        public java.lang.String getTagName()
        Returns the HTML tag name corresponding to this heading level
        Returns:
        HTML tag name
        Since:
        com.adobe.cq.wcm.core.components.models.tableofcontents 1.0

      • fromString

        public static TableOfContents.HeadingLevel fromString​(java.lang.String value)
        Given an String value, this method returns the enum's value that corresponds to the provided string representation. If no representation is found, null 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 null
        Since:
        com.adobe.cq.wcm.core.components.models.tableofcontents 1.0

      • fromStringOrDefault

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