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   * A JavaProperty instance represents a JavaBeans property.
22   * 
23   * @author Michael Bouschen
24   * @version JDO 2.0
25   */
26  public interface JavaProperty extends JavaField
27  {
28      /***
29       * Returns the JavaMethod representation of the getter method for this
30       * JavaProperty. If there is no getter method for this JavaProperty
31       * (i.e. the property is write-only), then the method returns
32       * <code>null</code>.
33       * @return the getter method if available; or <code>null</code>
34       * otherwise.
35       */
36      public JavaMethod getGetterMethod();
37  
38      /***
39       * Returns the JavaMethod representation of the setter method for this
40       * JavaProperty. If there is no setter method for this JavaProperty
41       * (i.e. the property is read-only), then the method returns
42       * <code>null</code>.
43       * @return the setter method if available; or <code>null</code>
44       * otherwise.
45       */
46      public JavaMethod getSetterMethod();
47  }