View Javadoc

1   /*
2    * Copyright 2005 The Apache Software Foundation.
3    * 
4    * Licensed under the Apache License, Version 2.0 (the "License");
5    * you may not use this file except in compliance with the License.
6    * You may obtain a copy of the License at 
7    * 
8    *     http://www.apache.org/licenses/LICENSE-2.0
9    * 
10   * Unless required by applicable law or agreed to in writing, software 
11   * distributed under the License is distributed on an "AS IS" BASIS, 
12   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 
13   * See the License for the specific language governing permissions and 
14   * limitations under the License.
15   */
16  
17  package org.apache.jdo.model.java;
18  
19  /***
20   * This is the super interface for all the JavaModel elements, such as 
21   * JavaField, JavaType, etc.
22   * 
23   * @author Michael Bouschen
24   * @since JDO 2.0
25   */
26  public interface JavaElement 
27  {
28  
29      /***
30       * Returns the environment specific instance wrapped by this JavaModel
31       * element. E.g. a runtime implementation of JavaField might use a
32       * java.lang.reflect.Field instance as the underlying object.
33       * @return the environment specific instance wrapped by this JavaModel
34       * element.
35       */
36      public Object getUnderlyingObject();
37      
38  }