Token (gutenberg 1.1.0 API)

java.lang.Object
- java.lang.Enum<Token>
- - gutenberg.pygments.Token

All Implemented Interfaces:

Serializable, Comparable<Token>
```
public enum Token
extends Enum<Token>
```
Author:

@aloyer

Enum Constant Summary

Enum Constants
Enum Constant and Description
`Comment`
`CommentMultiline`
`CommentPreproc`
`CommentSingle`
`CommentSpecial`
`Error`
`Escape`
`Generic` Generic tokens are for special lexers like the DiffLexer that doesn’t really highlight a programming language but a patch file.
`GenericDeleted` Marks the token value as deleted.
`GenericEmph` Marks the token value as emphasized.
`GenericError` Marks the token value as an error message.
`GenericHeading` Marks the token value as headline.
`GenericInserted` Marks the token value as inserted.
`GenericOutput` Marks the token value as program output (e.g. for python cli lexer).
`GenericPrompt` Marks the token value as command prompt (e.g. bash lexer).
`GenericStrong` Marks the token value as bold (e.g. for rst lexer).
`GenericSubheading` Marks the token value as subheadline.
`GenericTraceback` Marks the token value as a part of an error traceback.
`Keyword`
`KeywordConstant`
`KeywordDeclaration`
`KeywordNamespace`
`KeywordPseudo`
`KeywordReserved`
`KeywordType`
`Literal`
`LiteralDate`
`Name`
`NameAttribute`
`NameBuiltin`
`NameBuiltinPseudo`
`NameClass`
`NameConstant`
`NameDecorator`
`NameEntity`
`NameException`
`NameFunction`
`NameLabel`
`NameNamespace`
`NameOther`
`NameProperty`
`NameTag`
`NameVariable`
`NameVariableClass`
`NameVariableGlobal`
`NameVariableInstance`
`Number`
`NumberBin`
`NumberFloat`
`NumberHex`
`NumberInteger`
`NumberIntegerLong`
`NumberOct`
`Operator`
`OperatorWord`
`Other`
`Punctuation`
`String`
`StringBacktick`
`StringChar`
`StringDoc`
`StringDouble`
`StringEscape`
`StringHeredoc`
`StringInterpol`
`StringOther`
`StringRegex`
`StringSingle`
`StringSymbol`
`Text`
`Token`
`Whitespace`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static com.google.common.base.Optional<Token>`	`findTokenByRepr(String repr)`
`Token`	`parent()`
`List<Token>`	`path()`
`String`	`repr()`
`String`	`shortName()`
`static Token`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static Token[]`	`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

Token
```
public static final Token Token
```

Text
```
public static final Token Text
```

Whitespace
```
public static final Token Whitespace
```

Escape
```
public static final Token Escape
```

Error
```
public static final Token Error
```

Other
```
public static final Token Other
```

Keyword
```
public static final Token Keyword
```

KeywordConstant

public static final Token KeywordConstant

KeywordDeclaration

public static final Token KeywordDeclaration

KeywordNamespace

public static final Token KeywordNamespace

KeywordPseudo

public static final Token KeywordPseudo

KeywordReserved

public static final Token KeywordReserved

KeywordType
```
public static final Token KeywordType
```

Name
```
public static final Token Name
```

NameAttribute

public static final Token NameAttribute

NameBuiltin
```
public static final Token NameBuiltin
```

NameBuiltinPseudo

public static final Token NameBuiltinPseudo

NameClass
```
public static final Token NameClass
```

NameConstant
```
public static final Token NameConstant
```

NameDecorator

public static final Token NameDecorator

NameEntity
```
public static final Token NameEntity
```

NameException

public static final Token NameException

NameFunction
```
public static final Token NameFunction
```

NameProperty
```
public static final Token NameProperty
```

NameLabel
```
public static final Token NameLabel
```

NameNamespace

public static final Token NameNamespace

NameOther
```
public static final Token NameOther
```

NameTag
```
public static final Token NameTag
```

NameVariable
```
public static final Token NameVariable
```

NameVariableClass

public static final Token NameVariableClass

NameVariableGlobal

public static final Token NameVariableGlobal

NameVariableInstance

public static final Token NameVariableInstance

Literal
```
public static final Token Literal
```

LiteralDate
```
public static final Token LiteralDate
```

String
```
public static final Token String
```

StringBacktick

public static final Token StringBacktick

StringChar
```
public static final Token StringChar
```

StringDoc
```
public static final Token StringDoc
```

StringDouble
```
public static final Token StringDouble
```

StringEscape
```
public static final Token StringEscape
```

StringHeredoc

public static final Token StringHeredoc

StringInterpol

public static final Token StringInterpol

StringOther
```
public static final Token StringOther
```

StringRegex
```
public static final Token StringRegex
```

StringSingle
```
public static final Token StringSingle
```

StringSymbol
```
public static final Token StringSymbol
```

Number
```
public static final Token Number
```

NumberBin
```
public static final Token NumberBin
```

NumberFloat
```
public static final Token NumberFloat
```

NumberHex
```
public static final Token NumberHex
```

NumberInteger

public static final Token NumberInteger

NumberIntegerLong

public static final Token NumberIntegerLong

NumberOct
```
public static final Token NumberOct
```

Operator
```
public static final Token Operator
```

OperatorWord
```
public static final Token OperatorWord
```

Punctuation
```
public static final Token Punctuation
```

Comment
```
public static final Token Comment
```

CommentMultiline

public static final Token CommentMultiline

CommentPreproc

public static final Token CommentPreproc

CommentSingle

public static final Token CommentSingle

CommentSpecial

public static final Token CommentSpecial

Generic
```
public static final Token Generic
```
Generic tokens are for special lexers like the DiffLexer that doesn’t really highlight a programming language but a patch file. A generic, unstyled token. Normally you don’t use this token type.

GenericDeleted
```
public static final Token GenericDeleted
```
Marks the token value as deleted.

See Also:

Generic

GenericEmph
```
public static final Token GenericEmph
```
Marks the token value as emphasized.

See Also:

Generic

GenericError
```
public static final Token GenericError
```
Marks the token value as an error message.

See Also:

Generic

GenericHeading
```
public static final Token GenericHeading
```
Marks the token value as headline.

See Also:

Generic

GenericInserted
```
public static final Token GenericInserted
```
Marks the token value as inserted.

See Also:

Generic

GenericOutput
```
public static final Token GenericOutput
```
Marks the token value as program output (e.g. for python cli lexer).

See Also:

Generic

GenericPrompt
```
public static final Token GenericPrompt
```
Marks the token value as command prompt (e.g. bash lexer).

See Also:

Generic

GenericStrong
```
public static final Token GenericStrong
```
Marks the token value as bold (e.g. for rst lexer).

See Also:

Generic

GenericSubheading
```
public static final Token GenericSubheading
```
Marks the token value as subheadline.

See Also:

Generic

GenericTraceback
```
public static final Token GenericTraceback
```
Marks the token value as a part of an error traceback.

See Also:

Generic

Method Detail
- values
```
public static Token[] 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 (Token c : Token.values())
    System.out.println(c);
```
  Returns:
  
  an array containing the constants of this enum type, in the order they are declared
- valueOf
```
public static Token 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
- parent
```
public Token parent()
```
- shortName
```
public String shortName()
```
- findTokenByRepr
```
public static com.google.common.base.Optional<Token> findTokenByRepr(String repr)
```
- path
```
public List<Token> path()
```
- repr
```
public String repr()
```

Enum Token

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

Token

Text

Whitespace

Escape

Error

Other

Keyword

KeywordConstant

KeywordDeclaration

KeywordNamespace

KeywordPseudo

KeywordReserved

KeywordType

Name

NameAttribute

NameBuiltin

NameBuiltinPseudo

NameClass

NameConstant

NameDecorator

NameEntity

NameException

NameFunction

NameProperty

NameLabel

NameNamespace

NameOther

NameTag

NameVariable

NameVariableClass

NameVariableGlobal

NameVariableInstance

Literal

LiteralDate

String

StringBacktick

StringChar

StringDoc

StringDouble

StringEscape

StringHeredoc

StringInterpol

StringOther

StringRegex

StringSingle

StringSymbol

Number

NumberBin

NumberFloat

NumberHex

NumberInteger

NumberIntegerLong

NumberOct

Operator

OperatorWord

Punctuation

Comment

CommentMultiline

CommentPreproc

CommentSingle

CommentSpecial

Generic

GenericDeleted

GenericEmph

GenericError

GenericHeading

GenericInserted

GenericOutput

GenericPrompt

GenericStrong

GenericSubheading

GenericTraceback

Method Detail

values