com.amazonaws.services.textract.model.Point Maven / Gradle / Ivy

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

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

/**
 * 
 * The X and Y coordinates of a point on a document page. The X and Y values that are returned are ratios of the overall
 * document page size. For example, if the input document is 700 x 200 and the operation returns X=0.5 and Y=0.25, then
 * the point is at the (350,50) pixel coordinate on the document page.
 * 
 * 
 * An array of Point objects, Polygon, is returned by DetectDocumentText.
 * Polygon represents a fine-grained polygon around detected text. For more information, see Geometry in
 * the Amazon Textract Developer Guide.
 * 
 * 
 * @see AWS API
 *      Documentation
 */
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class Point implements Serializable, Cloneable, StructuredPojo {

    /**
     * 
     * The value of the X coordinate for a point on a Polygon.
     * 
     */
    private Float x;
    /**
     * 
     * The value of the Y coordinate for a point on a Polygon.
     * 
     */
    private Float y;

    /**
     * 
     * The value of the X coordinate for a point on a Polygon.
     * 
     * 
     * @param x
     *        The value of the X coordinate for a point on a Polygon.
     */

    public void setX(Float x) {
        this.x = x;
    }

    /**
     * 
     * The value of the X coordinate for a point on a Polygon.
     * 
     * 
     * @return The value of the X coordinate for a point on a Polygon.
     */

    public Float getX() {
        return this.x;
    }

    /**
     * 
     * The value of the X coordinate for a point on a Polygon.
     * 
     * 
     * @param x
     *        The value of the X coordinate for a point on a Polygon.
     * @return Returns a reference to this object so that method calls can be chained together.
     */

    public Point withX(Float x) {
        setX(x);
        return this;
    }

    /**
     * 
     * The value of the Y coordinate for a point on a Polygon.
     * 
     * 
     * @param y
     *        The value of the Y coordinate for a point on a Polygon.
     */

    public void setY(Float y) {
        this.y = y;
    }

    /**
     * 
     * The value of the Y coordinate for a point on a Polygon.
     * 
     * 
     * @return The value of the Y coordinate for a point on a Polygon.
     */

    public Float getY() {
        return this.y;
    }

    /**
     * 
     * The value of the Y coordinate for a point on a Polygon.
     * 
     * 
     * @param y
     *        The value of the Y coordinate for a point on a Polygon.
     * @return Returns a reference to this object so that method calls can be chained together.
     */

    public Point withY(Float y) {
        setY(y);
        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 (getX() != null)
            sb.append("X: ").append(getX()).append(",");
        if (getY() != null)
            sb.append("Y: ").append(getY());
        sb.append("}");
        return sb.toString();
    }

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

        if (obj instanceof Point == false)
            return false;
        Point other = (Point) obj;
        if (other.getX() == null ^ this.getX() == null)
            return false;
        if (other.getX() != null && other.getX().equals(this.getX()) == false)
            return false;
        if (other.getY() == null ^ this.getY() == null)
            return false;
        if (other.getY() != null && other.getY().equals(this.getY()) == false)
            return false;
        return true;
    }

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

        hashCode = prime * hashCode + ((getX() == null) ? 0 : getX().hashCode());
        hashCode = prime * hashCode + ((getY() == null) ? 0 : getY().hashCode());
        return hashCode;
    }

    @Override
    public Point clone() {
        try {
            return (Point) 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.textract.model.transform.PointMarshaller.getInstance().marshall(this, protocolMarshaller);
    }
}