• Home
• com.emc.vipr
• aws-java-sdk
• 1.7.5
• source code
• LiteralOptions.java

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

com.amazonaws.services.cloudsearch.model.LiteralOptions Maven / Gradle / Ivy

/*
 * Copyright 2010-2014 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.cloudsearch.model;

import java.io.Serializable;

/**
 * 

 * Options that define a literal field in the search index.
 * 
 * @deprecated Use {@link com.amazonaws.services.cloudsearchv2.model.LiteralOptions} instead.
 */
@Deprecated
public class LiteralOptions implements Serializable {

    /**
     * The default value for a literal field. Optional.
     * 

     * Constraints:

     * Length: 0 - 1024

     */
    private String defaultValue;

    /**
     * Specifies whether search is enabled for this field. Default: False.
     */
    private Boolean searchEnabled;

    /**
     * Specifies whether facets are enabled for this field. Default: False.
     */
    private Boolean facetEnabled;

    /**
     * Specifies whether values of this field can be returned in search
     * results and used for ranking. Default: False.
     */
    private Boolean resultEnabled;

    /**
     * The default value for a literal field. Optional.
     * 

     * Constraints:

     * Length: 0 - 1024

     *
     * @return The default value for a literal field. Optional.
     */
    public String getDefaultValue() {
        return defaultValue;
    }
    
    /**
     * The default value for a literal field. Optional.
     * 

     * Constraints:

     * Length: 0 - 1024

     *
     * @param defaultValue The default value for a literal field. Optional.
     */
    public void setDefaultValue(String defaultValue) {
        this.defaultValue = defaultValue;
    }
    
    /**
     * The default value for a literal field. Optional.
     * 

     * Returns a reference to this object so that method calls can be chained together.
     * 

     * Constraints:

     * Length: 0 - 1024

     *
     * @param defaultValue The default value for a literal field. Optional.
     *
     * @return A reference to this updated object so that method calls can be chained 
     *         together.
     */
    public LiteralOptions withDefaultValue(String defaultValue) {
        this.defaultValue = defaultValue;
        return this;
    }

    /**
     * Specifies whether search is enabled for this field. Default: False.
     *
     * @return Specifies whether search is enabled for this field. Default: False.
     */
    public Boolean isSearchEnabled() {
        return searchEnabled;
    }
    
    /**
     * Specifies whether search is enabled for this field. Default: False.
     *
     * @param searchEnabled Specifies whether search is enabled for this field. Default: False.
     */
    public void setSearchEnabled(Boolean searchEnabled) {
        this.searchEnabled = searchEnabled;
    }
    
    /**
     * Specifies whether search is enabled for this field. Default: False.
     * 

     * Returns a reference to this object so that method calls can be chained together.
     *
     * @param searchEnabled Specifies whether search is enabled for this field. Default: False.
     *
     * @return A reference to this updated object so that method calls can be chained 
     *         together.
     */
    public LiteralOptions withSearchEnabled(Boolean searchEnabled) {
        this.searchEnabled = searchEnabled;
        return this;
    }

    /**
     * Specifies whether search is enabled for this field. Default: False.
     *
     * @return Specifies whether search is enabled for this field. Default: False.
     */
    public Boolean getSearchEnabled() {
        return searchEnabled;
    }

    /**
     * Specifies whether facets are enabled for this field. Default: False.
     *
     * @return Specifies whether facets are enabled for this field. Default: False.
     */
    public Boolean isFacetEnabled() {
        return facetEnabled;
    }
    
    /**
     * Specifies whether facets are enabled for this field. Default: False.
     *
     * @param facetEnabled Specifies whether facets are enabled for this field. Default: False.
     */
    public void setFacetEnabled(Boolean facetEnabled) {
        this.facetEnabled = facetEnabled;
    }
    
    /**
     * Specifies whether facets are enabled for this field. Default: False.
     * 

     * Returns a reference to this object so that method calls can be chained together.
     *
     * @param facetEnabled Specifies whether facets are enabled for this field. Default: False.
     *
     * @return A reference to this updated object so that method calls can be chained 
     *         together.
     */
    public LiteralOptions withFacetEnabled(Boolean facetEnabled) {
        this.facetEnabled = facetEnabled;
        return this;
    }

    /**
     * Specifies whether facets are enabled for this field. Default: False.
     *
     * @return Specifies whether facets are enabled for this field. Default: False.
     */
    public Boolean getFacetEnabled() {
        return facetEnabled;
    }

    /**
     * Specifies whether values of this field can be returned in search
     * results and used for ranking. Default: False.
     *
     * @return Specifies whether values of this field can be returned in search
     *         results and used for ranking. Default: False.
     */
    public Boolean isResultEnabled() {
        return resultEnabled;
    }
    
    /**
     * Specifies whether values of this field can be returned in search
     * results and used for ranking. Default: False.
     *
     * @param resultEnabled Specifies whether values of this field can be returned in search
     *         results and used for ranking. Default: False.
     */
    public void setResultEnabled(Boolean resultEnabled) {
        this.resultEnabled = resultEnabled;
    }
    
    /**
     * Specifies whether values of this field can be returned in search
     * results and used for ranking. Default: False.
     * 

     * Returns a reference to this object so that method calls can be chained together.
     *
     * @param resultEnabled Specifies whether values of this field can be returned in search
     *         results and used for ranking. Default: False.
     *
     * @return A reference to this updated object so that method calls can be chained 
     *         together.
     */
    public LiteralOptions withResultEnabled(Boolean resultEnabled) {
        this.resultEnabled = resultEnabled;
        return this;
    }

    /**
     * Specifies whether values of this field can be returned in search
     * results and used for ranking. Default: False.
     *
     * @return Specifies whether values of this field can be returned in search
     *         results and used for ranking. Default: False.
     */
    public Boolean getResultEnabled() {
        return resultEnabled;
    }

    /**
     * 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 (getDefaultValue() != null) sb.append("DefaultValue: " + getDefaultValue() + ",");
        if (isSearchEnabled() != null) sb.append("SearchEnabled: " + isSearchEnabled() + ",");
        if (isFacetEnabled() != null) sb.append("FacetEnabled: " + isFacetEnabled() + ",");
        if (isResultEnabled() != null) sb.append("ResultEnabled: " + isResultEnabled() );
        sb.append("}");
        return sb.toString();
    }
    
    @Override
    public int hashCode() {
        final int prime = 31;
        int hashCode = 1;
        
        hashCode = prime * hashCode + ((getDefaultValue() == null) ? 0 : getDefaultValue().hashCode()); 
        hashCode = prime * hashCode + ((isSearchEnabled() == null) ? 0 : isSearchEnabled().hashCode()); 
        hashCode = prime * hashCode + ((isFacetEnabled() == null) ? 0 : isFacetEnabled().hashCode()); 
        hashCode = prime * hashCode + ((isResultEnabled() == null) ? 0 : isResultEnabled().hashCode()); 
        return hashCode;
    }
    
    @Override
    public boolean equals(Object obj) {
        if (this == obj) return true;
        if (obj == null) return false;

        if (obj instanceof LiteralOptions == false) return false;
        LiteralOptions other = (LiteralOptions)obj;
        
        if (other.getDefaultValue() == null ^ this.getDefaultValue() == null) return false;
        if (other.getDefaultValue() != null && other.getDefaultValue().equals(this.getDefaultValue()) == false) return false; 
        if (other.isSearchEnabled() == null ^ this.isSearchEnabled() == null) return false;
        if (other.isSearchEnabled() != null && other.isSearchEnabled().equals(this.isSearchEnabled()) == false) return false; 
        if (other.isFacetEnabled() == null ^ this.isFacetEnabled() == null) return false;
        if (other.isFacetEnabled() != null && other.isFacetEnabled().equals(this.isFacetEnabled()) == false) return false; 
        if (other.isResultEnabled() == null ^ this.isResultEnabled() == null) return false;
        if (other.isResultEnabled() != null && other.isResultEnabled().equals(this.isResultEnabled()) == false) return false; 
        return true;
    }
    
}