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

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

/**
 * <p>
 * Provides information that you can use to highlight a search result so that your users can quickly identify terms in
 * the response.
 * </p>
 * 
 * @see <a href="http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/Highlight" target="_top">AWS API
 *      Documentation</a>
 */
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class Highlight implements Serializable, Cloneable, StructuredPojo {

    /**
     * <p>
     * The zero-based location in the response string where the highlight starts.
     * </p>
     */
    private Integer beginOffset;
    /**
     * <p>
     * The zero-based location in the response string where the highlight ends.
     * </p>
     */
    private Integer endOffset;
    /**
     * <p>
     * Indicates whether the response is the best response. True if this is the best response; otherwise, false.
     * </p>
     */
    private Boolean topAnswer;
    /**
     * <p>
     * The highlight type.
     * </p>
     */
    private String type;

    /**
     * <p>
     * The zero-based location in the response string where the highlight starts.
     * </p>
     * 
     * @param beginOffset
     *        The zero-based location in the response string where the highlight starts.
     */

    public void setBeginOffset(Integer beginOffset) {
        this.beginOffset = beginOffset;
    }

    /**
     * <p>
     * The zero-based location in the response string where the highlight starts.
     * </p>
     * 
     * @return The zero-based location in the response string where the highlight starts.
     */

    public Integer getBeginOffset() {
        return this.beginOffset;
    }

    /**
     * <p>
     * The zero-based location in the response string where the highlight starts.
     * </p>
     * 
     * @param beginOffset
     *        The zero-based location in the response string where the highlight starts.
     * @return Returns a reference to this object so that method calls can be chained together.
     */

    public Highlight withBeginOffset(Integer beginOffset) {
        setBeginOffset(beginOffset);
        return this;
    }

    /**
     * <p>
     * The zero-based location in the response string where the highlight ends.
     * </p>
     * 
     * @param endOffset
     *        The zero-based location in the response string where the highlight ends.
     */

    public void setEndOffset(Integer endOffset) {
        this.endOffset = endOffset;
    }

    /**
     * <p>
     * The zero-based location in the response string where the highlight ends.
     * </p>
     * 
     * @return The zero-based location in the response string where the highlight ends.
     */

    public Integer getEndOffset() {
        return this.endOffset;
    }

    /**
     * <p>
     * The zero-based location in the response string where the highlight ends.
     * </p>
     * 
     * @param endOffset
     *        The zero-based location in the response string where the highlight ends.
     * @return Returns a reference to this object so that method calls can be chained together.
     */

    public Highlight withEndOffset(Integer endOffset) {
        setEndOffset(endOffset);
        return this;
    }

    /**
     * <p>
     * Indicates whether the response is the best response. True if this is the best response; otherwise, false.
     * </p>
     * 
     * @param topAnswer
     *        Indicates whether the response is the best response. True if this is the best response; otherwise, false.
     */

    public void setTopAnswer(Boolean topAnswer) {
        this.topAnswer = topAnswer;
    }

    /**
     * <p>
     * Indicates whether the response is the best response. True if this is the best response; otherwise, false.
     * </p>
     * 
     * @return Indicates whether the response is the best response. True if this is the best response; otherwise, false.
     */

    public Boolean getTopAnswer() {
        return this.topAnswer;
    }

    /**
     * <p>
     * Indicates whether the response is the best response. True if this is the best response; otherwise, false.
     * </p>
     * 
     * @param topAnswer
     *        Indicates whether the response is the best response. True if this is the best response; otherwise, false.
     * @return Returns a reference to this object so that method calls can be chained together.
     */

    public Highlight withTopAnswer(Boolean topAnswer) {
        setTopAnswer(topAnswer);
        return this;
    }

    /**
     * <p>
     * Indicates whether the response is the best response. True if this is the best response; otherwise, false.
     * </p>
     * 
     * @return Indicates whether the response is the best response. True if this is the best response; otherwise, false.
     */

    public Boolean isTopAnswer() {
        return this.topAnswer;
    }

    /**
     * <p>
     * The highlight type.
     * </p>
     * 
     * @param type
     *        The highlight type.
     * @see HighlightType
     */

    public void setType(String type) {
        this.type = type;
    }

    /**
     * <p>
     * The highlight type.
     * </p>
     * 
     * @return The highlight type.
     * @see HighlightType
     */

    public String getType() {
        return this.type;
    }

    /**
     * <p>
     * The highlight type.
     * </p>
     * 
     * @param type
     *        The highlight type.
     * @return Returns a reference to this object so that method calls can be chained together.
     * @see HighlightType
     */

    public Highlight withType(String type) {
        setType(type);
        return this;
    }

    /**
     * <p>
     * The highlight type.
     * </p>
     * 
     * @param type
     *        The highlight type.
     * @return Returns a reference to this object so that method calls can be chained together.
     * @see HighlightType
     */

    public Highlight withType(HighlightType type) {
        this.type = type.toString();
        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 (getBeginOffset() != null)
            sb.append("BeginOffset: ").append(getBeginOffset()).append(",");
        if (getEndOffset() != null)
            sb.append("EndOffset: ").append(getEndOffset()).append(",");
        if (getTopAnswer() != null)
            sb.append("TopAnswer: ").append(getTopAnswer()).append(",");
        if (getType() != null)
            sb.append("Type: ").append(getType());
        sb.append("}");
        return sb.toString();
    }

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

        if (obj instanceof Highlight == false)
            return false;
        Highlight other = (Highlight) obj;
        if (other.getBeginOffset() == null ^ this.getBeginOffset() == null)
            return false;
        if (other.getBeginOffset() != null && other.getBeginOffset().equals(this.getBeginOffset()) == false)
            return false;
        if (other.getEndOffset() == null ^ this.getEndOffset() == null)
            return false;
        if (other.getEndOffset() != null && other.getEndOffset().equals(this.getEndOffset()) == false)
            return false;
        if (other.getTopAnswer() == null ^ this.getTopAnswer() == null)
            return false;
        if (other.getTopAnswer() != null && other.getTopAnswer().equals(this.getTopAnswer()) == false)
            return false;
        if (other.getType() == null ^ this.getType() == null)
            return false;
        if (other.getType() != null && other.getType().equals(this.getType()) == false)
            return false;
        return true;
    }

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

        hashCode = prime * hashCode + ((getBeginOffset() == null) ? 0 : getBeginOffset().hashCode());
        hashCode = prime * hashCode + ((getEndOffset() == null) ? 0 : getEndOffset().hashCode());
        hashCode = prime * hashCode + ((getTopAnswer() == null) ? 0 : getTopAnswer().hashCode());
        hashCode = prime * hashCode + ((getType() == null) ? 0 : getType().hashCode());
        return hashCode;
    }

    @Override
    public Highlight clone() {
        try {
            return (Highlight) 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.HighlightMarshaller.getInstance().marshall(this, protocolMarshaller);
    }
}