com.arangodb.ArangoEdgeCollectionAsync Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of core Show documentation
Core module for ArangoDB Java Driver
There is a newer version: 7.16.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;

import com.arangodb.entity.EdgeEntity;
import com.arangodb.entity.EdgeUpdateEntity;
import com.arangodb.model.*;

import javax.annotation.concurrent.ThreadSafe;
import java.util.concurrent.CompletableFuture;

/**
 * Asynchronous version of {@link ArangoEdgeCollection}
 */
@ThreadSafe
public interface ArangoEdgeCollectionAsync extends ArangoSerdeAccessor {

    /**
     * The the handler of the named graph the edge collection is within
     *
     * @return graph handler
     */
    ArangoGraphAsync graph();

    /**
     * The name of the edge collection
     *
     * @return collection name
     */
    String name();

    /**
     * Asynchronous version of {@link ArangoEdgeCollection#drop()}
     *
     * @deprecated use {@link #remove()} instead
     */
    @Deprecated
    CompletableFuture drop();

    /**
     * Asynchronous version of {@link ArangoEdgeCollection#drop(EdgeCollectionDropOptions)}
     *
     * @deprecated use {@link #remove(EdgeCollectionRemoveOptions)} instead
     */
    @Deprecated
    CompletableFuture drop(EdgeCollectionDropOptions options);

    /**
     * Asynchronous version of {@link ArangoEdgeCollection#remove()}
     */
    CompletableFuture remove();

    /**
     * Asynchronous version of {@link ArangoEdgeCollection#remove(EdgeCollectionRemoveOptions)}
     */
    CompletableFuture remove(EdgeCollectionRemoveOptions options);

    /**
     * Asynchronous version of {@link ArangoEdgeCollection#insertEdge(Object)}
     */
    CompletableFuture insertEdge(Object value);

    /**
     * Asynchronous version of {@link ArangoEdgeCollection#insertEdge(Object, EdgeCreateOptions)}
     */
    CompletableFuture insertEdge(Object value, EdgeCreateOptions options);

    /**
     * Asynchronous version of {@link ArangoEdgeCollection#getEdge(String, Class)}
     */
     CompletableFuture getEdge(String key, Class type);

    /**
     * Asynchronous version of {@link ArangoEdgeCollection#getEdge(String, Class, GraphDocumentReadOptions)}
     */
     CompletableFuture getEdge(String key, Class type, GraphDocumentReadOptions options);

    /**
     * Asynchronous version of {@link ArangoEdgeCollection#replaceEdge(String, Object)}
     */
    CompletableFuture replaceEdge(String key, Object value);

    /**
     * Asynchronous version of {@link ArangoEdgeCollection#replaceEdge(String, Object, EdgeReplaceOptions)}
     */
    CompletableFuture replaceEdge(String key, Object value, EdgeReplaceOptions options);

    /**
     * Asynchronous version of {@link ArangoEdgeCollection#updateEdge(String, Object)}
     */
    CompletableFuture updateEdge(String key, Object value);

    /**
     * Asynchronous version of {@link ArangoEdgeCollection#updateEdge(String, Object, EdgeUpdateOptions)}
     */
    CompletableFuture updateEdge(String key, Object value, EdgeUpdateOptions options);

    /**
     * Asynchronous version of {@link ArangoEdgeCollection#deleteEdge(String)}
     */
    CompletableFuture deleteEdge(String key);

    /**
     * Asynchronous version of {@link ArangoEdgeCollection#deleteEdge(String, EdgeDeleteOptions)}
     */
    CompletableFuture deleteEdge(String key, EdgeDeleteOptions options);

}