KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > velocity > util > introspection > VelPropertyGet


1 package org.apache.velocity.util.introspection;
2
3 /*
4  * Copyright 2002,2004 The Apache Software Foundation.
5  *
6  * Licensed under the Apache License, Version 2.0 (the "License");
7  * you may not use this file except in compliance with the License.
8  * You may obtain a copy of the License at
9  *
10  * http://www.apache.org/licenses/LICENSE-2.0
11  *
12  * Unless required by applicable law or agreed to in writing, software
13  * distributed under the License is distributed on an "AS IS" BASIS,
14  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15  * See the License for the specific language governing permissions and
16  * limitations under the License.
17  */
18
19 /**
20  * Interface defining a 'getter'. For uses when looking for resolution of
21  * property references
22  *
23  * $foo.bar
24  *
25  * @author <a HREF="mailto:geirm@optonline.net">Geir Magnusson Jr.</a>
26  * @version $Id: VelPropertyGet.java,v 1.1.4.1 2004/03/03 23:23:08 geirm Exp $
27  */
28 public interface VelPropertyGet
29 {
30     /**
31      * invocation method - called when the 'get action' should be
32      * preformed and a value returned
33      */
34     public Object JavaDoc invoke(Object JavaDoc o) throws Exception JavaDoc;
35
36     /**
37      * specifies if this VelPropertyGet is cacheable and able to be
38      * reused for this class of object it was returned for
39      *
40      * @return true if can be reused for this class, false if not
41      */
42     public boolean isCacheable();
43
44     /**
45      * returns the method name used to return this 'property'
46      */
47     public String JavaDoc getMethodName();
48 }
49
Popular Tags