Classes in this File | Line Coverage | Branch Coverage | Complexity | ||||||
BindingSource |
|
| 1.0;1 |
1 | // Copyright 2004, 2005 The Apache Software Foundation |
|
2 | // |
|
3 | // Licensed under the Apache License, Version 2.0 (the "License"); |
|
4 | // you may not use this file except in compliance with the License. |
|
5 | // You may obtain a copy of the License at |
|
6 | // |
|
7 | // http://www.apache.org/licenses/LICENSE-2.0 |
|
8 | // |
|
9 | // 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.binding; |
|
16 | ||
17 | import org.apache.hivemind.Location; |
|
18 | import org.apache.tapestry.IBinding; |
|
19 | import org.apache.tapestry.IComponent; |
|
20 | import org.apache.tapestry.spec.IParameterSpecification; |
|
21 | ||
22 | /** |
|
23 | * Used to convert a binding string (from a template or a specification) into an instance of |
|
24 | * {@link IBinding}. |
|
25 | * |
|
26 | * @since 4.0 |
|
27 | */ |
|
28 | public interface BindingSource |
|
29 | { |
|
30 | /** |
|
31 | * Creates a new binding. The locator is used to identify the <em>type</em> of binding to |
|
32 | * create as well as configure the binding instance. The locator is either a literal value |
|
33 | * (resulting in a {@link org.apache.tapestry.binding.LiteralBinding literal binding}) or |
|
34 | * consists of prefix and a path, i.e., <code>ognl:myProperty</code>. |
|
35 | * <p> |
|
36 | * When a prefix exists and is identified, it is used to select the correct |
|
37 | * {@link BindingFactory}, and the remainder of the path (i.e., <code>myProperty</code>) |
|
38 | * is passed to the factory. An unrecognized prefix is treated as a literal value |
|
39 | * (it is often "javascript:" or "http:", etc.). |
|
40 | * |
|
41 | * @param component |
|
42 | * The component for which the binding is created; the component is used |
|
43 | * as a kind of context for certain types of bindings (for example, the root object when |
|
44 | * evaluating OGNL expressions). |
|
45 | * @param description |
|
46 | {@link IBinding#getDescription() description} for the new binding |
|
47 | * @param reference |
|
48 | * The binding reference used to create the binding, possibly including a prefix to define the type. |
|
49 | * If the reference does not include a prefix, then the defaultBindingType is used as the prefix |
|
50 | * @param defaultBindingType |
|
51 | * Binding type to use when no prefix is provided in the reference |
|
52 | * or doesn't match a known binding factory. |
|
53 | * @param location |
|
54 | * Location used to report errors in the binding. |
|
55 | * |
|
56 | * @return A binding instance. |
|
57 | */ |
|
58 | IBinding createBinding(IComponent component, String description, String reference, |
|
59 | String defaultBindingType, Location location); |
|
60 | ||
61 | /** |
|
62 | * Just like {@link #createBinding(org.apache.tapestry.IComponent, String, String, String, org.apache.hivemind.Location)} - except |
|
63 | * this version takes an additional parameter of type {@link IParameterSpecification} for those bindings that have a matching |
|
64 | * parameter. |
|
65 | * |
|
66 | * @param component |
|
67 | * The component for which the binding is created; the component is used |
|
68 | * as a kind of context for certain types of bindings (for example, the root object when |
|
69 | * evaluating OGNL expressions). |
|
70 | * @param parameter |
|
71 | * Optional argument of the parameter this binding is being bound for - may be null. |
|
72 | * @param description |
|
73 | {@link IBinding#getDescription() description} for the new binding |
|
74 | * @param reference |
|
75 | * The binding reference used to create the binding, possibly including a prefix to define the type. |
|
76 | * If the reference does not include a prefix, then the defaultBindingType is used as the prefix |
|
77 | * @param defaultBindingType |
|
78 | * Binding type to use when no prefix is provided in the reference |
|
79 | * or doesn't match a known binding factory. |
|
80 | * @param location |
|
81 | * Location used to report errors in the binding. |
|
82 | * |
|
83 | * @return A binding instance. |
|
84 | */ |
|
85 | IBinding createBinding(IComponent component, IParameterSpecification parameter, String description, String reference, |
|
86 | String defaultBindingType, Location location); |
|
87 | } |