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.java;
19  
20  /***
21   * This is the super interface for all the JavaModel elements, such as 
22   * JavaField, JavaType, etc.
23   * 
24   * @author Michael Bouschen
25   * @since JDO 2.0
26   */
27  public interface JavaElement 
28  {
29  
30      /***
31       * Returns the environment specific instance wrapped by this JavaModel
32       * element. E.g. a runtime implementation of JavaField might use a
33       * java.lang.reflect.Field instance as the underlying object.
34       * @return the environment specific instance wrapped by this JavaModel
35       * element.
36       */
37      public Object getUnderlyingObject();
38      
39  }