KickJava   Java API By Example, From Geeks To Geeks.

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


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 used for setting values that appear to be properties in
21  * Velocity. Ex.
22  *
23  * #set($foo.bar = "hello")
24  *
25  * @author <a HREF="mailto:geirm@optonline.net">Geir Magnusson Jr.</a>
26  * @version $Id: VelPropertySet.java,v 1.1.4.1 2004/03/03 23:23:08 geirm Exp $
27  */
28 public interface VelPropertySet
29 {
30     /**
31      * method used to set the value in the object
32      *
33      * @param o Object on which the method will be called with the arg
34      * @param arg value to be set
35      * @return the value returned from the set operation (impl specific)
36      */
37     public Object JavaDoc invoke(Object JavaDoc o, Object JavaDoc arg) throws Exception JavaDoc;
38
39     /**
40      * specifies if this VelPropertySet is cacheable and able to be
41      * reused for this class of object it was returned for
42      *
43      * @return true if can be reused for this class, false if not
44      */
45     public boolean isCacheable();
46
47     /**
48      * returns the method name used to set this 'property'
49      */
50     public String JavaDoc getMethodName();
51 }
52
Popular Tags