View Javadoc

1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one
3    * or more contributor license agreements.  See the NOTICE file
4    * distributed with this work for additional information
5    * regarding copyright ownership.  The ASF licenses this file
6    * to you under the Apache License, Version 2.0 (the
7    * "License"); you may not use this file except in compliance
8    * with the License.  You may obtain a copy of the License at
9    *
10   *   http://www.apache.org/licenses/LICENSE-2.0
11   *
12   * Unless required by applicable law or agreed to in writing,
13   * software distributed under the License is distributed on an
14   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15   * KIND, either express or implied.  See the License for the
16   * specific language governing permissions and limitations
17   * under the License.
18   */
19  package javax.faces.view.facelets;
20  
21  
22  /**
23   * A set of TagAttributes, usually representing all attributes on a Tag.
24   */
25  public abstract class TagAttributes
26  {
27      /**
28       * 
29       */
30      public TagAttributes()
31      {
32      }
33  
34      /**
35       * Using no namespace, find the TagAttribute
36       * 
37       * @see #get(String, String)
38       * @param localName
39       *            tag attribute name
40       * @return the TagAttribute found, otherwise null
41       */
42      public abstract TagAttribute get(String localName);
43  
44      /**
45       * Find a TagAttribute that matches the passed namespace and local name.
46       * 
47       * @param ns
48       *            namespace of the desired attribute
49       * @param localName
50       *            local name of the attribute
51       * @return a TagAttribute found, otherwise null
52       */
53      public abstract TagAttribute get(String ns, String localName);
54  
55      /**
56       * Return an array of all TagAttributes in this set
57       * 
58       * @return a non-null array of TagAttributes
59       */
60      public abstract TagAttribute[] getAll();
61  
62      /**
63       * Get all TagAttributes for the passed namespace
64       * 
65       * @param namespace
66       *            namespace to search
67       * @return a non-null array of TagAttributes
68       */
69      public abstract TagAttribute[] getAll(String namespace);
70  
71      /**
72       * A list of Namespaces found in this set
73       * 
74       * @return a list of Namespaces found in this set
75       */
76      public abstract String[] getNamespaces();
77      
78      /**
79       * @since 2.2
80       * @return 
81       */
82      public Tag getTag()
83      {
84          return null;
85      }
86  
87      /**
88       * @since 2.2
89       * @param tag 
90       */
91      public void setTag(Tag tag)
92      {
93      }
94  }