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 ordering component of an ordered container member,
    26   * such as Java Collections Framework Array and List types and Java native
    27   * array types.
    28   * Corresponds to the xml element "order".
    29   *
    30   * @version 2.1
    31   * @since 2.1
    32   */
    33  @Target({ElementType.FIELD, ElementType.METHOD})
    34  @Retention(RetentionPolicy.RUNTIME)
    35  public @interface Order
    36  {
    37      /** The name of the column to use for ordering the elements of the member.
    38       * @return the name of the ordering column
    39       */
    40      String column() default "";
    41
    42      /** Name of a field or property in the target class that acts as the
    43       * ordering field or property for this member.
    44       * Return the name of the field or property in the target class
    45       */
    46      String mappedBy() default "";
    47
    48      /** The definition of the column(s) to use for ordering.
    49       * @return the columns to use for ordering
    50       */
    51      Column[] columns() default {};
    52
    53      /** Vendor extensions.
    54       * @return the vendor extensions
    55       */
    56      Extension[] extensions() default {};
    57  }