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