View Javadoc

1   /**
2    * Licensed to the Apache Software Foundation (ASF) under one
3    * or more contributor license agreements.  See the NOTICE file
4    * distributed with this work for additional information
5    * regarding copyright ownership.  The ASF licenses this file
6    * to you under the Apache License, Version 2.0 (the
7    * "License"); you may not use this file except in compliance
8    * with the License.  You may obtain a copy of the License at
9    *
10   *     http://www.apache.org/licenses/LICENSE-2.0
11   *
12   * Unless required by applicable law or agreed to in writing, software
13   * distributed under the License is distributed on an "AS IS" BASIS,
14   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15   * See the License for the specific language governing permissions and
16   * limitations under the License.
17   */
18  package org.apache.hadoop.hbase;
19  
20  import java.io.IOException;
21  
22  import org.apache.hadoop.hbase.classification.InterfaceAudience;
23  
24  /**
25   * Using this Interface one can mark a Cell as timestamp changeable. <br>
26   * Note : Server side Cell implementations in write path must implement this.
27   */
28  @InterfaceAudience.LimitedPrivate(HBaseInterfaceAudience.COPROC)
29  public interface SettableTimestamp {
30  
31    /**
32     * Sets with the given timestamp.
33     * @param ts
34     */
35    void setTimestamp(long ts) throws IOException;
36  
37    /**
38     * Sets with the given timestamp.
39     * @param ts buffer containing the timestamp value
40     * @param tsOffset offset to the new timestamp
41     */
42    void setTimestamp(byte[] ts, int tsOffset) throws IOException;
43  }