org.apache.tapestry.ioc.MappedConfiguration Maven / Gradle / Ivy

Go to download
// Copyright 2006 The Apache Software Foundation
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

package org.apache.tapestry.ioc;

/**
 * Object passed into a service contributor method that allows the method provide contributed values
 * to the service's configuration.
 * 
 * A service can collect contributions in three different ways:
 * 

 * As an un-ordered collection of values
 * As an ordered list of values (where each value has a unique id, pre-requisited and
 * post-requisites)
 * As a map of keys and values
 * 
 * 
 * The service defines the type of contribution, in terms of a base class or service
 * interface. Contributions must be compatible with the type.
 */
public interface MappedConfiguration
{

    /**
     * Adds a keyed object to the service's contribution.
     *
     * @param key   unique id for the value
     * @param value to contribute
     * @throws IllegalArgumentException if key is not unique
     */

    void add(K key, V value);
}