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.metadata;
    18
    19  /**
    20   * Represents details of an array in a field/property in a class.
    21   * @since 3.0
    22   */
    23  public interface ArrayMetadata extends Metadata {
    24      /**
    25       * Method to set the name of the element type
    26       *
    27       * @param type Name of the element type
    28       */
    29      ArrayMetadata setElementType(String type);
    30
    31      /**
    32       * Accessor for the element type
    33       *
    34       * @return The element type
    35       */
    36      String getElementType();
    37
    38      /**
    39       * Method to set whether the element is embedded
    40       *
    41       * @param val Whether it is embedded
    42       */
    43      ArrayMetadata setEmbeddedElement(boolean val);
    44
    45      /**
    46       * Accessor for whether the element is embedded
    47       *
    48       * @return whether the element is embedded
    49       */
    50      Boolean getEmbeddedElement();
    51
    52      /**
    53       * Method to set whether the element is serialised
    54       *
    55       * @param val Whether it is serialised
    56       */
    57      ArrayMetadata setSerializedElement(boolean val);
    58
    59      /**
    60       * Accessor for whether the element is serialised
    61       *
    62       * @return whether the element is serialised
    63       */
    64      Boolean getSerializedElement();
    65
    66      /**
    67       * Method to set whether the element is dependent
    68       *
    69       * @param val Whether it is dependent
    70       */
    71      ArrayMetadata setDependentElement(boolean val);
    72
    73      /**
    74       * Accessor for whether the element is dependent
    75       *
    76       * @return whether the element is dependent
    77       */
    78      Boolean getDependentElement();
    79  }