com.amazonaws.services.mediaconvert.model.ImageInserter Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of aws-java-sdk-mediaconvert Show documentation
The AWS Java SDK for AWS Elemental MediaConvert module holds the client classes that are used for communicating with AWS Elemental MediaConvert Service
There is a newer version: 1.12.778
Show newest version
/*
 * Copyright 2013-2018 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.mediaconvert.model;

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

/**
 * Enable the Image inserter (ImageInserter) feature to include a graphic overlay on your video. Enable or disable this
 * feature for each output individually. This setting is disabled by default.
 * 
 * @see AWS API
 *      Documentation
 */
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class ImageInserter implements Serializable, Cloneable, StructuredPojo {

    /** Image to insert. Must be 32 bit windows BMP, PNG, or TGA file. Must not be larger than the output frames. */
    private java.util.List insertableImages;

    /**
     * Image to insert. Must be 32 bit windows BMP, PNG, or TGA file. Must not be larger than the output frames.
     * 
     * @return Image to insert. Must be 32 bit windows BMP, PNG, or TGA file. Must not be larger than the output frames.
     */

    public java.util.List getInsertableImages() {
        return insertableImages;
    }

    /**
     * Image to insert. Must be 32 bit windows BMP, PNG, or TGA file. Must not be larger than the output frames.
     * 
     * @param insertableImages
     *        Image to insert. Must be 32 bit windows BMP, PNG, or TGA file. Must not be larger than the output frames.
     */

    public void setInsertableImages(java.util.Collection insertableImages) {
        if (insertableImages == null) {
            this.insertableImages = null;
            return;
        }

        this.insertableImages = new java.util.ArrayList(insertableImages);
    }

    /**
     * Image to insert. Must be 32 bit windows BMP, PNG, or TGA file. Must not be larger than the output frames.
     * 
     * NOTE: This method appends the values to the existing list (if any). Use
     * {@link #setInsertableImages(java.util.Collection)} or {@link #withInsertableImages(java.util.Collection)} if you
     * want to override the existing values.
     * 
     * 
     * @param insertableImages
     *        Image to insert. Must be 32 bit windows BMP, PNG, or TGA file. Must not be larger than the output frames.
     * @return Returns a reference to this object so that method calls can be chained together.
     */

    public ImageInserter withInsertableImages(InsertableImage... insertableImages) {
        if (this.insertableImages == null) {
            setInsertableImages(new java.util.ArrayList(insertableImages.length));
        }
        for (InsertableImage ele : insertableImages) {
            this.insertableImages.add(ele);
        }
        return this;
    }

    /**
     * Image to insert. Must be 32 bit windows BMP, PNG, or TGA file. Must not be larger than the output frames.
     * 
     * @param insertableImages
     *        Image to insert. Must be 32 bit windows BMP, PNG, or TGA file. Must not be larger than the output frames.
     * @return Returns a reference to this object so that method calls can be chained together.
     */

    public ImageInserter withInsertableImages(java.util.Collection insertableImages) {
        setInsertableImages(insertableImages);
        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 (getInsertableImages() != null)
            sb.append("InsertableImages: ").append(getInsertableImages());
        sb.append("}");
        return sb.toString();
    }

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

        if (obj instanceof ImageInserter == false)
            return false;
        ImageInserter other = (ImageInserter) obj;
        if (other.getInsertableImages() == null ^ this.getInsertableImages() == null)
            return false;
        if (other.getInsertableImages() != null && other.getInsertableImages().equals(this.getInsertableImages()) == false)
            return false;
        return true;
    }

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

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

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