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

Enum TableOfContents.HeadingLevel

java.lang.Object

java.lang.Enum<TableOfContents.HeadingLevel>

com.adobe.cq.wcm.core.components.models.TableOfContents.HeadingLevel

All Implemented Interfaces:

Serializable, Comparable<TableOfContents.HeadingLevel>, java.lang.constant.Constable

Enclosing interface:

TableOfContents

public static enum TableOfContents.HeadingLevel
extends 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

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
h1
h2
h3
h4
h5
h6

Method Summary

Modifier and Type	Method	Description
static TableOfContents.HeadingLevel	fromString(String value)	Given an String value, this method returns the enum's value that corresponds to the provided string representation.
static TableOfContents.HeadingLevel	fromStringOrDefault(String value, TableOfContents.HeadingLevel defaultLevel)	Given an String value, this method returns the enum's value that corresponds to the provided string representation.
Integer	getIntValue()
String	getTagName()	Returns the HTML tag name corresponding to this heading level
String	getValue()
static TableOfContents.HeadingLevel	valueOf(String name)	Returns the enum constant of this type with the specified name.
static TableOfContents.HeadingLevel[]	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, describeConstable, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

h1

public static final TableOfContents.HeadingLevel h1

h2

public static final TableOfContents.HeadingLevel h2

h3

public static final TableOfContents.HeadingLevel h3

h4

public static final TableOfContents.HeadingLevel h4

h5

public static final TableOfContents.HeadingLevel h5

h6

public static final TableOfContents.HeadingLevel h6

Method Details

values

public static TableOfContents.HeadingLevel[] values()

Returns an array containing the constants of this enum type, in the order they are declared.

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static TableOfContents.HeadingLevel valueOf(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:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getValue

public String getValue()

getIntValue

public Integer getIntValue()

getTagName

public 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(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(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