01: package org.apache.velocity.util.introspection;
02:
03: /*
04: * Licensed to the Apache Software Foundation (ASF) under one
05: * or more contributor license agreements. See the NOTICE file
06: * distributed with this work for additional information
07: * regarding copyright ownership. The ASF licenses this file
08: * to you under the Apache License, Version 2.0 (the
09: * "License"); you may not use this file except in compliance
10: * with the License. You may obtain a copy of the License at
11: *
12: * http://www.apache.org/licenses/LICENSE-2.0
13: *
14: * Unless required by applicable law or agreed to in writing,
15: * software distributed under the License is distributed on an
16: * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17: * KIND, either express or implied. See the License for the
18: * specific language governing permissions and limitations
19: * under the License.
20: */
21:
22: /**
23: * Interface defining a 'getter'. For uses when looking for resolution of
24: * property references
25: *
26: * $foo.bar
27: *
28: * @author <a href="mailto:geirm@optonline.net">Geir Magnusson Jr.</a>
29: * @version $Id: VelPropertyGet.java 463298 2006-10-12 16:10:32Z henning $
30: */
31: public interface VelPropertyGet {
32: /**
33: * invocation method - called when the 'get action' should be
34: * preformed and a value returned
35: * @param o
36: * @return The resulting Object.
37: * @throws Exception
38: */
39: public Object invoke(Object o) throws Exception;
40:
41: /**
42: * specifies if this VelPropertyGet is cacheable and able to be
43: * reused for this class of object it was returned for
44: *
45: * @return true if can be reused for this class, false if not
46: */
47: public boolean isCacheable();
48:
49: /**
50: * returns the method name used to return this 'property'
51: * @return The method name used to return this 'property'
52: */
53: public String getMethodName();
54: }
|