com.arangodb.model.HashIndexOptions Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of arangodb-java-driver Show documentation

ArangoDB Java Driver

There is a newer version: 7.15.0

/*
 * DISCLAIMER
 *
 * Copyright 2016 ArangoDB GmbH, Cologne, Germany
 *
 * Licensed 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.
 *
 * Copyright holder is ArangoDB GmbH, Cologne, Germany
 */

package com.arangodb.model;

import com.arangodb.entity.IndexType;

/**
 * @author Mark Vollmary
 *
 * @see API Documentation
 */
public class HashIndexOptions extends IndexOptions {

	private Iterable fields;
	private final IndexType type = IndexType.hash;
	private Boolean unique;
	private Boolean sparse;
	private Boolean deduplicate;

	public HashIndexOptions() {
		super();
	}

	protected Iterable getFields() {
		return fields;
	}

	/**
	 * @param fields
	 *            A list of attribute paths
	 * @return options
	 */
	protected HashIndexOptions fields(final Iterable fields) {
		this.fields = fields;
		return this;
	}

	protected IndexType getType() {
		return type;
	}

	public Boolean getUnique() {
		return unique;
	}

	/**
	 * @param unique
	 *            if true, then create a unique index
	 * @return options
	 */
	public HashIndexOptions unique(final Boolean unique) {
		this.unique = unique;
		return this;
	}

	public Boolean getSparse() {
		return sparse;
	}

	/**
	 * @param sparse
	 *            if true, then create a sparse index
	 * @return options
	 */
	public HashIndexOptions sparse(final Boolean sparse) {
		this.sparse = sparse;
		return this;
	}

	public Boolean getDeduplicate() {
		return deduplicate;
	}

	/**
	 * @param deduplicate
	 *            if false, the deduplication of array values is turned off.
	 * @return options
	 */
	public HashIndexOptions deduplicate(final Boolean deduplicate) {
		this.deduplicate = deduplicate;
		return this;
	}
}