01: // Copyright 2007 The Apache Software Foundation
02: //
03: // Licensed under the Apache License, Version 2.0 (the "License");
04: // you may not use this file except in compliance with the License.
05: // You may obtain a copy of the License at
06: //
07: // http://www.apache.org/licenses/LICENSE-2.0
08: //
09: // Unless required by applicable law or agreed to in writing, software
10: // distributed under the License is distributed on an "AS IS" BASIS,
11: // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12: // See the License for the specific language governing permissions and
13: // limitations under the License.
14:
15: package org.apache.tapestry.services;
16:
17: import org.apache.tapestry.PropertyConduit;
18: import org.apache.tapestry.internal.bindings.PropBindingFactory;
19:
20: /**
21: * A source for {@link PropertyConduit}s, which can be thought of as a compiled property path
22: * expression. PropertyConduits are the basis of the "prop:" binding factory, thus this service
23: * defines the expression format used by the {@link PropBindingFactory}.
24: * <p>
25: * The expression consist of one or more terms, seperated by periods. Each term may be either the
26: * name of a JavaBean property, or the name of a method (a method that takes no parameters). Method
27: * names are distinguished from property names by appending empty parens. Using a method term as the
28: * final term will make the expression read-only.
29: */
30: public interface PropertyConduitSource {
31: /**
32: * Creates a new property conduit instance for the given expression.
33: *
34: * @param rootClass
35: * the class of the root object to which the expression is applied
36: * @param expression
37: * @return RuntimeException if the expression is invalid (poorly formed, references non-existent
38: * properties, etc.)
39: */
40: PropertyConduit create(Class rootClass, String expression);
41: }
|