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

import java.io.Serializable;

/**
 * <p>
 * Indicates the location of the landmark on the face.
 * </p>
 */
public class Landmark implements Serializable {
    /**
     * <p>
     * Type of landmark.
     * </p>
     * <p>
     * <b>Constraints:</b><br/>
     * <b>Allowed Values: </b>eyeLeft, eyeRight, nose, mouthLeft, mouthRight,
     * leftEyeBrowLeft, leftEyeBrowRight, leftEyeBrowUp, rightEyeBrowLeft,
     * rightEyeBrowRight, rightEyeBrowUp, leftEyeLeft, leftEyeRight, leftEyeUp,
     * leftEyeDown, rightEyeLeft, rightEyeRight, rightEyeUp, rightEyeDown,
     * noseLeft, noseRight, mouthUp, mouthDown, leftPupil, rightPupil,
     * upperJawlineLeft, midJawlineLeft, chinBottom, midJawlineRight,
     * upperJawlineRight
     */
    private String type;

    /**
     * <p>
     * The x-coordinate of the landmark expressed as a ratio of the width of the
     * image. The x-coordinate is measured from the left-side of the image. For
     * example, if the image is 700 pixels wide and the x-coordinate of the
     * landmark is at 350 pixels, this value is 0.5.
     * </p>
     */
    private Float x;

    /**
     * <p>
     * The y-coordinate of the landmark expressed as a ratio of the height of
     * the image. The y-coordinate is measured from the top of the image. For
     * example, if the image height is 200 pixels and the y-coordinate of the
     * landmark is at 50 pixels, this value is 0.25.
     * </p>
     */
    private Float y;

    /**
     * <p>
     * Type of landmark.
     * </p>
     * <p>
     * <b>Constraints:</b><br/>
     * <b>Allowed Values: </b>eyeLeft, eyeRight, nose, mouthLeft, mouthRight,
     * leftEyeBrowLeft, leftEyeBrowRight, leftEyeBrowUp, rightEyeBrowLeft,
     * rightEyeBrowRight, rightEyeBrowUp, leftEyeLeft, leftEyeRight, leftEyeUp,
     * leftEyeDown, rightEyeLeft, rightEyeRight, rightEyeUp, rightEyeDown,
     * noseLeft, noseRight, mouthUp, mouthDown, leftPupil, rightPupil,
     * upperJawlineLeft, midJawlineLeft, chinBottom, midJawlineRight,
     * upperJawlineRight
     *
     * @return <p>
     *         Type of landmark.
     *         </p>
     * @see LandmarkType
     */
    public String getType() {
        return type;
    }

    /**
     * <p>
     * Type of landmark.
     * </p>
     * <p>
     * <b>Constraints:</b><br/>
     * <b>Allowed Values: </b>eyeLeft, eyeRight, nose, mouthLeft, mouthRight,
     * leftEyeBrowLeft, leftEyeBrowRight, leftEyeBrowUp, rightEyeBrowLeft,
     * rightEyeBrowRight, rightEyeBrowUp, leftEyeLeft, leftEyeRight, leftEyeUp,
     * leftEyeDown, rightEyeLeft, rightEyeRight, rightEyeUp, rightEyeDown,
     * noseLeft, noseRight, mouthUp, mouthDown, leftPupil, rightPupil,
     * upperJawlineLeft, midJawlineLeft, chinBottom, midJawlineRight,
     * upperJawlineRight
     *
     * @param type <p>
     *            Type of landmark.
     *            </p>
     * @see LandmarkType
     */
    public void setType(String type) {
        this.type = type;
    }

    /**
     * <p>
     * Type of landmark.
     * </p>
     * <p>
     * Returns a reference to this object so that method calls can be chained
     * together.
     * <p>
     * <b>Constraints:</b><br/>
     * <b>Allowed Values: </b>eyeLeft, eyeRight, nose, mouthLeft, mouthRight,
     * leftEyeBrowLeft, leftEyeBrowRight, leftEyeBrowUp, rightEyeBrowLeft,
     * rightEyeBrowRight, rightEyeBrowUp, leftEyeLeft, leftEyeRight, leftEyeUp,
     * leftEyeDown, rightEyeLeft, rightEyeRight, rightEyeUp, rightEyeDown,
     * noseLeft, noseRight, mouthUp, mouthDown, leftPupil, rightPupil,
     * upperJawlineLeft, midJawlineLeft, chinBottom, midJawlineRight,
     * upperJawlineRight
     *
     * @param type <p>
     *            Type of landmark.
     *            </p>
     * @return A reference to this updated object so that method calls can be
     *         chained together.
     * @see LandmarkType
     */
    public Landmark withType(String type) {
        this.type = type;
        return this;
    }

    /**
     * <p>
     * Type of landmark.
     * </p>
     * <p>
     * <b>Constraints:</b><br/>
     * <b>Allowed Values: </b>eyeLeft, eyeRight, nose, mouthLeft, mouthRight,
     * leftEyeBrowLeft, leftEyeBrowRight, leftEyeBrowUp, rightEyeBrowLeft,
     * rightEyeBrowRight, rightEyeBrowUp, leftEyeLeft, leftEyeRight, leftEyeUp,
     * leftEyeDown, rightEyeLeft, rightEyeRight, rightEyeUp, rightEyeDown,
     * noseLeft, noseRight, mouthUp, mouthDown, leftPupil, rightPupil,
     * upperJawlineLeft, midJawlineLeft, chinBottom, midJawlineRight,
     * upperJawlineRight
     *
     * @param type <p>
     *            Type of landmark.
     *            </p>
     * @see LandmarkType
     */
    public void setType(LandmarkType type) {
        this.type = type.toString();
    }

    /**
     * <p>
     * Type of landmark.
     * </p>
     * <p>
     * Returns a reference to this object so that method calls can be chained
     * together.
     * <p>
     * <b>Constraints:</b><br/>
     * <b>Allowed Values: </b>eyeLeft, eyeRight, nose, mouthLeft, mouthRight,
     * leftEyeBrowLeft, leftEyeBrowRight, leftEyeBrowUp, rightEyeBrowLeft,
     * rightEyeBrowRight, rightEyeBrowUp, leftEyeLeft, leftEyeRight, leftEyeUp,
     * leftEyeDown, rightEyeLeft, rightEyeRight, rightEyeUp, rightEyeDown,
     * noseLeft, noseRight, mouthUp, mouthDown, leftPupil, rightPupil,
     * upperJawlineLeft, midJawlineLeft, chinBottom, midJawlineRight,
     * upperJawlineRight
     *
     * @param type <p>
     *            Type of landmark.
     *            </p>
     * @return A reference to this updated object so that method calls can be
     *         chained together.
     * @see LandmarkType
     */
    public Landmark withType(LandmarkType type) {
        this.type = type.toString();
        return this;
    }

    /**
     * <p>
     * The x-coordinate of the landmark expressed as a ratio of the width of the
     * image. The x-coordinate is measured from the left-side of the image. For
     * example, if the image is 700 pixels wide and the x-coordinate of the
     * landmark is at 350 pixels, this value is 0.5.
     * </p>
     *
     * @return <p>
     *         The x-coordinate of the landmark expressed as a ratio of the
     *         width of the image. The x-coordinate is measured from the
     *         left-side of the image. For example, if the image is 700 pixels
     *         wide and the x-coordinate of the landmark is at 350 pixels, this
     *         value is 0.5.
     *         </p>
     */
    public Float getX() {
        return x;
    }

    /**
     * <p>
     * The x-coordinate of the landmark expressed as a ratio of the width of the
     * image. The x-coordinate is measured from the left-side of the image. For
     * example, if the image is 700 pixels wide and the x-coordinate of the
     * landmark is at 350 pixels, this value is 0.5.
     * </p>
     *
     * @param x <p>
     *            The x-coordinate of the landmark expressed as a ratio of the
     *            width of the image. The x-coordinate is measured from the
     *            left-side of the image. For example, if the image is 700
     *            pixels wide and the x-coordinate of the landmark is at 350
     *            pixels, this value is 0.5.
     *            </p>
     */
    public void setX(Float x) {
        this.x = x;
    }

    /**
     * <p>
     * The x-coordinate of the landmark expressed as a ratio of the width of the
     * image. The x-coordinate is measured from the left-side of the image. For
     * example, if the image is 700 pixels wide and the x-coordinate of the
     * landmark is at 350 pixels, this value is 0.5.
     * </p>
     * <p>
     * Returns a reference to this object so that method calls can be chained
     * together.
     *
     * @param x <p>
     *            The x-coordinate of the landmark expressed as a ratio of the
     *            width of the image. The x-coordinate is measured from the
     *            left-side of the image. For example, if the image is 700
     *            pixels wide and the x-coordinate of the landmark is at 350
     *            pixels, this value is 0.5.
     *            </p>
     * @return A reference to this updated object so that method calls can be
     *         chained together.
     */
    public Landmark withX(Float x) {
        this.x = x;
        return this;
    }

    /**
     * <p>
     * The y-coordinate of the landmark expressed as a ratio of the height of
     * the image. The y-coordinate is measured from the top of the image. For
     * example, if the image height is 200 pixels and the y-coordinate of the
     * landmark is at 50 pixels, this value is 0.25.
     * </p>
     *
     * @return <p>
     *         The y-coordinate of the landmark expressed as a ratio of the
     *         height of the image. The y-coordinate is measured from the top of
     *         the image. For example, if the image height is 200 pixels and the
     *         y-coordinate of the landmark is at 50 pixels, this value is 0.25.
     *         </p>
     */
    public Float getY() {
        return y;
    }

    /**
     * <p>
     * The y-coordinate of the landmark expressed as a ratio of the height of
     * the image. The y-coordinate is measured from the top of the image. For
     * example, if the image height is 200 pixels and the y-coordinate of the
     * landmark is at 50 pixels, this value is 0.25.
     * </p>
     *
     * @param y <p>
     *            The y-coordinate of the landmark expressed as a ratio of the
     *            height of the image. The y-coordinate is measured from the top
     *            of the image. For example, if the image height is 200 pixels
     *            and the y-coordinate of the landmark is at 50 pixels, this
     *            value is 0.25.
     *            </p>
     */
    public void setY(Float y) {
        this.y = y;
    }

    /**
     * <p>
     * The y-coordinate of the landmark expressed as a ratio of the height of
     * the image. The y-coordinate is measured from the top of the image. For
     * example, if the image height is 200 pixels and the y-coordinate of the
     * landmark is at 50 pixels, this value is 0.25.
     * </p>
     * <p>
     * Returns a reference to this object so that method calls can be chained
     * together.
     *
     * @param y <p>
     *            The y-coordinate of the landmark expressed as a ratio of the
     *            height of the image. The y-coordinate is measured from the top
     *            of the image. For example, if the image height is 200 pixels
     *            and the y-coordinate of the landmark is at 50 pixels, this
     *            value is 0.25.
     *            </p>
     * @return A reference to this updated object so that method calls can be
     *         chained together.
     */
    public Landmark withY(Float y) {
        this.y = y;
        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 (getType() != null)
            sb.append("Type: " + getType() + ",");
        if (getX() != null)
            sb.append("X: " + getX() + ",");
        if (getY() != null)
            sb.append("Y: " + getY());
        sb.append("}");
        return sb.toString();
    }

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

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

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

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

        if (other.getType() == null ^ this.getType() == null)
            return false;
        if (other.getType() != null && other.getType().equals(this.getType()) == false)
            return false;
        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;
    }
}