com.basho.riak.client.query.indexes.BinIndex Maven / Gradle / Ivy

Go to download
/*
 * This file is provided to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * 
 * http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License 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.basho.riak.client.query.indexes;

/**
 * @author russell
 * 
 */
public class BinIndex extends RiakIndex {

    private static final String SUFFIX = "_bin";

    protected BinIndex(String name) {
        super(name);
    }

    /**
     * Factory method, create a new IntIndex
     * 
     * @param name
     *            the index name (**WITHOUT** any Riak specific suffix! e.g. use
     *            "email" not "email_bin")
     * @return an BinIndex named name
     */
    public static BinIndex named(String name) {
        return new BinIndex(name);
    }

    /*
     * (non-Javadoc)
     * 
     * @see com.basho.riak.client.query.indexes.RiakIndex#getSuffix()
     */
    @Override protected String getSuffix() {
        return SUFFIX;
    }
}