CelebrityRecognition.java

/*
 * Copyright 2010-2024 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>
 * Information about a detected celebrity and the time the celebrity was
 * detected in a stored video. For more information, see GetCelebrityRecognition
 * in the Amazon Rekognition Developer Guide.
 * </p>
 */
public class CelebrityRecognition implements Serializable {
    /**
     * <p>
     * The time, in milliseconds from the start of the video, that the celebrity
     * was recognized. Note that <code>Timestamp</code> is not guaranteed to be
     * accurate to the individual frame where the celebrity first appears.
     * </p>
     */
    private Long timestamp;

    /**
     * <p>
     * Information about a recognized celebrity.
     * </p>
     */
    private CelebrityDetail celebrity;

    /**
     * <p>
     * The time, in milliseconds from the start of the video, that the celebrity
     * was recognized. Note that <code>Timestamp</code> is not guaranteed to be
     * accurate to the individual frame where the celebrity first appears.
     * </p>
     *
     * @return <p>
     *         The time, in milliseconds from the start of the video, that the
     *         celebrity was recognized. Note that <code>Timestamp</code> is not
     *         guaranteed to be accurate to the individual frame where the
     *         celebrity first appears.
     *         </p>
     */
    public Long getTimestamp() {
        return timestamp;
    }

    /**
     * <p>
     * The time, in milliseconds from the start of the video, that the celebrity
     * was recognized. Note that <code>Timestamp</code> is not guaranteed to be
     * accurate to the individual frame where the celebrity first appears.
     * </p>
     *
     * @param timestamp <p>
     *            The time, in milliseconds from the start of the video, that
     *            the celebrity was recognized. Note that <code>Timestamp</code>
     *            is not guaranteed to be accurate to the individual frame where
     *            the celebrity first appears.
     *            </p>
     */
    public void setTimestamp(Long timestamp) {
        this.timestamp = timestamp;
    }

    /**
     * <p>
     * The time, in milliseconds from the start of the video, that the celebrity
     * was recognized. Note that <code>Timestamp</code> is not guaranteed to be
     * accurate to the individual frame where the celebrity first appears.
     * </p>
     * <p>
     * Returns a reference to this object so that method calls can be chained
     * together.
     *
     * @param timestamp <p>
     *            The time, in milliseconds from the start of the video, that
     *            the celebrity was recognized. Note that <code>Timestamp</code>
     *            is not guaranteed to be accurate to the individual frame where
     *            the celebrity first appears.
     *            </p>
     * @return A reference to this updated object so that method calls can be
     *         chained together.
     */
    public CelebrityRecognition withTimestamp(Long timestamp) {
        this.timestamp = timestamp;
        return this;
    }

    /**
     * <p>
     * Information about a recognized celebrity.
     * </p>
     *
     * @return <p>
     *         Information about a recognized celebrity.
     *         </p>
     */
    public CelebrityDetail getCelebrity() {
        return celebrity;
    }

    /**
     * <p>
     * Information about a recognized celebrity.
     * </p>
     *
     * @param celebrity <p>
     *            Information about a recognized celebrity.
     *            </p>
     */
    public void setCelebrity(CelebrityDetail celebrity) {
        this.celebrity = celebrity;
    }

    /**
     * <p>
     * Information about a recognized celebrity.
     * </p>
     * <p>
     * Returns a reference to this object so that method calls can be chained
     * together.
     *
     * @param celebrity <p>
     *            Information about a recognized celebrity.
     *            </p>
     * @return A reference to this updated object so that method calls can be
     *         chained together.
     */
    public CelebrityRecognition withCelebrity(CelebrityDetail celebrity) {
        this.celebrity = celebrity;
        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 (getTimestamp() != null)
            sb.append("Timestamp: " + getTimestamp() + ",");
        if (getCelebrity() != null)
            sb.append("Celebrity: " + getCelebrity());
        sb.append("}");
        return sb.toString();
    }

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

        hashCode = prime * hashCode + ((getTimestamp() == null) ? 0 : getTimestamp().hashCode());
        hashCode = prime * hashCode + ((getCelebrity() == null) ? 0 : getCelebrity().hashCode());
        return hashCode;
    }

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

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

        if (other.getTimestamp() == null ^ this.getTimestamp() == null)
            return false;
        if (other.getTimestamp() != null
                && other.getTimestamp().equals(this.getTimestamp()) == false)
            return false;
        if (other.getCelebrity() == null ^ this.getCelebrity() == null)
            return false;
        if (other.getCelebrity() != null
                && other.getCelebrity().equals(this.getCelebrity()) == false)
            return false;
        return true;
    }
}