com.arangodb.entity.CollectionKeyOption 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

/*
 * Copyright (C) 2012,2013 tamtam180
 *
 * 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.
 */

package com.arangodb.entity;

import java.io.Serializable;

/**
 *
 * additional options for key generation.
 *
 * @author tamtam180 - kirscheless at gmail.com
 *
 */
public class CollectionKeyOption implements Serializable {

  /**
   * specifies the type of the key generator. The currently available generators are traditional and autoincrement.
   */
  String type;

  /**
   * if set to true, then it is allowed to supply own key values in the _key attribute of a document. If set to false,
   * then the key generator will solely be responsible for generating keys and supplying own key values in the _key
   * attribute of documents is considered an error.
   */
  boolean allowUserKeys;

  /**
   * increment value for autoincrement key generator. Not used for other key generator types.
   */
  long increment;

  /**
   * initial offset value for autoincrement key generator. Not used for other key generator types.
   */
  long offset;
  
  public static CollectionKeyOption createIncrementOption(boolean allowUserKeys, long increment, long offset) {
    CollectionKeyOption option = new CollectionKeyOption();
    option.setType("autoincrement");
    option.setAllowUserKeys(allowUserKeys);
    option.setIncrement(increment);
    option.setOffset(offset);
    return option;
  }
  
  public String getType() {
    return type;
  }
  public boolean isAllowUserKeys() {
    return allowUserKeys;
  }
  public long getIncrement() {
    return increment;
  }
  public long getOffset() {
    return offset;
  }
  public void setType(String type) {
    this.type = type;
  }
  public void setAllowUserKeys(boolean allowUserKeys) {
    this.allowUserKeys = allowUserKeys;
  }
  public void setIncrement(long increment) {
    this.increment = increment;
  }
  public void setOffset(long offset) {
    this.offset = offset;
  }
  
}