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 a map in a field/property in a class.
    21   * @since 3.0
    22   */
    23  public interface MapMetadata extends Metadata {
    24      /**
    25       * Method to set the name of the key type
    26       *
    27       * @param type Name of the key type
    28       */
    29      MapMetadata setKeyType(String type);
    30
    31      /**
    32       * Accessor for the key type
    33       *
    34       * @return The key type
    35       */
    36      String getKeyType();
    37
    38      /**
    39       * Method to set whether the key is embedded
    40       *
    41       * @param val Whether it is embedded
    42       */
    43      MapMetadata setEmbeddedKey(boolean val);
    44
    45      /**
    46       * Accessor for whether the key is embedded
    47       *
    48       * @return whether the key is embedded
    49       */
    50      Boolean getEmbeddedKey();
    51
    52      /**
    53       * Method to set whether the key is serialised
    54       *
    55       * @param val Whether it is serialised
    56       */
    57      MapMetadata setSerializedKey(boolean val);
    58
    59      /**
    60       * Accessor for whether the key is serialised
    61       *
    62       * @return whether the key is serialised
    63       */
    64      Boolean getSerializedKey();
    65
    66      /**
    67       * Method to set whether the key is dependent
    68       *
    69       * @param val Whether it is dependent
    70       */
    71      MapMetadata setDependentKey(boolean val);
    72
    73      /**
    74       * Accessor for whether the key is dependent
    75       *
    76       * @return whether the key is dependent
    77       */
    78      Boolean getDependentKey();
    79
    80      /**
    81       * Method to set the name of the value type
    82       *
    83       * @param type Name of the value type
    84       */
    85      MapMetadata setValueType(String type);
    86
    87      /**
    88       * Accessor for the value type
    89       *
    90       * @return The value type
    91       */
    92      String getValueType();
    93
    94      /**
    95       * Method to set whether the value is embedded
    96       *
    97       * @param val Whether it is embedded
    98       */
    99      MapMetadata setEmbeddedValue(boolean val);
    100
    101     /**
    102      * Accessor for whether the value is embedded
    103      *
    104      * @return whether the value is embedded
    105      */
    106     Boolean getEmbeddedValue();
    107
    108     /**
    109      * Method to set whether the value is serialised
    110      *
    111      * @param val Whether it is serialised
    112      */
    113     MapMetadata setSerializedValue(boolean val);
    114
    115     /**
    116      * Accessor for whether the value is serialised
    117      *
    118      * @return whether the value is serialised
    119      */
    120     Boolean getSerializedValue();
    121
    122     /**
    123      * Method to set whether the value is dependent
    124      *
    125      * @param val Whether it is dependent
    126      */
    127     MapMetadata setDependentValue(boolean val);
    128
    129     /**
    130      * Accessor for whether the value is dependent
    131      *
    132      * @return whether the value is dependent
    133      */
    134     Boolean getDependentValue();
    135 }