de.vandermeer.asciithemes

Interface TA_Numbering

All Superinterfaces:

CategoryHas, CategoryIs, HasDescription, HasToDoc, IsTextArt

public interface TA_Numbering
extends IsTextArt

Root for text art numbering objects, realizing any kind of numbering for instance for headings or enumerate lists.

Since:

v0.0.1

Version:

v0.0.1 build 170404 (04-Apr-17) for Java 1.8

Author:

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

Field Summary

Fields inherited from interface HasDescription

DEFAULT_DESCRIPTION

Method Summary

Modifier and Type	Method and Description
int	getMaxNumber() Returns the maximum number supported by the scheme.
int	getMinNumber() Returns the minimum number supported by the scheme.
String	getNumber(int number) Returns a string representation of the given number using the underlying numbering scheme
default StrBuilder	toDoc()

Methods inherited from interface HasDescription

getDescription

Method Detail

getMinNumber

int getMinNumber()

Returns the minimum number supported by the scheme.

Returns:

minimum number

getMaxNumber

int getMaxNumber()

Returns the maximum number supported by the scheme.

Returns:

maximum number

getNumber

String getNumber(int number)

Returns a string representation of the given number using the underlying numbering scheme

Parameters:

number - the number to convert to a string

Returns:

string representation of the number

Throws:

IllegalArgumentException - if the number could not represented by a string because the number was out of range for the scheme

toDoc

default StrBuilder toDoc()

Specified by:

toDoc in interface HasToDoc