com.github.rjeschke.txtmark

Enum MarkToken

java.lang.Object

java.lang.Enum<MarkToken>

com.github.rjeschke.txtmark.MarkToken

All Implemented Interfaces:

Serializable, Comparable<MarkToken>

public enum MarkToken
extends Enum<MarkToken>

Markdown token enumeration.

Author:

René Jeschke

Enum Constant Summary

Enum Constants

Enum Constant and Description
CODE_DOUBLE ``
CODE_SINGLE `
EM_STAR *
EM_UNDERSCORE _
ENTITY &
ESCAPE \
HTML <
IMAGE ![
LINK [
NONE No token.
STRONG_STAR **
STRONG_UNDERSCORE __
SUPER Extended: ^
X_COPY Extended: (C)
X_HELLIP Extended: ...
X_LAQUO Extended: <<
X_LDQUO Extended: x"
X_LINK_CLOSE ]]
X_LINK_OPEN [[
X_MDASH Extended: ---
X_NDASH Extended: --
X_RAQUO Extended: >>
X_RDQUO Extended: "x
X_REG Extended: (R)
X_TRADE Extended: (TM)

Method Summary

Methods

Modifier and Type	Method and Description
static MarkToken	valueOf(String name) Returns the enum constant of this type with the specified name.
static MarkToken[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

NONE

public static final MarkToken NONE

No token.

EM_STAR

public static final MarkToken EM_STAR

*

EM_UNDERSCORE

public static final MarkToken EM_UNDERSCORE

_

STRONG_STAR

public static final MarkToken STRONG_STAR

**

STRONG_UNDERSCORE

public static final MarkToken STRONG_UNDERSCORE

__

CODE_SINGLE

public static final MarkToken CODE_SINGLE

`

CODE_DOUBLE

public static final MarkToken CODE_DOUBLE

``

LINK

public static final MarkToken LINK

[

HTML

public static final MarkToken HTML

<

IMAGE

public static final MarkToken IMAGE

![

ENTITY

public static final MarkToken ENTITY

&

ESCAPE

public static final MarkToken ESCAPE

\

SUPER

public static final MarkToken SUPER

Extended: ^

X_COPY

public static final MarkToken X_COPY

Extended: (C)

X_REG

public static final MarkToken X_REG

Extended: (R)

X_TRADE

public static final MarkToken X_TRADE

Extended: (TM)

X_LAQUO

public static final MarkToken X_LAQUO

Extended: <<

X_RAQUO

public static final MarkToken X_RAQUO

Extended: >>

X_NDASH

public static final MarkToken X_NDASH

Extended: --

X_MDASH

public static final MarkToken X_MDASH

Extended: ---

X_HELLIP

public static final MarkToken X_HELLIP

Extended: ...

X_RDQUO

public static final MarkToken X_RDQUO

Extended: "x

X_LDQUO

public static final MarkToken X_LDQUO

Extended: x"

X_LINK_OPEN

public static final MarkToken X_LINK_OPEN

[[

X_LINK_CLOSE

public static final MarkToken X_LINK_CLOSE

]]

Method Detail

values

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

Returns:

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

valueOf

public static MarkToken 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