com.arangodb.model.DocumentUpdateOptions 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;

/**
 * @author Mark Vollmary
 * @author Michele Rastelli
 * @see API
 * Documentation
 */
public class DocumentUpdateOptions {

	private Boolean keepNull;
	private Boolean mergeObjects;
	private Boolean waitForSync;
	private Boolean ignoreRevs;
	private String ifMatch;
	private Boolean returnNew;
	private Boolean returnOld;
	private Boolean serializeNull;
	private Boolean silent;
	private String streamTransactionId;

	public DocumentUpdateOptions() {
		super();
	}

	public Boolean getKeepNull() {
		return keepNull;
	}

	/**
	 * @param keepNull If the intention is to delete existing attributes with the patch command, the URL query parameter
	 *                 keepNull can be used with a value of false. This will modify the behavior of the patch command to
	 *                 remove any attributes from the existing document that are contained in the patch document with an
	 *                 attribute value of null.
	 * @return options
	 */
	public DocumentUpdateOptions keepNull(final Boolean keepNull) {
		this.keepNull = keepNull;
		return this;
	}

	public Boolean getMergeObjects() {
		return mergeObjects;
	}

	/**
	 * @param mergeObjects Controls whether objects (not arrays) will be merged if present in both the existing and the patch
	 *                     document. If set to false, the value in the patch document will overwrite the existing document's
	 *                     value. If set to true, objects will be merged. The default is true.
	 * @return options
	 */
	public DocumentUpdateOptions mergeObjects(final Boolean mergeObjects) {
		this.mergeObjects = mergeObjects;
		return this;
	}

	public Boolean getWaitForSync() {
		return waitForSync;
	}

	/**
	 * @param waitForSync Wait until document has been synced to disk.
	 * @return options
	 */
	public DocumentUpdateOptions waitForSync(final Boolean waitForSync) {
		this.waitForSync = waitForSync;
		return this;
	}

	public Boolean getIgnoreRevs() {
		return ignoreRevs;
	}

	/**
	 * @param ignoreRevs By default, or if this is set to true, the _rev attributes in the given document is ignored. If this
	 *                   is set to false, then the _rev attribute given in the body document is taken as a precondition. The
	 *                   document is only updated if the current revision is the one specified.
	 * @return options
	 */
	public DocumentUpdateOptions ignoreRevs(final Boolean ignoreRevs) {
		this.ignoreRevs = ignoreRevs;
		return this;
	}

	public String getIfMatch() {
		return ifMatch;
	}

	/**
	 * @param ifMatch update a document based on target revision
	 * @return options
	 */
	public DocumentUpdateOptions ifMatch(final String ifMatch) {
		this.ifMatch = ifMatch;
		return this;
	}

	public Boolean getReturnNew() {
		return returnNew;
	}

	/**
	 * @param returnNew Return additionally the complete new document under the attribute new in the result.
	 * @return options
	 */
	public DocumentUpdateOptions returnNew(final Boolean returnNew) {
		this.returnNew = returnNew;
		return this;
	}

	public Boolean getReturnOld() {
		return returnOld;
	}

	/**
	 * @param returnOld Return additionally the complete previous revision of the changed document under the attribute old in
	 *                  the result.
	 * @return options
	 */
	public DocumentUpdateOptions returnOld(final Boolean returnOld) {
		this.returnOld = returnOld;
		return this;
	}

	public Boolean getSerializeNull() {
		return serializeNull;
	}

	/**
	 * @param serializeNull By default, or if this is set to true, all fields of the document which have null values are
	 *                      serialized to VelocyPack otherwise they are excluded from serialization. Use this to update single
	 *                      fields from a stored document.
	 * @return options
	 */
	public DocumentUpdateOptions serializeNull(final Boolean serializeNull) {
		this.serializeNull = serializeNull;
		return this;
	}

	public Boolean getSilent() {
		return silent;
	}

	/**
	 * @param silent If set to true, an empty object will be returned as response. No meta-data will be returned for the
	 *               created document. This option can be used to save some network traffic.
	 * @return options
	 */
	public DocumentUpdateOptions silent(final Boolean silent) {
		this.silent = silent;
		return this;
	}

	public String getStreamTransactionId() {
		return streamTransactionId;
	}

	/**
	 * @param streamTransactionId If set, the operation will be executed within the transaction.
	 * @return options
	 * @since ArangoDB 3.5.0
	 */
	public DocumentUpdateOptions streamTransactionId(final String streamTransactionId) {
		this.streamTransactionId = streamTransactionId;
		return this;
	}

}