View Javadoc

    1   /*
    2    * Licensed to the Apache Software Foundation (ASF) under one or more
    3    * contributor license agreements.  See the NOTICE file distributed with
    4    * this work for additional information regarding copyright ownership.
    5    * The ASF licenses this file to You under the Apache License, Version 2.0
    6    * (the "License"); you may not use this file except in compliance with
    7    * the License.  You may obtain a copy of the License at
    8    *
    9    *     http://www.apache.org/licenses/LICENSE-2.0
    10   *
    11   * Unless required by applicable law or agreed to in writing, software
    12   * distributed under the License is distributed on an "AS IS" BASIS,
    13   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    14   * See the License for the specific language governing permissions and
    15   * limitations under the License.
    16   */
    17  package javax.jdo.annotations;
    18
    19  import java.lang.annotation.ElementType;
    20  import java.lang.annotation.Retention;
    21  import java.lang.annotation.RetentionPolicy;
    22  import java.lang.annotation.Target;
    23
    24  /**
    25   * Annotation for the versioning of the class.
    26   * Corresponds to the xml element "version" of the "class" and "property"
    27   * elements.
    28   *
    29   * @version 2.1
    30   * @since 2.1
    31   */
    32  @Target(ElementType.TYPE)
    33  @Retention(RetentionPolicy.RUNTIME)
    34  public @interface Version
    35  {
    36      /**
    37       * Strategy for versioning of objects of this class.
    38       * @return the strategy for versioning objects of this class
    39       */
    40      VersionStrategy strategy() default VersionStrategy.UNSPECIFIED;
    41
    42      /**
    43       * Custom strategy for versioning of objects of this class.
    44       * If customStrategy is non-empty, strategy must be UNSPECIFIED.
    45       * @return the custom strategy for versioning objects of this class
    46       */
    47      String customStrategy() default "";
    48
    49      /**
    50       * Name of the column for the version.
    51       * @return the name of the column for the version
    52       */
    53      String column() default "";
    54
    55      /**
    56       * Whether the version column(s) is(are) indexed.
    57       * @return whether the version column(s) is(are) indexed
    58       */
    59      String indexed() default "";
    60
    61      /**
    62       * The column(s) making up the version.
    63       * @return the column(s) making up the version
    64       */
    65      Column[] columns() default {};
    66
    67      /** Vendor extensions.
    68       * @return the vendor extensions
    69       */
    70      Extension[] extensions() default {};
    71  }