View Javadoc

1   /*
2    * Copyright 2002,2004 The Apache Software Foundation.
3    *
4    * Licensed under the Apache License, Version 2.0 (the "License");
5    * you may not use this file except in compliance with the License.
6    * You may obtain a copy of the License at
7    *
8    *      http://www.apache.org/licenses/LICENSE-2.0
9    *
10   * Unless required by applicable law or agreed to in writing, software
11   * distributed under the License is distributed on an "AS IS" BASIS,
12   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13   * See the License for the specific language governing permissions and
14   * limitations under the License.
15   */
16  
17  package org.apache.commons.jelly;
18  
19  import java.util.Map;
20  
21  /***
22   * <p><code>NamespaceAwareTag</code> represents a Jelly custom tag which
23   * needs to be aware of the XML Namespace context in which it is used.
24   * When the tag is used it will be given the namespace context which is a
25   * Map keyed on the namespace prefixes and the values are the namespace URIs
26   * in scope in the tags element.
27   * </p>
28   *
29   * @author <a href="mailto:jstrachan@apache.org">James Strachan</a>
30   * @version $Revision: 155420 $
31   */
32  
33  public interface NamespaceAwareTag extends Tag {
34  
35      /***
36       * Sets the namespace context in scope when this tag is used
37       *
38       * @param prefixToUriMap is a Map where the keys are the namespace
39       * prefixes and the values are the namespace URIs
40       */
41      public void setNamespaceContext(Map prefixToUriMap);
42  }