Top Inners Fields Constructors Methods
com.vladsch.flexmark.ext.toc.internal

public Class TocOptions

extends Object
implements Immutable<TocOptions, TocOptions.AsMutable>, MutableDataSetter
Class Inheritance
All Implemented Interfaces
com.vladsch.flexmark.util.data.MutableDataSetter, com.vladsch.flexmark.util.misc.Immutable
Annotations
@SuppressWarnings:WeakerAccess
Imports
com.vladsch.flexmark.ext.toc.TocExtension, com.vladsch.flexmark.util.data.DataHolder, .MutableDataHolder, .MutableDataSetter, com.vladsch.flexmark.util.misc.CharPredicate, .Immutable, .Mutable, com.vladsch.flexmark.util.sequence.BasedSequence, .SequenceUtils, org.jetbrains.annotations.NotNull, .Nullable

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
public static enum

Field Summary

Modifier and TypeField and Description
public static final TocOptions
public static final int
public static final String
public static final int
public final String
public final boolean
public final boolean
public final boolean
public final boolean
public final boolean
public final boolean
public final int
public static final TocOptions.ListType
public final String
public final TocOptions.ListType
public final String
public final int
public static final int

Constructor Summary

AccessConstructor and Description
public
public
TocOptions(int levels, boolean isHtml, boolean isTextOnly, boolean isNumbered, TocOptions.ListType listType)

public
TocOptions(int levels, boolean isHtml, boolean isTextOnly, boolean isNumbered, int titleLevel, String title, TocOptions.ListType listType)

public
public
public
TocOptions(@Nullable DataHolder options, boolean isSimToc)

public
TocOptions(int levels, boolean isHtml, boolean isTextOnly, boolean isNumbered, int titleLevel, CharSequence title, TocOptions.ListType listType, boolean isAstAddOptions, boolean isBlankLineSpacer, CharSequence divClass, CharSequence listClass, boolean isCaseSensitiveTocTag)

Method Summary

Modifier and TypeMethod and Description
public boolean
equals(Object
the reference object with which to compare.
o
)

Overrides java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

public static int
getLevels(int... levelList)

public String
public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for this object.

public boolean
isLevelIncluded(int level)

public @NotNull MutableDataHolder
public TocOptions.AsMutable
public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.

public TocOptions
public TocOptions
withIsAstAddOptions(boolean isAstAddOptions)

public TocOptions
withIsBlankLineSpacer(boolean isBlankLineSpacer)

public TocOptions
withIsHtml(boolean isHtml)

public TocOptions
withIsNumbered(boolean isNumbered)

public TocOptions
withIsTextOnly(boolean isTextOnly)

public TocOptions
withLevelList(int... levelList)

public TocOptions
withLevels(int levels)

public TocOptions
public TocOptions
public TocOptions
public TocOptions
withRawTitleLevel(int titleLevel)

public TocOptions
public TocOptions
withTitleLevel(int titleLevel)

Inherited from java.lang.Object:
clonefinalizegetClassnotifynotifyAllwaitwaitwait

Field Detail

DEFAULTback to summary
public static final TocOptions DEFAULT
DEFAULT_LEVELSback to summary
public static final int DEFAULT_LEVELS
DEFAULT_TITLEback to summary
public static final String DEFAULT_TITLE
DEFAULT_TITLE_LEVELback to summary
public static final int DEFAULT_TITLE_LEVEL
divClassback to summary
public final String divClass
isAstAddOptionsback to summary
public final boolean isAstAddOptions
isBlankLineSpacerback to summary
public final boolean isBlankLineSpacer
isCaseSensitiveTocTagback to summary
public final boolean isCaseSensitiveTocTag
isHtmlback to summary
public final boolean isHtml
isNumberedback to summary
public final boolean isNumbered
isTextOnlyback to summary
public final boolean isTextOnly
levelsback to summary
public final int levels
LIST_TYPEback to summary
public static final TocOptions.ListType LIST_TYPE
listClassback to summary
public final String listClass
listTypeback to summary
public final TocOptions.ListType listType
titleback to summary
public final String title
titleLevelback to summary
public final int titleLevel
VALID_LEVELSback to summary
public static final int VALID_LEVELS

Constructor Detail

TocOptionsback to summary
public TocOptions()
TocOptionsback to summary
public TocOptions(int levels, boolean isHtml, boolean isTextOnly, boolean isNumbered, TocOptions.ListType listType)
TocOptionsback to summary
public TocOptions(int levels, boolean isHtml, boolean isTextOnly, boolean isNumbered, int titleLevel, String title, TocOptions.ListType listType)
TocOptionsback to summary
public TocOptions(TocOptions.AsMutable other)
TocOptionsback to summary
public TocOptions(@NotNull TocOptions other)
TocOptionsback to summary
public TocOptions(@Nullable DataHolder options, boolean isSimToc)
TocOptionsback to summary
public TocOptions(int levels, boolean isHtml, boolean isTextOnly, boolean isNumbered, int titleLevel, CharSequence title, TocOptions.ListType listType, boolean isAstAddOptions, boolean isBlankLineSpacer, CharSequence divClass, CharSequence listClass, boolean isCaseSensitiveTocTag)

Method Detail

equalsback to summary
public boolean equals(Object o)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

  • It is reflexive: for any non-null reference value x, x.equals(x) should return true.
  • It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
  • It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
  • For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters
o:Object

the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations
@Override
getLevelsback to summary
public static int getLevels(int... levelList)
getTitleHeadingback to summary
public String getTitleHeading()
hashCodeback to summary
public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

  • Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
  • If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
  • It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.
Returns:int

a hash code value for this object

Annotations
@Override
isLevelIncludedback to summary
public boolean isLevelIncluded(int level)
setInback to summary
public @NotNull MutableDataHolder setIn(@NotNull MutableDataHolder dataHolder)
Annotations
@NotNull
@Override
toMutableback to summary
public TocOptions.AsMutable toMutable()

Implements com.vladsch.flexmark.util.misc.Immutable.toMutable.

Annotations
@Override
toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

Annotations
@Override
withDivClassback to summary
public TocOptions withDivClass(CharSequence divClass)
withIsAstAddOptionsback to summary
public TocOptions withIsAstAddOptions(boolean isAstAddOptions)
withIsBlankLineSpacerback to summary
public TocOptions withIsBlankLineSpacer(boolean isBlankLineSpacer)
withIsHtmlback to summary
public TocOptions withIsHtml(boolean isHtml)
withIsNumberedback to summary
public TocOptions withIsNumbered(boolean isNumbered)
withIsTextOnlyback to summary
public TocOptions withIsTextOnly(boolean isTextOnly)
withLevelListback to summary
public TocOptions withLevelList(int... levelList)
withLevelsback to summary
public TocOptions withLevels(int levels)
withListClassback to summary
public TocOptions withListClass(CharSequence listClass)
withListTypeback to summary
public TocOptions withListType(TocOptions.ListType listType)
withRawTitleback to summary
public TocOptions withRawTitle(CharSequence title)
withRawTitleLevelback to summary
public TocOptions withRawTitleLevel(int titleLevel)
withTitleback to summary
public TocOptions withTitle(CharSequence title)
withTitleLevelback to summary
public TocOptions withTitleLevel(int titleLevel)
com.vladsch.flexmark.ext.toc.internal back to summary

public Class TocOptions.AsMutable

extends Object
implements Mutable<TocOptions.AsMutable, TocOptions>, MutableDataSetter
Class Inheritance
All Implemented Interfaces
com.vladsch.flexmark.util.data.MutableDataSetter, com.vladsch.flexmark.util.misc.Mutable

Field Summary

Modifier and TypeField and Description
public String
public boolean
public boolean
public boolean
public boolean
public boolean
public boolean
public int
public String
public TocOptions.ListType
public String
public int

Constructor Summary

AccessConstructor and Description
protected
protected

Method Summary

Modifier and TypeMethod and Description
public boolean
equals(Object
the reference object with which to compare.
o
)

Overrides java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for this object.

public TocOptions.AsMutable
normalizeTitle()

Used to normalize title and titleLevel after changing titleRaw or rawTitle

public @NotNull MutableDataHolder
public TocOptions.AsMutable
setLevelList(int... levelList)

public TocOptions
public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.

Inherited from java.lang.Object:
clonefinalizegetClassnotifynotifyAllwaitwaitwait

Field Detail

divClassback to summary
public String divClass
isAstAddOptionsback to summary
public boolean isAstAddOptions
isBlankLineSpacerback to summary
public boolean isBlankLineSpacer
isCaseSensitiveTocTagback to summary
public boolean isCaseSensitiveTocTag
isHtmlback to summary
public boolean isHtml
isNumberedback to summary
public boolean isNumbered
isTextOnlyback to summary
public boolean isTextOnly
levelsback to summary
public int levels
listClassback to summary
public String listClass
listTypeback to summary
public TocOptions.ListType listType
titleback to summary
public String title
titleLevelback to summary
public int titleLevel

Constructor Detail

AsMutableback to summary
protected AsMutable(TocOptions other)
AsMutableback to summary
protected AsMutable(TocOptions.AsMutable other)
Annotations
@SuppressWarnings:CopyConstructorMissesField, unused

Method Detail

equalsback to summary
public boolean equals(Object o)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

  • It is reflexive: for any non-null reference value x, x.equals(x) should return true.
  • It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
  • It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
  • For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters
o:Object

the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations
@Override
hashCodeback to summary
public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

  • Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
  • If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
  • It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.
Returns:int

a hash code value for this object

Annotations
@Override
normalizeTitleback to summary
public TocOptions.AsMutable normalizeTitle()

Used to normalize title and titleLevel after changing titleRaw or rawTitle

setInback to summary
public @NotNull MutableDataHolder setIn(@NotNull MutableDataHolder dataHolder)
Annotations
@NotNull
@Override
setLevelListback to summary
public TocOptions.AsMutable setLevelList(int... levelList)
toImmutableback to summary
public TocOptions toImmutable()

Implements com.vladsch.flexmark.util.misc.Mutable.toImmutable.

Annotations
@Override
toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

Annotations
@Override
com.vladsch.flexmark.ext.toc.internal back to summary

public final Enum TocOptions.ListType

extends Enum<TocOptions.ListType>
Class Inheritance

Field Summary

Modifier and TypeField and Description
public static final TocOptions.ListType
public static final TocOptions.ListType
public static final TocOptions.ListType
public static final TocOptions.ListType
public static final TocOptions.ListType

Constructor Summary

AccessConstructor and Description
private

Method Summary

Modifier and TypeMethod and Description
public static TocOptions.ListType
public static TocOptions.ListType[]
Inherited from java.lang.Enum:
clonecompareTodescribeConstableequalsfinalizegetDeclaringClasshashCodenameordinaltoStringvalueOf

Field Detail

FLATback to summary
public static final TocOptions.ListType FLAT
FLAT_REVERSEDback to summary
public static final TocOptions.ListType FLAT_REVERSED
HIERARCHYback to summary
public static final TocOptions.ListType HIERARCHY
SORTEDback to summary
public static final TocOptions.ListType SORTED
SORTED_REVERSEDback to summary
public static final TocOptions.ListType SORTED_REVERSED

Constructor Detail

ListTypeback to summary
private ListType()

Method Detail

valueOfback to summary
public static TocOptions.ListType valueOf(String name)
valuesback to summary
public static TocOptions.ListType[] values()