OrderedList

java.lang.Object

org.commonmark.node.Node

org.commonmark.node.Block

org.commonmark.node.ListBlock

org.commonmark.node.OrderedList

public class OrderedList extends ListBlock

An ordered list, e.g.:


 1. One
 2. Two
 3. Three

The children are ListItem blocks, which contain other blocks (or nested lists).

See Also:

CommonMark Spec: List items

Field Summary

Fields

Modifier and Type

Field

Description

private String

markerDelimiter

private Integer

markerStartNumber
Constructor Summary

Constructors

Constructor

Description

OrderedList()
Method Summary

Modifier and Type

Method

Description

void

accept(Visitor visitor)

char

getDelimiter()

Deprecated.
use getMarkerDelimiter() instead

String

getMarkerDelimiter()

Integer

getMarkerStartNumber()

int

getStartNumber()

Deprecated.
use getMarkerStartNumber() instead

void

setDelimiter(char delimiter)

Deprecated.
use setMarkerDelimiter(java.lang.String) instead

void

setMarkerDelimiter(String markerDelimiter)

void

setMarkerStartNumber(Integer markerStartNumber)

void

setStartNumber(int startNumber)

Deprecated.
use setMarkerStartNumber(java.lang.Integer) instead

Methods inherited from class org.commonmark.node.ListBlock
isTight, setTight

Methods inherited from class org.commonmark.node.Block
getParent, setParent

Methods inherited from class org.commonmark.node.Node
addSourceSpan, appendChild, getFirstChild, getLastChild, getNext, getPrevious, getSourceSpans, insertAfter, insertBefore, prependChild, setSourceSpans, toString, toStringAttributes, unlink

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details
- markerDelimiter
  
  private String markerDelimiter
- markerStartNumber
  
  private Integer markerStartNumber
Constructor Details
- OrderedList
  
  public OrderedList()
Method Details
- accept
  
  public void accept(Visitor visitor)
  
  Specified by:
  
  accept in class Node
- getMarkerStartNumber
  
  public Integer getMarkerStartNumber()
  
  Returns:
  
  the start number used in the marker, e.g. 1, if available, or null otherwise
- setMarkerStartNumber
  
  public void setMarkerStartNumber(Integer markerStartNumber)
- getMarkerDelimiter
  
  public String getMarkerDelimiter()
  
  Returns:
  
  the delimiter used in the marker, e.g. . or ), if available, or null otherwise
- setMarkerDelimiter
  
  public void setMarkerDelimiter(String markerDelimiter)
- getStartNumber
  
  @Deprecated public int getStartNumber()
  
  Deprecated.
  use getMarkerStartNumber() instead
- setStartNumber
  
  @Deprecated public void setStartNumber(int startNumber)
  
  Deprecated.
  use setMarkerStartNumber(java.lang.Integer) instead
- getDelimiter
  
  @Deprecated public char getDelimiter()
  
  Deprecated.
  use getMarkerDelimiter() instead
- setDelimiter
  
  @Deprecated public void setDelimiter(char delimiter)
  
  Deprecated.
  use setMarkerDelimiter(java.lang.String) instead