01 /*
02 * Copyright 2004 The Apache Software Foundation
03 *
04 * Licensed under the Apache License, Version 2.0 (the "License");
05 * you may not use this file except in compliance with the License.
06 * You may obtain a copy of the License at
07 *
08 * http://www.apache.org/licenses/LICENSE-2.0
09 *
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 javax.servlet.jsp.tagext;
18
19 /**
20 * Tag information for a tag file in a Tag Library;
21 * This class is instantiated from the Tag Library Descriptor file (TLD)
22 * and is available only at translation time.
23 *
24 * @since 2.0
25 */
26 public class TagFileInfo {
27
28 /**
29 * Constructor for TagFileInfo from data in the JSP 2.0 format for TLD.
30 * This class is to be instantiated only from the TagLibrary code
31 * under request from some JSP code that is parsing a
32 * TLD (Tag Library Descriptor).
33 *
34 * Note that, since TagLibibraryInfo reflects both TLD information
35 * and taglib directive information, a TagFileInfo instance is
36 * dependent on a taglib directive. This is probably a
37 * design error, which may be fixed in the future.
38 *
39 * @param name The unique action name of this tag
40 * @param path Where to find the .tag file implementing this
41 * action, relative to the location of the TLD file.
42 * @param tagInfo The detailed information about this tag, as parsed
43 * from the directives in the tag file.
44 */
45 public TagFileInfo(String name, String path, TagInfo tagInfo) {
46 this .name = name;
47 this .path = path;
48 this .tagInfo = tagInfo;
49 }
50
51 /**
52 * The unique action name of this tag.
53 *
54 * @return The (short) name of the tag.
55 */
56 public String getName() {
57 return name;
58 }
59
60 /**
61 * Where to find the .tag file implementing this action.
62 *
63 * @return The path of the tag file, relative to the TLD, or "." if
64 * the tag file was defined in an implicit tag file.
65 */
66 public String getPath() {
67 return path;
68 }
69
70 /**
71 * Returns information about this tag, parsed from the directives
72 * in the tag file.
73 *
74 * @return a TagInfo object containing information about this tag
75 */
76 public TagInfo getTagInfo() {
77 return tagInfo;
78 }
79
80 // private fields for 2.0 info
81 private String name;
82 private String path;
83 private TagInfo tagInfo;
84 }
|