io.fluo.api.client.TransactionBase Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of fluo-api Show documentation

This module contains all API code. External dependencies should be limited. Any changes to public methods should be avoided. While the API module does not have compile time dependency on fluo-core, you must include fluo-core as a run-time dependency.

The newest version!

/*
 * Copyright 2014 Fluo authors (see AUTHORS)
 * 
 * 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 io.fluo.api.client;

import io.fluo.api.data.Bytes;
import io.fluo.api.data.Column;
import io.fluo.api.exceptions.AlreadySetException;

/**
 * Enables users to read and write to a Fluo table at certain point in time. TransactionBase extends
 * {@link SnapshotBase} to include methods for writing to Fluo.
 */
public interface TransactionBase extends SnapshotBase {

  /**
   * Sets a weak notification at the given row and {@link Column}
   */
  void setWeakNotification(Bytes row, Column col);

  /**
   * Sets a value (in {@link Bytes}) at the given row and {@link Column}
   */
  void set(Bytes row, Column col, Bytes value) throws AlreadySetException;

  /**
   * Deletes the value at the given row and {@link Column}
   */
  void delete(Bytes row, Column col);
}