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 a datastore sequence.
    26   * Maps across to the JDO2 element "sequence".
    27   *
    28   * @version 2.1
    29   * @since 2.1
    30   */
    31  @Target(ElementType.TYPE)
    32  @Retention(RetentionPolicy.RUNTIME)
    33  public @interface Sequence
    34  {
    35      /** The symbolic name of the datastore sequence.
    36       * @return the name of the sequence
    37       */
    38      String name();
    39
    40      /** Strategy for the sequence.
    41       * @return the strategy for the sequence
    42       */
    43      SequenceStrategy strategy();
    44
    45      /** Name of the sequence in the datastore.
    46       * @return the name of the datastore sequence
    47       */
    48      String datastoreSequence() default "";
    49
    50      /** Name of a factory class for generating the sequence values.
    51       * @return the name of the factory class for the sequence
    52       */
    53      Class factoryClass() default void.class;
    54
    55      /** Vendor extensions for this sequence.
    56       * @return vendor extensions
    57       */
    58      Extension[] extensions() default {};
    59  }