de.vandermeer.asciilist.styles

Interface ListStyle_Enumerate

All Known Implementing Classes:

EnumerateStyles

public interface ListStyle_Enumerate

Customizable style for enumerate (ordered) lists - AsciiList_Enumerate.

Since:

v0.0.1

Version:

v0.0.3 build 160301 (01-Mar-16) for Java 1.7

Author:

Sven van der Meer <vdmeer.sven@mykolab.com>

Method Summary

Modifier and Type	Method and Description
String	getLabel(int position) Returns the label according to the style for a particular position in an enumerate list.
StrBuilder	toDoc() Returns a representation of the list style useful for documentation

Method Detail

getLabel

String getLabel(int position)

Returns the label according to the style for a particular position in an enumerate list.

Parameters:

position - the position in the list (1 or greater)

Returns:

the calculated label

Throws:

IllegalArgumentException - if position is out of band (i.e. cannot be calculated)

toDoc

StrBuilder toDoc()

Returns a representation of the list style useful for documentation

Returns:

documentation representation of the list style