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.lang.annotation.ElementType;
21  import java.lang.annotation.Retention;
22  import java.lang.annotation.RetentionPolicy;
23  import java.lang.annotation.Target;
24  
25  import org.apache.hadoop.hbase.classification.InterfaceAudience;
26  
27  /**
28   * A package attribute that captures the version of hbase that was compiled.
29   * Copied down from hadoop.  All is same except name of interface.
30   */
31  @Retention(RetentionPolicy.RUNTIME)
32  @Target(ElementType.PACKAGE)
33  @InterfaceAudience.Private
34  public @interface VersionAnnotation {
35  
36    /**
37     * Get the Hadoop version
38     * @return the version string "0.6.3-dev"
39     */
40    String version();
41  
42    /**
43     * Get the username that compiled Hadoop.
44     */
45    String user();
46  
47    /**
48     * Get the date when Hadoop was compiled.
49     * @return the date in unix 'date' format
50     */
51    String date();
52  
53    /**
54     * Get the url for the subversion repository.
55     */
56    String url();
57  
58    /**
59     * Get the subversion revision.
60     * @return the revision number as a string (eg. "451451")
61     */
62    String revision();
63  
64    /**
65     * Get a checksum of the source files from which HBase was compiled.
66     * @return a string that uniquely identifies the source
67     **/
68    String srcChecksum();
69  }