All Downloads are FREE. Search and download functionalities are using the official Maven repository.

org.neo4j.driver.Bookmark Maven / Gradle / Ivy

The newest version!
/*
 * Copyright (c) "Neo4j"
 * Neo4j Sweden AB [https://neo4j.com]
 *
 * 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 org.neo4j.driver;

import java.util.Collections;
import java.util.Set;
import org.neo4j.driver.internal.InternalBookmark;

/**
 * Causal chaining is carried out by passing bookmarks between transactions.
 * 

* When starting a session with initial bookmarks, the first transaction will be ensured to run at least after * the database is as up-to-date as the latest transaction referenced by the supplied bookmarks. *

* Within a session, bookmark propagation is carried out automatically. * Thus, all transactions in a session (both managed and unmanaged) are guaranteed to be carried out one after another. *

* To opt out of this mechanism for unrelated units of work, applications can use multiple sessions. */ public interface Bookmark { /** * Returns a string that this bookmark instance identifies. * * @return a string that this bookmark instance identifies. */ String value(); /** * Returns a read-only set of bookmark strings that this bookmark instance identifies. * * @return a read-only set of bookmark strings that this bookmark instance identifies. */ @Deprecated Set values(); /** * Reconstruct bookmark from bookmark string value. * * @param value value obtained from a previous bookmark. * @return A bookmark. */ static Bookmark from(String value) { return InternalBookmark.parse(Collections.singleton(value)); } /** * Reconstruct bookmark from bookmarks string values. * * @param values values obtained from a previous bookmark. * @return A bookmark. */ @Deprecated static Bookmark from(Set values) { return InternalBookmark.parse(values); } /** * Return true if the bookmark is empty. * @return true if the bookmark is empty. */ @Deprecated boolean isEmpty(); }





© 2015 - 2024 Weber Informatics LLC | Privacy Policy