001/* 
002 * Licensed to the Apache Software Foundation (ASF) under one
003 * or more contributor license agreements.  See the NOTICE file
004 * distributed with this work for additional information
005 * regarding copyright ownership.  The ASF licenses this file
006 * to you under the Apache License, Version 2.0 (the
007 * "License"); you may not use this file except in compliance
008 * with the License.  You may obtain a copy of the License at
009 *
010 *   http://www.apache.org/licenses/LICENSE-2.0
011 *
012 * Unless required by applicable law or agreed to in writing,
013 * software distributed under the License is distributed on an
014 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
015 * KIND, either express or implied.  See the License for the
016 * specific language governing permissions and limitations
017 * under the License.
018 */
019package org.apache.felix.ipojo.annotations;
020
021import java.lang.annotation.ElementType;
022import java.lang.annotation.Target;
023
024/**
025 * This annotation is used to configure a handler through XML (as in {@literal metadata.xml}).
026 * <pre>
027 *     {@linkplain org.apache.felix.ipojo.annotations.Component @Component}
028 *     {@code @HandlerDeclaration("<ns:my-handler attribute='value' xmlns:ns='http://www.acme.com/ipojo/ns'/>")}
029 *     public class MyComponent {
030 *         // ...
031 *     }
032 * </pre>
033 * @author <a href="mailto:dev@felix.apache.org">Felix Project Team</a>
034 */
035@Target({ElementType.TYPE, ElementType.ANNOTATION_TYPE})
036public @interface HandlerDeclaration {
037
038    /**
039     * The content of this attribute represents the XML 
040     * that would be used in the metadata.xml.
041     * It must be a root XML Element, namespaces are allowed and so for child elements.
042     */
043    String value();
044}