/*
 * Copyright 2010-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;

/**
 * <p>
 * Specifies the class that categorizes the document being analyzed
 * </p>
 */
public class DocumentClass implements Serializable {
    /**
     * <p>
     * The name of the class.
     * </p>
     * <p>
     * <b>Constraints:</b><br/>
     * <b>Length: </b>1 - <br/>
     */
    private String name;

    /**
     * <p>
     * The confidence score that Amazon Comprehend has this class correctly
     * attributed.
     * </p>
     */
    private Float score;

    /**
     * <p>
     * Page number in the input document. This field is present in the response
     * only if your request includes the <code>Byte</code> parameter.
     * </p>
     */
    private Integer page;

    /**
     * <p>
     * The name of the class.
     * </p>
     * <p>
     * <b>Constraints:</b><br/>
     * <b>Length: </b>1 - <br/>
     *
     * @return <p>
     *         The name of the class.
     *         </p>
     */
    public String getName() {
        return name;
    }

    /**
     * <p>
     * The name of the class.
     * </p>
     * <p>
     * <b>Constraints:</b><br/>
     * <b>Length: </b>1 - <br/>
     *
     * @param name <p>
     *            The name of the class.
     *            </p>
     */
    public void setName(String name) {
        this.name = name;
    }

    /**
     * <p>
     * The name of the class.
     * </p>
     * <p>
     * Returns a reference to this object so that method calls can be chained
     * together.
     * <p>
     * <b>Constraints:</b><br/>
     * <b>Length: </b>1 - <br/>
     *
     * @param name <p>
     *            The name of the class.
     *            </p>
     * @return A reference to this updated object so that method calls can be
     *         chained together.
     */
    public DocumentClass withName(String name) {
        this.name = name;
        return this;
    }

    /**
     * <p>
     * The confidence score that Amazon Comprehend has this class correctly
     * attributed.
     * </p>
     *
     * @return <p>
     *         The confidence score that Amazon Comprehend has this class
     *         correctly attributed.
     *         </p>
     */
    public Float getScore() {
        return score;
    }

    /**
     * <p>
     * The confidence score that Amazon Comprehend has this class correctly
     * attributed.
     * </p>
     *
     * @param score <p>
     *            The confidence score that Amazon Comprehend has this class
     *            correctly attributed.
     *            </p>
     */
    public void setScore(Float score) {
        this.score = score;
    }

    /**
     * <p>
     * The confidence score that Amazon Comprehend has this class correctly
     * attributed.
     * </p>
     * <p>
     * Returns a reference to this object so that method calls can be chained
     * together.
     *
     * @param score <p>
     *            The confidence score that Amazon Comprehend has this class
     *            correctly attributed.
     *            </p>
     * @return A reference to this updated object so that method calls can be
     *         chained together.
     */
    public DocumentClass withScore(Float score) {
        this.score = score;
        return this;
    }

    /**
     * <p>
     * Page number in the input document. This field is present in the response
     * only if your request includes the <code>Byte</code> parameter.
     * </p>
     *
     * @return <p>
     *         Page number in the input document. This field is present in the
     *         response only if your request includes the <code>Byte</code>
     *         parameter.
     *         </p>
     */
    public Integer getPage() {
        return page;
    }

    /**
     * <p>
     * Page number in the input document. This field is present in the response
     * only if your request includes the <code>Byte</code> parameter.
     * </p>
     *
     * @param page <p>
     *            Page number in the input document. This field is present in
     *            the response only if your request includes the
     *            <code>Byte</code> parameter.
     *            </p>
     */
    public void setPage(Integer page) {
        this.page = page;
    }

    /**
     * <p>
     * Page number in the input document. This field is present in the response
     * only if your request includes the <code>Byte</code> parameter.
     * </p>
     * <p>
     * Returns a reference to this object so that method calls can be chained
     * together.
     *
     * @param page <p>
     *            Page number in the input document. This field is present in
     *            the response only if your request includes the
     *            <code>Byte</code> parameter.
     *            </p>
     * @return A reference to this updated object so that method calls can be
     *         chained together.
     */
    public DocumentClass withPage(Integer page) {
        this.page = page;
        return this;
    }

    /**
     * Returns a string representation of this object; useful for testing and
     * debugging.
     *
     * @return A string representation of this object.
     * @see java.lang.Object#toString()
     */
    @Override
    public String toString() {
        StringBuilder sb = new StringBuilder();
        sb.append("{");
        if (getName() != null)
            sb.append("Name: " + getName() + ",");
        if (getScore() != null)
            sb.append("Score: " + getScore() + ",");
        if (getPage() != null)
            sb.append("Page: " + getPage());
        sb.append("}");
        return sb.toString();
    }

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

        hashCode = prime * hashCode + ((getName() == null) ? 0 : getName().hashCode());
        hashCode = prime * hashCode + ((getScore() == null) ? 0 : getScore().hashCode());
        hashCode = prime * hashCode + ((getPage() == null) ? 0 : getPage().hashCode());
        return hashCode;
    }

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

        if (obj instanceof DocumentClass == false)
            return false;
        DocumentClass other = (DocumentClass) obj;

        if (other.getName() == null ^ this.getName() == null)
            return false;
        if (other.getName() != null && other.getName().equals(this.getName()) == false)
            return false;
        if (other.getScore() == null ^ this.getScore() == null)
            return false;
        if (other.getScore() != null && other.getScore().equals(this.getScore()) == false)
            return false;
        if (other.getPage() == null ^ this.getPage() == null)
            return false;
        if (other.getPage() != null && other.getPage().equals(this.getPage()) == false)
            return false;
        return true;
    }
}