01: // Copyright 2006 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.ioc;
16:
17: /**
18: * Object passed into a service contributor method that allows the method provide contributed values
19: * to the service's configuration.
20: * <p>
21: * A service can <em>collect</em> contributions in three different ways:
22: * <ul>
23: * <li>As an un-ordered collection of values</li>
24: * <li>As an ordered list of values (where each value has a unique id, pre-requisited and
25: * post-requisites)</li>
26: * <li>As a map of keys and values
27: * </ul>
28: * <p>
29: * The service defines the <em>type</em> of contribution, in terms of a base class or service
30: * interface. Contributions must be compatible with the type.
31: *
32: *
33: */
34: public interface MappedConfiguration<K, V> {
35:
36: /**
37: * Adds a keyed object to the service's contribution.
38: *
39: * @param key
40: * unique id for the value
41: * @param value
42: * to contribute
43: * @throws IllegalArgumentException
44: * if key is not unique
45: */
46:
47: void add(K key, V value);
48: }
|