com.amazonaws.services.comprehend.model.DetectSyntaxResult Maven / Gradle / Ivy
Show all versions of aws-java-sdk-comprehend Show documentation
/*
* Copyright 2018-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.comprehend.model;
import java.io.Serializable;
import javax.annotation.Generated;
/**
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class DetectSyntaxResult extends com.amazonaws.AmazonWebServiceResult implements Serializable, Cloneable {
/**
*
* A collection of syntax tokens describing the text. For each token, the response provides the text, the token
* type, where the text begins and ends, and the level of confidence that Amazon Comprehend has that the token is
* correct. For a list of token types, see Syntax in the Comprehend Developer
* Guide.
*
*/
private java.util.List syntaxTokens;
/**
*
* A collection of syntax tokens describing the text. For each token, the response provides the text, the token
* type, where the text begins and ends, and the level of confidence that Amazon Comprehend has that the token is
* correct. For a list of token types, see Syntax in the Comprehend Developer
* Guide.
*
*
* @return A collection of syntax tokens describing the text. For each token, the response provides the text, the
* token type, where the text begins and ends, and the level of confidence that Amazon Comprehend has that
* the token is correct. For a list of token types, see Syntax in the Comprehend
* Developer Guide.
*/
public java.util.List getSyntaxTokens() {
return syntaxTokens;
}
/**
*
* A collection of syntax tokens describing the text. For each token, the response provides the text, the token
* type, where the text begins and ends, and the level of confidence that Amazon Comprehend has that the token is
* correct. For a list of token types, see Syntax in the Comprehend Developer
* Guide.
*
*
* @param syntaxTokens
* A collection of syntax tokens describing the text. For each token, the response provides the text, the
* token type, where the text begins and ends, and the level of confidence that Amazon Comprehend has that
* the token is correct. For a list of token types, see Syntax in the Comprehend
* Developer Guide.
*/
public void setSyntaxTokens(java.util.Collection syntaxTokens) {
if (syntaxTokens == null) {
this.syntaxTokens = null;
return;
}
this.syntaxTokens = new java.util.ArrayList(syntaxTokens);
}
/**
*
* A collection of syntax tokens describing the text. For each token, the response provides the text, the token
* type, where the text begins and ends, and the level of confidence that Amazon Comprehend has that the token is
* correct. For a list of token types, see Syntax in the Comprehend Developer
* Guide.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setSyntaxTokens(java.util.Collection)} or {@link #withSyntaxTokens(java.util.Collection)} if you want to
* override the existing values.
*
*
* @param syntaxTokens
* A collection of syntax tokens describing the text. For each token, the response provides the text, the
* token type, where the text begins and ends, and the level of confidence that Amazon Comprehend has that
* the token is correct. For a list of token types, see Syntax in the Comprehend
* Developer Guide.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DetectSyntaxResult withSyntaxTokens(SyntaxToken... syntaxTokens) {
if (this.syntaxTokens == null) {
setSyntaxTokens(new java.util.ArrayList(syntaxTokens.length));
}
for (SyntaxToken ele : syntaxTokens) {
this.syntaxTokens.add(ele);
}
return this;
}
/**
*
* A collection of syntax tokens describing the text. For each token, the response provides the text, the token
* type, where the text begins and ends, and the level of confidence that Amazon Comprehend has that the token is
* correct. For a list of token types, see Syntax in the Comprehend Developer
* Guide.
*
*
* @param syntaxTokens
* A collection of syntax tokens describing the text. For each token, the response provides the text, the
* token type, where the text begins and ends, and the level of confidence that Amazon Comprehend has that
* the token is correct. For a list of token types, see Syntax in the Comprehend
* Developer Guide.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DetectSyntaxResult withSyntaxTokens(java.util.Collection syntaxTokens) {
setSyntaxTokens(syntaxTokens);
return this;
}
/**
* Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be
* redacted from this string using a placeholder value.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getSyntaxTokens() != null)
sb.append("SyntaxTokens: ").append(getSyntaxTokens());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof DetectSyntaxResult == false)
return false;
DetectSyntaxResult other = (DetectSyntaxResult) obj;
if (other.getSyntaxTokens() == null ^ this.getSyntaxTokens() == null)
return false;
if (other.getSyntaxTokens() != null && other.getSyntaxTokens().equals(this.getSyntaxTokens()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getSyntaxTokens() == null) ? 0 : getSyntaxTokens().hashCode());
return hashCode;
}
@Override
public DetectSyntaxResult clone() {
try {
return (DetectSyntaxResult) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
}
}
}