com.amazonaws.services.cloudsearchv2.model.IndexDocumentsResult Maven / Gradle / Ivy

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

import java.io.Serializable;

/**
 * 
 * The result of an IndexDocuments request. Contains the status of
 * the indexing operation, including the fields being indexed.
 * 
 */
public class IndexDocumentsResult implements Serializable, Cloneable {

    /**
     * 
     * The names of the fields that are currently being indexed.
     * 
     */
    private com.amazonaws.internal.SdkInternalList fieldNames;

    /**
     * 
     * The names of the fields that are currently being indexed.
     * 
     * 
     * @return The names of the fields that are currently being indexed.
     */

    public java.util.List getFieldNames() {
        if (fieldNames == null) {
            fieldNames = new com.amazonaws.internal.SdkInternalList();
        }
        return fieldNames;
    }

    /**
     * 
     * The names of the fields that are currently being indexed.
     * 
     * 
     * @param fieldNames
     *        The names of the fields that are currently being indexed.
     */

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

        this.fieldNames = new com.amazonaws.internal.SdkInternalList(
                fieldNames);
    }

    /**
     * 
     * The names of the fields that are currently being indexed.
     * 
     * 
     * NOTE: This method appends the values to the existing list (if
     * any). Use {@link #setFieldNames(java.util.Collection)} or
     * {@link #withFieldNames(java.util.Collection)} if you want to override the
     * existing values.
     * 
     * 
     * @param fieldNames
     *        The names of the fields that are currently being indexed.
     * @return Returns a reference to this object so that method calls can be
     *         chained together.
     */

    public IndexDocumentsResult withFieldNames(String... fieldNames) {
        if (this.fieldNames == null) {
            setFieldNames(new com.amazonaws.internal.SdkInternalList(
                    fieldNames.length));
        }
        for (String ele : fieldNames) {
            this.fieldNames.add(ele);
        }
        return this;
    }

    /**
     * 
     * The names of the fields that are currently being indexed.
     * 
     * 
     * @param fieldNames
     *        The names of the fields that are currently being indexed.
     * @return Returns a reference to this object so that method calls can be
     *         chained together.
     */

    public IndexDocumentsResult withFieldNames(
            java.util.Collection fieldNames) {
        setFieldNames(fieldNames);
        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 (getFieldNames() != null)
            sb.append("FieldNames: " + getFieldNames());
        sb.append("}");
        return sb.toString();
    }

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

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

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

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

    @Override
    public IndexDocumentsResult clone() {
        try {
            return (IndexDocumentsResult) super.clone();
        } catch (CloneNotSupportedException e) {
            throw new IllegalStateException(
                    "Got a CloneNotSupportedException from Object.clone() "
                            + "even though we're Cloneable!", e);
        }
    }
}