com.arangodb.async.ArangoEdgeCollectionAsync Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of arangodb-java-driver-shaded Show documentation
ArangoDB Java Driver Shaded
There is a newer version: 7.13.0
Show newest version
/*
 * 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.async;

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

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

/**
 * Interface for operations on ArangoDB edge collection level.
 *
 * @author Mark Vollmary
 * @see API Documentation
 */
@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();

    /**
     * Creates a new edge in the collection
     *
     * @param value A representation of a single edge (POJO or {@link com.arangodb.util.RawData}
     * @return information about the edge
     * @see API Documentation
     */
    CompletableFuture insertEdge(final Object value);

    /**
     * Creates a new edge in the collection
     *
     * @param value   A representation of a single edge (POJO or {@link com.arangodb.util.RawData}
     * @param options Additional options, can be null
     * @return information about the edge
     * @see API Documentation
     */
    CompletableFuture insertEdge(final Object value, final EdgeCreateOptions options);

    /**
     * Fetches an existing edge
     *
     * @param key  The key of the edge
     * @param type The type of the edge-document (POJO or {@link com.arangodb.util.RawData}
     * @return the edge identified by the key
     * @see API Documentation
     */
     CompletableFuture getEdge(final String key, final Class type);

    /**
     * Fetches an existing edge
     *
     * @param key     The key of the edge
     * @param type    The type of the edge-document (POJO or {@link com.arangodb.util.RawData}
     * @param options Additional options, can be null
     * @return the edge identified by the key
     * @see API Documentation
     */
     CompletableFuture getEdge(final String key, final Class type, final GraphDocumentReadOptions options);

    /**
     * Replaces the edge with key with the one in the body, provided there is such a edge and no precondition is
     * violated
     *
     * @param key The key of the edge
     * @return information about the edge
     * @see API Documentation
     */
    CompletableFuture replaceEdge(final String key, final Object value);

    /**
     * Replaces the edge with key with the one in the body, provided there is such a edge and no precondition is
     * violated
     *
     * @param key     The key of the edge
     * @param options Additional options, can be null
     * @return information about the edge
     * @see API Documentation
     */
    CompletableFuture replaceEdge(
            final String key,
            final Object value,
            final EdgeReplaceOptions options);

    /**
     * Partially updates the edge identified by document-key. The value must contain a document with the attributes to
     * patch (the patch document). All attributes from the patch document will be added to the existing document if they
     * do not yet exist, and overwritten in the existing document if they do exist there.
     *
     * @param key The key of the edge
     * @return information about the edge
     * @see API Documentation
     */
    CompletableFuture updateEdge(final String key, final Object value);

    /**
     * Partially updates the edge identified by document-key. The value must contain a document with the attributes to
     * patch (the patch document). All attributes from the patch document will be added to the existing document if they
     * do not yet exist, and overwritten in the existing document if they do exist there.
     *
     * @param key     The key of the edge
     * @param options Additional options, can be null
     * @return information about the edge
     * @see API Documentation
     */
    CompletableFuture updateEdge(
            final String key,
            final Object value,
            final EdgeUpdateOptions options);

    /**
     * Removes a edge
     *
     * @param key The key of the edge
     * @see API Documentation
     */
    CompletableFuture deleteEdge(final String key);

    /**
     * Removes a edge
     *
     * @param key     The key of the edge
     * @param options Additional options, can be null
     * @see API Documentation
     */
    CompletableFuture deleteEdge(final String key, final EdgeDeleteOptions options);

}