de.vandermeer.asciilist.styles

Enum NestedItemizeStyles

Object

Enum<NestedItemizeStyles>

NestedItemizeStyles

All Implemented Interfaces:

ListStyle, ListStyle_ItemizeNested, Serializable, Comparable<NestedItemizeStyles>

public enum NestedItemizeStyles
extends Enum<NestedItemizeStyles>
implements ListStyle_ItemizeNested

Standard styles for itemize (unordered) lists implementing ListStyle_ItemizeNested for 6 levels.

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
ALL_HYPHEN Style using the "-" character for unlimited levels.
ALL_HYPHEN_INCREMENTAL Style using the "-" character, incremental for 6 levels.
ALL_PLUS Style using the "+" character for unlimited levels.
ALL_PLUS_INCREMENTAL Style using the "+" character, incremental for 6 levels.
ALL_STAR Style using the "*" character for unlimited levels.
ALL_STAR_INCREMENTAL Style using the "*" character, incremental for 6 levels.
HTML_LIKE Style using standard HTML characters for 3 levels (bullet, circle, square).
UTF_ARROS Style using several UTF-8 arrow characters.
UTF_FLORETTE Style using several UTF-8 florette characters.
UTF_SNOWFLAKE Style using several UTF-8 snowflake characters.
UTF_SPARKLE Style using several UTF-8 sparkle characters.
UTF_STARS Style using several UTF-8 star characters.
UTF_STARS_OUTLINE Style using several UTF-8 star characters.
UTF_TEAR_DROP Style using several UTF-8 tear drop characters.

Method Summary

Modifier and Type	Method and Description
String	getLabel(int level) Returns the label for a given level.
StrBuilder	toDoc() Returns a representation of the list style useful for documentation
static NestedItemizeStyles	valueOf(String name) Returns the enum constant of this type with the specified name.
static NestedItemizeStyles[]	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

ALL_STAR

public static final NestedItemizeStyles ALL_STAR

Style using the "*" character for unlimited levels. For example:

        * item 1
        * item 2
           * item 1
           * item 2
              * item 1
              * item 2
                 * item 1
                 * item 2
                    * item 1
                    * item 2
                       * item 1
                       * item 2
 

ALL_STAR_INCREMENTAL

public static final NestedItemizeStyles ALL_STAR_INCREMENTAL

Style using the "*" character, incremental for 6 levels. For example:

        * item 1
        * item 2
           ** item 1
           ** item 2
              *** item 1
              *** item 2
                 **** item 1
                 **** item 2
                    ***** item 1
                    ***** item 2
                       ****** item 1
                       ****** item 2
 

ALL_HYPHEN

public static final NestedItemizeStyles ALL_HYPHEN

Style using the "-" character for unlimited levels. For example:

        - item 1
        - item 2
           - item 1
           - item 2
              - item 1
              - item 2
                 - item 1
                 - item 2
                    - item 1
                    - item 2
                       - item 1
                       - item 2
 

ALL_HYPHEN_INCREMENTAL

public static final NestedItemizeStyles ALL_HYPHEN_INCREMENTAL

Style using the "-" character, incremental for 6 levels. For example:

        - item 1
        - item 2
           -- item 1
           -- item 2
              --- item 1
              --- item 2
                 ---- item 1
                 ---- item 2
                    ----- item 1
                    ----- item 2
                       ------ item 1
                       ------ item 2
 

ALL_PLUS

public static final NestedItemizeStyles ALL_PLUS

Style using the "+" character for unlimited levels. For example:

        + item 1
        + item 2
           + item 1
           + item 2
              + item 1
              + item 2
                 + item 1
                 + item 2
                    + item 1
                    + item 2
                       + item 1
                       + item 2
 

ALL_PLUS_INCREMENTAL

public static final NestedItemizeStyles ALL_PLUS_INCREMENTAL

Style using the "+" character, incremental for 6 levels. For example:

        + item 1
        + item 2
           ++ item 1
           ++ item 2
              +++ item 1
              +++ item 2
                 ++++ item 1
                 ++++ item 2
                    +++++ item 1
                    +++++ item 2
                       ++++++ item 1
                       ++++++ item 2
 

HTML_LIKE

public static final NestedItemizeStyles HTML_LIKE

Style using standard HTML characters for 3 levels (bullet, circle, square). For example:

        • item 1
        • item 2
           ○ item 1
           ○ item 2
              ▪ item 1
              ▪ item 2
 

UTF_ARROS

public static final NestedItemizeStyles UTF_ARROS

Style using several UTF-8 arrow characters. For example:

        ➔ item 1
        ➔ item 2
           ➜ item 1
           ➜ item 2
              ➡ item 1
              ➡ item 2
                 ➞ item 1
                 ➞ item 2
                    ➝ item 1
                    ➝ item 2
                       ➙ item 1
                       ➙ item 2
 

UTF_STARS

public static final NestedItemizeStyles UTF_STARS

Style using several UTF-8 star characters. For example:

        ✳ item 1
        ✳ item 2
           ✴ item 1
           ✴ item 2
              ✵ item 1
              ✵ item 2
                 ✷ item 1
                 ✷ item 2
                    ✹ item 1
                    ✹ item 2
                       ✺ item 1
                       ✺ item 2
 

UTF_STARS_OUTLINE

public static final NestedItemizeStyles UTF_STARS_OUTLINE

Style using several UTF-8 star characters. For example:

        ✧ item 1
        ✧ item 2
           ✩ item 1
           ✩ item 2
              ✫ item 1
              ✫ item 2
                 ✬ item 1
                 ✬ item 2
                    ✭ item 1
                    ✭ item 2
                       ✯ item 1
                       ✯ item 2
 

UTF_TEAR_DROP

public static final NestedItemizeStyles UTF_TEAR_DROP

Style using several UTF-8 tear drop characters. For example:

        ✻ item 1
        ✻ item 2
            ✼ item 1
            ✼ item 2
              ✾ item 1
              ✾ item 2
 

UTF_FLORETTE

public static final NestedItemizeStyles UTF_FLORETTE

Style using several UTF-8 florette characters. For example:

        ✿ item 1
        ✿ item 2
           ❀ item 1
           ❀ item 2
              ❁ item 1
              ❁ item 2
 

UTF_SNOWFLAKE

public static final NestedItemizeStyles UTF_SNOWFLAKE

Style using several UTF-8 snowflake characters. For example:

        ❄ item 1
        ❄ item 2
           ❅ item 1
           ❅ item 2
              ❆ item 1
              ❆ item 2
 

UTF_SPARKLE

public static final NestedItemizeStyles UTF_SPARKLE

Style using several UTF-8 sparkle characters. For example:

        ❇ item 1
        ❇ item 2
           ❈ item 1
           ❈ item 2
 

Method Detail

values

public static NestedItemizeStyles[] 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 (NestedItemizeStyles c : NestedItemizeStyles.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static NestedItemizeStyles 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 level)

Description copied from interface: ListStyle_ItemizeNested

Returns the label for a given level.

Specified by:

getLabel in interface ListStyle_ItemizeNested

Parameters:

level - the level for the requested style

Returns:

label for a given level, null if not set or supported

toDoc

public StrBuilder toDoc()

Description copied from interface: ListStyle

Returns a representation of the list style useful for documentation

Specified by:

toDoc in interface ListStyle

Returns:

documentation representation of the list style