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  import java.lang.reflect.Field;
    20
    21  /**
    22   * Represents a class.
    23   * @since 3.0
    24   */
    25  public interface ClassMetadata extends TypeMetadata {
    26      /**
    27       * Method to define the persistence modifier.
    28       * @param mod persistence modifier
    29       */
    30      ClassMetadata setPersistenceModifier(ClassPersistenceModifier mod);
    31
    32      /**
    33       * Accessor for the persistence modifier.
    34       * @return persistence modifier
    35       */
    36      ClassPersistenceModifier getPersistenceModifier();
    37
    38      /**
    39       * Add a new field to this class.
    40       * @param name Name of the field
    41       * @return The FieldMetadata
    42       */
    43      FieldMetadata newFieldMetadata(String name);
    44
    45      /**
    46       * Add a new field to this class.
    47       * @param fld The field
    48       * @return The FieldMetadata
    49       */
    50      FieldMetadata newFieldMetadata(Field fld);
    51  }