EnumerateStyles (ASCII List 0.0.3 API)

Object
- Enum<EnumerateStyles>
- - EnumerateStyles

All Implemented Interfaces:

ListStyle_Enumerate, Serializable, Comparable<EnumerateStyles>
```
public enum EnumerateStyles
extends Enum<EnumerateStyles>
implements ListStyle_Enumerate
```
Styles for an enumerate list /ordered list - 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>

Enum Constant Summary

Enum Constants
Enum Constant and Description
`alpha_ascii` Enumerate style using lower case alphanumeric characters.
`Alpha_ascii` Enumerate style using upper case alphanumeric characters.
`alpha_fullwidth` Enumerate style using upper case alphanumeric full width (UTF Fullwidth Latin Small) characters.
`alpha_utf_circle` Enumerate style using upper case alphanumeric circled (UTF Circled Latin Small Letters) characters.
`Alpha_utf_circle` Enumerate style using upper case alphanumeric circled (UTF Circled Latin Capital Letters) characters.
`Alpha_utf_fullwidth` Enumerate style using upper case alphanumeric full width (UTF Fullwidth Latin Capital) characters.
`alpha_utf_parenthesized` Enumerate style using upper case alphanumeric parenthesized (UTF Parenthesized Latin Small Letter) characters.
`arabic_ascii` Enumerate style using Arabic numbers For example:
`arabic_parenthesized` Enumerate style using Arabic parenthesized (UTF Parenthesized Digit) characters.
`arabic_utf_circle` Enumerate style using Arabic circled (UTF Circled Digit) characters.
`arabic_utf_circle_dingbat_negative` Enumerate style using Arabic circled dingbat negative (UTF Dingbat Negative Circled Digit) characters.
`arabic_utf_circle_dingbat_negative_sanserif` Enumerate style using Arabic circled dingbat negative sanserif (UTF Dingbat Negative Sanserif Circled Digit) characters.
`arabic_utf_circle_dingbat_sanserif` Enumerate style using Arabic circled dingbat sanserif (UTF Dingbat Sanserif Circled Digit) characters.
`arabic_utf_double_circle` Enumerate style using Arabic double circled (UTF Double Circled Digit) characters.
`arabic_utf_full_stop` Enumerate style using Arabic full stop (UTF Fullstop) characters.
`arabic_utf_fullwidth` Enumerate style using Arabic full width (UTF Fullwidth Digit) characters.
`arabic_utf_subscript` Enumerate style using Arabic subscript (UTF Subscript) characters.
`arabic_utf_superscript` Enumerate style using Arabic superscript (UTF Superscript) characters.
`roman_ascii` Enumerate style using lower case Roman number literals characters.
`Roman_ascii` Enumerate style using upper case Roman number literals characters.
`roman_utf_circled` Enumerate style using lower case circled Roman number literals (UTF Circled Latin Small) characters.
`Roman_utf_circled` Enumerate style using upper case circled Roman number literals (UTF Circled Latin Capital) characters.
`roman_utf_number_forms` Enumerate style using lower case Roman number literals (UTF Number Forms) characters.
`Roman_utf_number_forms` Enumerate style using upper case Roman number literals (UTF Number Forms) characters.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
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
`static EnumerateStyles`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static EnumerateStyles[]`	`values()` Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class Object
getClass, notify, notifyAll, wait, wait, wait

- Enum Constant Detail
  - Alpha_ascii
```
public static final EnumerateStyles Alpha_ascii
```
    Enumerate style using upper case alphanumeric characters. For example:
```
        A item 1
        B item 2
        C item 3
 
```
  - Alpha_utf_circle
```
public static final EnumerateStyles Alpha_utf_circle
```
    Enumerate style using upper case alphanumeric circled (UTF Circled Latin Capital Letters) characters. For example:
```
        Ⓐ item 1
        Ⓑ item 2
        Ⓒ item 3
 
```
  - Alpha_utf_fullwidth
```
public static final EnumerateStyles Alpha_utf_fullwidth
```
    Enumerate style using upper case alphanumeric full width (UTF Fullwidth Latin Capital) characters. For example:
```
        Ａ item 1
        Ｂ item 2
        Ｃ item 3
 
```
  - alpha_ascii
```
public static final EnumerateStyles alpha_ascii
```
    Enumerate style using lower case alphanumeric characters. For example:
```
        a item 1
        b item 2
        c item 3
 
```
  - alpha_utf_circle
```
public static final EnumerateStyles alpha_utf_circle
```
    Enumerate style using upper case alphanumeric circled (UTF Circled Latin Small Letters) characters. For example:
```
        ⓐ item 1
        ⓑ item 2
        ⓒ item 3
 
```
  - alpha_utf_parenthesized
```
public static final EnumerateStyles alpha_utf_parenthesized
```
    Enumerate style using upper case alphanumeric parenthesized (UTF Parenthesized Latin Small Letter) characters. For example:
```
        ⒜ item 1
        ⒝ item 2
        ⒞ item 3
 
```
  - alpha_fullwidth
```
public static final EnumerateStyles alpha_fullwidth
```
    Enumerate style using upper case alphanumeric full width (UTF Fullwidth Latin Small) characters. For example:
```
        ａ item 1
        ｂ item 2
        ｃ item 3
 
```
  - arabic_ascii
```
public static final EnumerateStyles arabic_ascii
```
    Enumerate style using Arabic numbers For example:
```
        1 item 1
        2 item 2
        3 item 3
 
```
  - arabic_utf_circle
```
public static final EnumerateStyles arabic_utf_circle
```
    Enumerate style using Arabic circled (UTF Circled Digit) characters. For example:
```
        ① item 1
        ② item 2
        ③ item 3
 
```
  - arabic_utf_double_circle
```
public static final EnumerateStyles arabic_utf_double_circle
```
    Enumerate style using Arabic double circled (UTF Double Circled Digit) characters. For example:
```
        ⓵ item 1
        ⓶ item 2
        ⓷ item 3
 
```
  - arabic_utf_circle_dingbat_negative
```
public static final EnumerateStyles arabic_utf_circle_dingbat_negative
```
    Enumerate style using Arabic circled dingbat negative (UTF Dingbat Negative Circled Digit) characters. For example:
```
        ❶ item 1
        ❷ item 2
        ❸ item 3
 
```
  - arabic_utf_circle_dingbat_sanserif
```
public static final EnumerateStyles arabic_utf_circle_dingbat_sanserif
```
    Enumerate style using Arabic circled dingbat sanserif (UTF Dingbat Sanserif Circled Digit) characters. For example:
```
        ➀ item 1
        ➁ item 2
        ➂ item 3
 
```
  - arabic_utf_circle_dingbat_negative_sanserif
```
public static final EnumerateStyles arabic_utf_circle_dingbat_negative_sanserif
```
    Enumerate style using Arabic circled dingbat negative sanserif (UTF Dingbat Negative Sanserif Circled Digit) characters. For example:
```
        ➊ item 1
        ➋ item 2
        ➌ item 3
 
```
  - arabic_utf_superscript
```
public static final EnumerateStyles arabic_utf_superscript
```
    Enumerate style using Arabic superscript (UTF Superscript) characters. For example:
```
        ⁱ item 1
        ² item 2
        ³ item 3
 
```
  - arabic_utf_subscript
```
public static final EnumerateStyles arabic_utf_subscript
```
    Enumerate style using Arabic subscript (UTF Subscript) characters. For example:
```
        ₁ item 1
        ₂ item 2
        ₃ item 3
 
```
  - arabic_utf_full_stop
```
public static final EnumerateStyles arabic_utf_full_stop
```
    Enumerate style using Arabic full stop (UTF Fullstop) characters. For example:
```
        ⒈ item 1
        ⒉ item 2
        ⒊ item 3
 
```
  - arabic_parenthesized
```
public static final EnumerateStyles arabic_parenthesized
```
    Enumerate style using Arabic parenthesized (UTF Parenthesized Digit) characters. For example:
```
        ⑴ item 1
        ⑵ item 2
        ⑶ item 3
 
```
  - arabic_utf_fullwidth
```
public static final EnumerateStyles arabic_utf_fullwidth
```
    Enumerate style using Arabic full width (UTF Fullwidth Digit) characters. For example:
```
        １ item 1
        ２ item 2
        ３ item 3
 
```
  - Roman_ascii
```
public static final EnumerateStyles Roman_ascii
```
    Enumerate style using upper case Roman number literals characters. For example:
```
        I item 1
        II item 2
        III item 3
 
```
  - Roman_utf_circled
```
public static final EnumerateStyles Roman_utf_circled
```
    Enumerate style using upper case circled Roman number literals (UTF Circled Latin Capital) characters. For example:
```
        Ⓘ item 1
        ⒾⒾ item 2
        ⒾⒾⒾ item 3
 
```
  - Roman_utf_number_forms
```
public static final EnumerateStyles Roman_utf_number_forms
```
    Enumerate style using upper case Roman number literals (UTF Number Forms) characters. For example:
```
        Ⅰ item 1
        Ⅱ item 2
        Ⅲ item 3
 
```
  - roman_ascii
```
public static final EnumerateStyles roman_ascii
```
    Enumerate style using lower case Roman number literals characters. For example:
```
        i item 1
        ii item 2
        iii item 3
 
```
  - roman_utf_circled
```
public static final EnumerateStyles roman_utf_circled
```
    Enumerate style using lower case circled Roman number literals (UTF Circled Latin Small) characters. For example:
```
        ⓘ item 1
        ⓘⓘ item 2
        ⓘⓘⓘ item 3
 
```
  - roman_utf_number_forms
```
public static final EnumerateStyles roman_utf_number_forms
```
    Enumerate style using lower case Roman number literals (UTF Number Forms) characters. For example:
```
        ⅰ item 1
        ⅱ item 2
        ⅲ item 3
 
```
- Method Detail
  - values
```
public static EnumerateStyles[] values()
```
    Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
```
for (EnumerateStyles c : EnumerateStyles.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static EnumerateStyles 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
  - getLabel
```
public String getLabel(int position)
```
    Description copied from interface: ListStyle_Enumerate
    
    Returns the label according to the style for a particular position in an enumerate list.
    
    Specified by:
    
    getLabel in interface ListStyle_Enumerate
    
    Parameters:
    
    position - the position in the list (1 or greater)
    
    Returns:
    
    the calculated label
  - toDoc
```
public StrBuilder toDoc()
```
    Description copied from interface: ListStyle_Enumerate
    
    Returns a representation of the list style useful for documentation
    
    Specified by:
    
    toDoc in interface ListStyle_Enumerate
    
    Returns:
    
    documentation representation of the list style

Enum EnumerateStyles

Enum Constant Summary

Method Summary

Methods inherited from class Enum

Methods inherited from class Object

Enum Constant Detail

Alpha_ascii

Alpha_utf_circle

Alpha_utf_fullwidth

alpha_ascii

alpha_utf_circle

alpha_utf_parenthesized

alpha_fullwidth

arabic_ascii

arabic_utf_circle

arabic_utf_double_circle

arabic_utf_circle_dingbat_negative

arabic_utf_circle_dingbat_sanserif

arabic_utf_circle_dingbat_negative_sanserif

arabic_utf_superscript

arabic_utf_subscript

arabic_utf_full_stop

arabic_parenthesized

arabic_utf_fullwidth

Roman_ascii

Roman_utf_circled

Roman_utf_number_forms

roman_ascii

roman_utf_circled

roman_utf_number_forms

Method Detail

values

valueOf

getLabel

toDoc