• Home
• com.amazonaws
• aws-java-sdk-kendra
• 1.11.735
• source code
• TextWithHighlights.java

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

com.amazonaws.services.kendra.model.TextWithHighlights Maven / Gradle / Ivy

/*
 * Copyright 2015-2020 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.kendra.model;

import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.protocol.StructuredPojo;
import com.amazonaws.protocol.ProtocolMarshaller;

/**
 * 

 * Provides text and information about where to highlight the text.
 * 
 * 
 * @see AWS API
 *      Documentation
 */
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class TextWithHighlights implements Serializable, Cloneable, StructuredPojo {

    /**
     * 

     * The text to display to the user.
     * 
     */
    private String text;
    /**
     * 

     * The beginning and end of the text that should be highlighted.
     * 
     */
    private java.util.List highlights;

    /**
     * 

     * The text to display to the user.
     * 
     * 
     * @param text
     *        The text to display to the user.
     */

    public void setText(String text) {
        this.text = text;
    }

    /**
     * 

     * The text to display to the user.
     * 
     * 
     * @return The text to display to the user.
     */

    public String getText() {
        return this.text;
    }

    /**
     * 

     * The text to display to the user.
     * 
     * 
     * @param text
     *        The text to display to the user.
     * @return Returns a reference to this object so that method calls can be chained together.
     */

    public TextWithHighlights withText(String text) {
        setText(text);
        return this;
    }

    /**
     * 

     * The beginning and end of the text that should be highlighted.
     * 
     * 
     * @return The beginning and end of the text that should be highlighted.
     */

    public java.util.List getHighlights() {
        return highlights;
    }

    /**
     * 

     * The beginning and end of the text that should be highlighted.
     * 
     * 
     * @param highlights
     *        The beginning and end of the text that should be highlighted.
     */

    public void setHighlights(java.util.Collection highlights) {
        if (highlights == null) {
            this.highlights = null;
            return;
        }

        this.highlights = new java.util.ArrayList(highlights);
    }

    /**
     * 

     * The beginning and end of the text that should be highlighted.
     * 
     * 

     * NOTE: This method appends the values to the existing list (if any). Use
     * {@link #setHighlights(java.util.Collection)} or {@link #withHighlights(java.util.Collection)} if you want to
     * override the existing values.
     * 
     * 
     * @param highlights
     *        The beginning and end of the text that should be highlighted.
     * @return Returns a reference to this object so that method calls can be chained together.
     */

    public TextWithHighlights withHighlights(Highlight... highlights) {
        if (this.highlights == null) {
            setHighlights(new java.util.ArrayList(highlights.length));
        }
        for (Highlight ele : highlights) {
            this.highlights.add(ele);
        }
        return this;
    }

    /**
     * 

     * The beginning and end of the text that should be highlighted.
     * 
     * 
     * @param highlights
     *        The beginning and end of the text that should be highlighted.
     * @return Returns a reference to this object so that method calls can be chained together.
     */

    public TextWithHighlights withHighlights(java.util.Collection highlights) {
        setHighlights(highlights);
        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 (getText() != null)
            sb.append("Text: ").append(getText()).append(",");
        if (getHighlights() != null)
            sb.append("Highlights: ").append(getHighlights());
        sb.append("}");
        return sb.toString();
    }

    @Override
    public boolean equals(Object obj) {
        if (this == obj)
            return true;
        if (obj == null)
            return false;

        if (obj instanceof TextWithHighlights == false)
            return false;
        TextWithHighlights other = (TextWithHighlights) obj;
        if (other.getText() == null ^ this.getText() == null)
            return false;
        if (other.getText() != null && other.getText().equals(this.getText()) == false)
            return false;
        if (other.getHighlights() == null ^ this.getHighlights() == null)
            return false;
        if (other.getHighlights() != null && other.getHighlights().equals(this.getHighlights()) == false)
            return false;
        return true;
    }

    @Override
    public int hashCode() {
        final int prime = 31;
        int hashCode = 1;

        hashCode = prime * hashCode + ((getText() == null) ? 0 : getText().hashCode());
        hashCode = prime * hashCode + ((getHighlights() == null) ? 0 : getHighlights().hashCode());
        return hashCode;
    }

    @Override
    public TextWithHighlights clone() {
        try {
            return (TextWithHighlights) super.clone();
        } catch (CloneNotSupportedException e) {
            throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
        }
    }

    @com.amazonaws.annotation.SdkInternalApi
    @Override
    public void marshall(ProtocolMarshaller protocolMarshaller) {
        com.amazonaws.services.kendra.model.transform.TextWithHighlightsMarshaller.getInstance().marshall(this, protocolMarshaller);
    }
}