    001//  Copyright 2008, 2009 The Apache Software Foundation
    002//
    003// Licensed under the Apache License, Version 2.0 (the "License");
    004// you may not use this file except in compliance with the License.
    005// You may obtain a copy of the License at
    006//
    007//     http://www.apache.org/licenses/LICENSE-2.0
    008//
    009// Unless required by applicable law or agreed to in writing, software
    010// distributed under the License is distributed on an "AS IS" BASIS,
    011// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    012// See the License for the specific language governing permissions and
    013// limitations under the License.
    014
    015package org.apache.tapestry5.ioc.annotations;
    016
    017import java.lang.annotation.*;
    018
    019/**
    020 * A documentation-only interface placed on service interfaces for services which have a {@linkplain
    021 * org.apache.tapestry5.ioc.MappedConfiguration mapped configuration}, to identify the type of key (often, a String),
    022 * and type ofcontribution.
    023 * <p/>
    024 * Remember that when the key type is String, the map will be case-insensitive.
    025 */
    026@Target(ElementType.TYPE)
    027@Retention(RetentionPolicy.CLASS)
    028@Documented
    029@UseWith(AnnotationUseContext.SERVICE)
    030public @interface UsesMappedConfiguration
    031{
    032    /**
    033     * The type of key used to identify contribution values.
    034     */
    035    Class key() default String.class;
    036
    037    /**
    038     * The type of object which may be contributed into the service's configuration.
    039     */
    040    Class value();
    041}