com.spikeify.commands.SingleKeyDeleter Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of core Show documentation
Simple ORM for Aerospike
There is a newer version: 0.2.35
package com.spikeify.commands;

import com.aerospike.client.Key;
import com.aerospike.client.async.IAsyncClient;
import com.spikeify.RecordsCache;
import com.spikeify.Spikeify;
import com.spikeify.SpikeifyError;
import com.spikeify.annotations.Namespace;
import com.spikeify.annotations.SetName;

/**
 * A command chain for deleting object from database.
 * This class is not intended to be instantiated by user.
 *
 * @param 
 */
@SuppressWarnings("WeakerAccess")
public class SingleKeyDeleter {

	/**
	 * Used internally to create a command chain. Not intended to be used by the user directly.
	 * Use {@link Spikeify#delete(Key)}  instead.
	 */
	public SingleKeyDeleter(IAsyncClient asynClient,
	                        RecordsCache recordsCache,
	                        String defaultNamespace,
	                        Key key) {

		this.asynClient = asynClient;
		this.recordsCache = recordsCache;
		this.namespace = defaultNamespace;
		this.key = key;
	}

	/**
	 * Used internally to create a command chain. Not intended to be used by the user directly.
	 * Use {@link Spikeify#delete(Long)}  instead.
	 */
	public SingleKeyDeleter(IAsyncClient asynClient,
	                        RecordsCache recordsCache,
	                        String defaultNamespace,
	                        Long userKey) {

		this.asynClient = asynClient;
		this.recordsCache = recordsCache;
		this.namespace = defaultNamespace;
		this.longKey = userKey;
	}

	/**
	 * Used internally to create a command chain. Not intended to be used by the user directly.
	 * Use {@link Spikeify#delete(String)}  instead.
	 */
	public SingleKeyDeleter(IAsyncClient asynClient,
	                        RecordsCache recordsCache,
	                        String defaultNamespace,
	                        String userKey) {

		this.asynClient = asynClient;
		this.recordsCache = recordsCache;
		this.namespace = defaultNamespace;
		this.stringKey = userKey;
	}

	private Key key;
	private Long longKey;
	private String stringKey;
	protected String namespace;
	protected String setName;
	protected final IAsyncClient asynClient;
	private final RecordsCache recordsCache;

	/**
	 * Sets the Namespace. Overrides the default namespace and the namespace defined on the Class via {@link Namespace} annotation.
	 *
	 * @param namespace The namespace.
	 */
	public SingleKeyDeleter namespace(String namespace) {
		this.namespace = namespace;
		return this;
	}

	/**
	 * Sets the SetName. Overrides any SetName defined on the Class via {@link SetName} annotation.
	 *
	 * @param setName The name of the set.
	 */
	public SingleKeyDeleter setName(String setName) {
		this.setName = setName;
		return this;
	}

	protected void collectKeys() {

		// check if any Long or String keys were provided
		if (stringKey != null) {
			key = new Key(getNamespace(), getSetName(), stringKey);
		} else if (longKey != null) {
			key = new Key(getNamespace(), getSetName(), longKey);
		}
	}

	protected String getNamespace() {
		if (namespace == null) {
			throw new SpikeifyError("Namespace not set.");
		}
		return namespace;
	}

	protected String getSetName() {
		return setName != null ? setName : null; //mapper.getSetName();
	}


	/**
	 * Synchronously executes the delete command.
	 *
	 * @return whether record existed on server before deletion
	 */
	@SuppressWarnings("UnusedReturnValue")
	public boolean now() {

		collectKeys();

		recordsCache.remove(key);
		return asynClient.delete(null, key);
	}

}