Token (code-augmentor-core 2.2.0 API)

java.lang.Object
- com.aaronicsubstances.code.augmentor.core.util.Token

```
public class Token
extends java.lang.Object
```
Result of tokenizing file with SourceCodeTokenizer.
A token is a line with data associated with it for classifying it.

Field Summary

Fields
Modifier and Type	Field and Description
`int`	`augCodeSpecIndex` Applies only to augmenting code token lines to indicate the index of the directive set of which the directive of the augmenting code line is part.
`static int`	`DIRECTIVE_TYPE_AUG_CODE` Indicates augmenting code section line other than embedded string or embedded JSON line.
`static int`	`DIRECTIVE_TYPE_EMB_JSON` Indicates embedded JSON line.
`static int`	`DIRECTIVE_TYPE_EMB_STRING` Indicates embedded string line.
`static int`	`DIRECTIVE_TYPE_SKIP_CODE_END` Indicates that a token line ends a skip code section or a generated code section.
`static int`	`DIRECTIVE_TYPE_SKIP_CODE_START` Indicates that a token line starts a skip code section, starts a generated code section, or is an inline generated code section line.
`java.lang.String`	`directiveContent` Stores substring of line after directive text, after nested level marker, and before ending newline.
`java.lang.String`	`directiveMarker` If token line has a directive as prefix, this field stores the text of that directive.
`int`	`endPos` offset after end of token line.
`java.lang.String`	`indent` Leading whitespace indent of token line.
`int`	`index` Used to store index of token in tokens parsed from a file.
`boolean`	`isGeneratedCodeMarker` Identifies use of generated code directive in a skip code directive token line.
`boolean`	`isInlineGeneratedCodeMarker` Identifies use of inline generated code directive in a skip code directive token line.
`int`	`lineNumber` Token line number.
`java.lang.String`	`nestedLevelEndMarker` Stores any nested level end marker found in token line starting augmenting code section.
`int`	`nestedLevelNumber` Available for use during prepare stage of Code Augmentor to store nested level numbers of augmenting code token lines.
`java.lang.String`	`nestedLevelStartMarker` Stores any nested level start marker found in token line starting augmenting code section.
`java.lang.String`	`newline` Ending newline of token line or null if line is the last line of a file which doesn't end with a newline.
`int`	`startPos` offset of token line
`java.lang.String`	`text` full text of token line including any ending newline.
`int`	`type` type of token line
`static int`	`TYPE_BLANK` Indicates line consisting of only whitespace.
`static int`	`TYPE_OTHER` Indicates line which does not start with a directive, and has non whitespace character.

Constructor Summary

Constructors
Constructor and Description

Token()
Used for JSON serialization.

Token(int type)
Constructs token with required type of the token

Constructors
Constructor and Description
`Token()` Used for JSON serialization.
`Token(int type)` Constructs token with required type of the token

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type Method and Description

boolean equals(java.lang.Object obj)

int hashCode()

java.lang.String toString()
- Methods inherited from class java.lang.Object
  clone, finalize, getClass, notify, notifyAll, wait, wait, wait

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(java.lang.Object obj)`
`int`	`hashCode()`
`java.lang.String`	`toString()`

- Field Detail
  - DIRECTIVE_TYPE_SKIP_CODE_START
```
public static final int DIRECTIVE_TYPE_SKIP_CODE_START
```
    Indicates that a token line starts a skip code section, starts a generated code section, or is an inline generated code section line.
    
    See Also:
    
    Constant Field Values
  - DIRECTIVE_TYPE_SKIP_CODE_END
```
public static final int DIRECTIVE_TYPE_SKIP_CODE_END
```
    Indicates that a token line ends a skip code section or a generated code section.
    
    See Also:
    
    Constant Field Values
  - DIRECTIVE_TYPE_EMB_STRING
```
public static final int DIRECTIVE_TYPE_EMB_STRING
```
    Indicates embedded string line.
    
    See Also:
    
    Constant Field Values
  - DIRECTIVE_TYPE_EMB_JSON
```
public static final int DIRECTIVE_TYPE_EMB_JSON
```
    Indicates embedded JSON line.
    
    See Also:
    
    Constant Field Values
  - DIRECTIVE_TYPE_AUG_CODE
```
public static final int DIRECTIVE_TYPE_AUG_CODE
```
    Indicates augmenting code section line other than embedded string or embedded JSON line.
    
    See Also:
    
    Constant Field Values
  - TYPE_BLANK
```
public static final int TYPE_BLANK
```
    Indicates line consisting of only whitespace.
    
    See Also:
    
    Constant Field Values
  - TYPE_OTHER
```
public static final int TYPE_OTHER
```
    Indicates line which does not start with a directive, and has non whitespace character.
    
    See Also:
    
    Constant Field Values
  - type
```
public int type
```
    type of token line
  - text
```
public java.lang.String text
```
    full text of token line including any ending newline.
  - startPos
```
public int startPos
```
    offset of token line
  - endPos
```
public int endPos
```
    offset after end of token line.
  - lineNumber
```
public int lineNumber
```
    Token line number. Starts from 1.
  - index
```
public int index
```
    Used to store index of token in tokens parsed from a file.
  - augCodeSpecIndex
```
public int augCodeSpecIndex
```
    Applies only to augmenting code token lines to indicate the index of the directive set of which the directive of the augmenting code line is part.
  - indent
```
public java.lang.String indent
```
    Leading whitespace indent of token line. Null if line consists of whitespace only.
  - directiveMarker
```
public java.lang.String directiveMarker
```
    If token line has a directive as prefix, this field stores the text of that directive.
  - directiveContent
```
public java.lang.String directiveContent
```
    Stores substring of line after directive text, after nested level marker, and before ending newline.
  - newline
```
public java.lang.String newline
```
    Ending newline of token line or null if line is the last line of a file which doesn't end with a newline.
  - isGeneratedCodeMarker
```
public boolean isGeneratedCodeMarker
```
    Identifies use of generated code directive in a skip code directive token line.
  - isInlineGeneratedCodeMarker
```
public boolean isInlineGeneratedCodeMarker
```
    Identifies use of inline generated code directive in a skip code directive token line.
  - nestedLevelStartMarker
```
public java.lang.String nestedLevelStartMarker
```
    Stores any nested level start marker found in token line starting augmenting code section.
  - nestedLevelEndMarker
```
public java.lang.String nestedLevelEndMarker
```
    Stores any nested level end marker found in token line starting augmenting code section.
  - nestedLevelNumber
```
public int nestedLevelNumber
```
    Available for use during prepare stage of Code Augmentor to store nested level numbers of augmenting code token lines.
- Constructor Detail
  - Token
```
public Token()
```
    Used for JSON serialization.
  - Token
```
public Token(int type)
```
    Constructs token with required type of the token
    
    Parameters:
    
    type - token type
- Method Detail
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Overrides:
    
    equals in class java.lang.Object
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object

Class Token

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DIRECTIVE_TYPE_SKIP_CODE_START

DIRECTIVE_TYPE_SKIP_CODE_END

DIRECTIVE_TYPE_EMB_STRING

DIRECTIVE_TYPE_EMB_JSON

DIRECTIVE_TYPE_AUG_CODE

TYPE_BLANK

TYPE_OTHER

type

text

startPos

endPos

lineNumber

index

augCodeSpecIndex

indent

directiveMarker

directiveContent

newline

isGeneratedCodeMarker

isInlineGeneratedCodeMarker

nestedLevelStartMarker

nestedLevelEndMarker

nestedLevelNumber

Constructor Detail

Token

Token

Method Detail

hashCode

equals

toString