SyntaxToken (AWS SDK for Android

java.lang.Object
- com.amazonaws.services.comprehend.model.SyntaxToken

All Implemented Interfaces:

java.io.Serializable
```
public class SyntaxToken
extends java.lang.Object
implements java.io.Serializable
```
Represents a work in the input text that was recognized and assigned a part of speech. There is one syntax token record for each word in the source text.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

SyntaxToken()

Constructors
Constructor and Description
`SyntaxToken()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(java.lang.Object obj)`
`java.lang.Integer`	`getBeginOffset()` The zero-based offset from the beginning of the source text to the first character in the word.
`java.lang.Integer`	`getEndOffset()` The zero-based offset from the beginning of the source text to the last character in the word.
`PartOfSpeechTag`	`getPartOfSpeech()` Provides the part of speech label and the confidence level that Amazon Comprehend has that the part of speech was correctly identified.
`java.lang.String`	`getText()` The word that was recognized in the source text.
`java.lang.Integer`	`getTokenId()` A unique identifier for a token.
`int`	`hashCode()`
`void`	`setBeginOffset(java.lang.Integer beginOffset)` The zero-based offset from the beginning of the source text to the first character in the word.
`void`	`setEndOffset(java.lang.Integer endOffset)` The zero-based offset from the beginning of the source text to the last character in the word.
`void`	`setPartOfSpeech(PartOfSpeechTag partOfSpeech)` Provides the part of speech label and the confidence level that Amazon Comprehend has that the part of speech was correctly identified.
`void`	`setText(java.lang.String text)` The word that was recognized in the source text.
`void`	`setTokenId(java.lang.Integer tokenId)` A unique identifier for a token.
`java.lang.String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`SyntaxToken`	`withBeginOffset(java.lang.Integer beginOffset)` The zero-based offset from the beginning of the source text to the first character in the word.
`SyntaxToken`	`withEndOffset(java.lang.Integer endOffset)` The zero-based offset from the beginning of the source text to the last character in the word.
`SyntaxToken`	`withPartOfSpeech(PartOfSpeechTag partOfSpeech)` Provides the part of speech label and the confidence level that Amazon Comprehend has that the part of speech was correctly identified.
`SyntaxToken`	`withText(java.lang.String text)` The word that was recognized in the source text.
`SyntaxToken`	`withTokenId(java.lang.Integer tokenId)` A unique identifier for a token.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - SyntaxToken
```
public SyntaxToken()
```
- Method Detail
  - getTokenId
```
public java.lang.Integer getTokenId()
```
    A unique identifier for a token.
    
    Returns:
    
    A unique identifier for a token.
  - setTokenId
```
public void setTokenId(java.lang.Integer tokenId)
```
    A unique identifier for a token.
    
    Parameters:
    
    tokenId -
    A unique identifier for a token.
  - withTokenId
```
public SyntaxToken withTokenId(java.lang.Integer tokenId)
```
    A unique identifier for a token.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    tokenId -
    A unique identifier for a token.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getText
```
public java.lang.String getText()
```
    The word that was recognized in the source text.
    
    Constraints:
    Length: 1 -
    
    Returns:
    
    The word that was recognized in the source text.
  - setText
```
public void setText(java.lang.String text)
```
    The word that was recognized in the source text.
    
    Constraints:
    Length: 1 -
    
    Parameters:
    
    text -
    The word that was recognized in the source text.
  - withText
```
public SyntaxToken withText(java.lang.String text)
```
    The word that was recognized in the source text.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 1 -
    
    Parameters:
    
    text -
    The word that was recognized in the source text.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getBeginOffset
```
public java.lang.Integer getBeginOffset()
```
    The zero-based offset from the beginning of the source text to the first character in the word.
    
    Returns:
    
    The zero-based offset from the beginning of the source text to the first character in the word.
  - setBeginOffset
```
public void setBeginOffset(java.lang.Integer beginOffset)
```
    The zero-based offset from the beginning of the source text to the first character in the word.
    
    Parameters:
    
    beginOffset -
    The zero-based offset from the beginning of the source text to the first character in the word.
  - withBeginOffset
```
public SyntaxToken withBeginOffset(java.lang.Integer beginOffset)
```
    The zero-based offset from the beginning of the source text to the first character in the word.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    beginOffset -
    The zero-based offset from the beginning of the source text to the first character in the word.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getEndOffset
```
public java.lang.Integer getEndOffset()
```
    The zero-based offset from the beginning of the source text to the last character in the word.
    
    Returns:
    
    The zero-based offset from the beginning of the source text to the last character in the word.
  - setEndOffset
```
public void setEndOffset(java.lang.Integer endOffset)
```
    The zero-based offset from the beginning of the source text to the last character in the word.
    
    Parameters:
    
    endOffset -
    The zero-based offset from the beginning of the source text to the last character in the word.
  - withEndOffset
```
public SyntaxToken withEndOffset(java.lang.Integer endOffset)
```
    The zero-based offset from the beginning of the source text to the last character in the word.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    endOffset -
    The zero-based offset from the beginning of the source text to the last character in the word.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getPartOfSpeech
```
public PartOfSpeechTag getPartOfSpeech()
```
    Provides the part of speech label and the confidence level that Amazon Comprehend has that the part of speech was correctly identified. For more information, see how-syntax.
    
    Returns:
    
    Provides the part of speech label and the confidence level that Amazon Comprehend has that the part of speech was correctly identified. For more information, see how-syntax.
  - setPartOfSpeech
```
public void setPartOfSpeech(PartOfSpeechTag partOfSpeech)
```
    Provides the part of speech label and the confidence level that Amazon Comprehend has that the part of speech was correctly identified. For more information, see how-syntax.
    
    Parameters:
    
    partOfSpeech -
    Provides the part of speech label and the confidence level that Amazon Comprehend has that the part of speech was correctly identified. For more information, see how-syntax.
  - withPartOfSpeech
```
public SyntaxToken withPartOfSpeech(PartOfSpeechTag partOfSpeech)
```
    Provides the part of speech label and the confidence level that Amazon Comprehend has that the part of speech was correctly identified. For more information, see how-syntax.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    partOfSpeech -
    Provides the part of speech label and the confidence level that Amazon Comprehend has that the part of speech was correctly identified. For more information, see how-syntax.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - toString
```
public java.lang.String toString()
```
    Returns a string representation of this object; useful for testing and debugging.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - 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

Class SyntaxToken

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

SyntaxToken

Method Detail

getTokenId

setTokenId

withTokenId

getText

setText

withText

getBeginOffset

setBeginOffset

withBeginOffset

getEndOffset

setEndOffset

withEndOffset

getPartOfSpeech

setPartOfSpeech

withPartOfSpeech

toString

hashCode

equals