CompareFacesMatch.java

/*
 * Copyright 2012-2017 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;
import javax.annotation.Generated;
import com.amazonaws.protocol.StructuredPojo;
import com.amazonaws.protocol.ProtocolMarshaller;

/**
 * <p>
 * For the provided the bounding box, confidence level that the bounding box actually contains a face, and the
 * similarity between the face in the bounding box and the face in the source image.
 * </p>
 */
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class CompareFacesMatch implements Serializable, Cloneable, StructuredPojo {

    /**
     * <p>
     * Level of confidence that the faces match.
     * </p>
     */
    private Float similarity;
    /**
     * <p>
     * Provides face metadata (bounding box and confidence that the bounding box actually contains a face).
     * </p>
     */
    private ComparedFace face;

    /**
     * <p>
     * Level of confidence that the faces match.
     * </p>
     * 
     * @param similarity
     *        Level of confidence that the faces match.
     */

    public void setSimilarity(Float similarity) {
        this.similarity = similarity;
    }

    /**
     * <p>
     * Level of confidence that the faces match.
     * </p>
     * 
     * @return Level of confidence that the faces match.
     */

    public Float getSimilarity() {
        return this.similarity;
    }

    /**
     * <p>
     * Level of confidence that the faces match.
     * </p>
     * 
     * @param similarity
     *        Level of confidence that the faces match.
     * @return Returns a reference to this object so that method calls can be chained together.
     */

    public CompareFacesMatch withSimilarity(Float similarity) {
        setSimilarity(similarity);
        return this;
    }

    /**
     * <p>
     * Provides face metadata (bounding box and confidence that the bounding box actually contains a face).
     * </p>
     * 
     * @param face
     *        Provides face metadata (bounding box and confidence that the bounding box actually contains a face).
     */

    public void setFace(ComparedFace face) {
        this.face = face;
    }

    /**
     * <p>
     * Provides face metadata (bounding box and confidence that the bounding box actually contains a face).
     * </p>
     * 
     * @return Provides face metadata (bounding box and confidence that the bounding box actually contains a face).
     */

    public ComparedFace getFace() {
        return this.face;
    }

    /**
     * <p>
     * Provides face metadata (bounding box and confidence that the bounding box actually contains a face).
     * </p>
     * 
     * @param face
     *        Provides face metadata (bounding box and confidence that the bounding box actually contains a face).
     * @return Returns a reference to this object so that method calls can be chained together.
     */

    public CompareFacesMatch withFace(ComparedFace face) {
        setFace(face);
        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 (getSimilarity() != null)
            sb.append("Similarity: ").append(getSimilarity()).append(",");
        if (getFace() != null)
            sb.append("Face: ").append(getFace());
        sb.append("}");
        return sb.toString();
    }

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

        if (obj instanceof CompareFacesMatch == false)
            return false;
        CompareFacesMatch other = (CompareFacesMatch) obj;
        if (other.getSimilarity() == null ^ this.getSimilarity() == null)
            return false;
        if (other.getSimilarity() != null && other.getSimilarity().equals(this.getSimilarity()) == false)
            return false;
        if (other.getFace() == null ^ this.getFace() == null)
            return false;
        if (other.getFace() != null && other.getFace().equals(this.getFace()) == false)
            return false;
        return true;
    }

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

        hashCode = prime * hashCode + ((getSimilarity() == null) ? 0 : getSimilarity().hashCode());
        hashCode = prime * hashCode + ((getFace() == null) ? 0 : getFace().hashCode());
        return hashCode;
    }

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