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  
18  package org.apache.jdo.model.jdo;
19  
20  /***
21   * A JDOProperty instance represents the JDO metadata of a property of a
22   * persistence-capable class. 
23   *
24   * @author Michael Bouschen
25   */
26  public interface JDOProperty
27      extends JDOField
28  {
29      /*** 
30       * Return the JDOField instance associated with this property, if
31       * available. If there is no JDOField instance associated, then the method
32       * returns <code>null</code>.
33       * @return associated JDOField instance or <code>null</code> if not
34       * available.
35       */
36      public JDOField getAssociatedJDOField();
37  }