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