| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <title>TagLibraryValidator</title> |
| <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> |
| <script type="text/javascript" src="../../../../script.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="TagLibraryValidator"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":10,"i1":10,"i2":10,"i3":10}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../jakarta/servlet/jsp/tagext/TagLibraryInfo.html" title="class in jakarta.servlet.jsp.tagext"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../jakarta/servlet/jsp/tagext/TagSupport.html" title="class in jakarta.servlet.jsp.tagext"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?jakarta/servlet/jsp/tagext/TagLibraryValidator.html" target="_top">Frames</a></li> |
| <li><a href="TagLibraryValidator.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">jakarta.servlet.jsp.tagext</div> |
| <h2 title="Class TagLibraryValidator" class="title">Class TagLibraryValidator</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li>java.lang.Object</li> |
| <li> |
| <ul class="inheritance"> |
| <li>jakarta.servlet.jsp.tagext.TagLibraryValidator</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>Direct Known Subclasses:</dt> |
| <dd><a href="../../../../jakarta/servlet/jsp/jstl/tlv/PermittedTaglibsTLV.html" title="class in jakarta.servlet.jsp.jstl.tlv">PermittedTaglibsTLV</a>, <a href="../../../../jakarta/servlet/jsp/jstl/tlv/ScriptFreeTLV.html" title="class in jakarta.servlet.jsp.jstl.tlv">ScriptFreeTLV</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public abstract class <span class="typeNameLabel">TagLibraryValidator</span> |
| extends java.lang.Object</pre> |
| <div class="block">Translation-time validator class for a JSP page. A validator operates on the XML view associated with the JSP page. |
| |
| <p> |
| The TLD file associates a TagLibraryValidator class and some init arguments with a tag library. |
| |
| <p> |
| The JSP container is reponsible for locating an appropriate instance of the appropriate subclass by |
| |
| <ul> |
| <li>new a fresh instance, or reuse an available one |
| <li>invoke the setInitParams(Map) method on the instance |
| </ul> |
| |
| once initialized, the validate(String, String, PageData) method will be invoked, where the first two arguments are |
| the prefix and uri for this tag library in the XML View. The prefix is intended to make it easier to produce an error |
| message. However, it is not always accurate. In the case where a single URI is mapped to more than one prefix in the |
| XML view, the prefix of the first URI is provided. Therefore, to provide high quality error messages in cases where |
| the tag elements themselves are checked, the prefix parameter should be ignored and the actual prefix of the element |
| should be used instead. TagLibraryValidators should always use the uri to identify elements as beloning to the tag |
| library, not the prefix. |
| |
| <p> |
| A TagLibraryValidator instance may create auxiliary objects internally to perform the validation (e.g. an XSchema |
| validator) and may reuse it for all the pages in a given translation run. |
| |
| <p> |
| The JSP container is not guaranteed to serialize invocations of validate() method, and TagLibraryValidators should |
| perform any synchronization they may require. |
| |
| <p> |
| As of JSP 2.0, a JSP container must provide a jsp:id attribute to provide higher quality validation errors. The |
| container will track the JSP pages as passed to the container, and will assign to each element a unique "id", which |
| is passed as the value of the jsp:id attribute. Each XML element in the XML view available will be extended with this |
| attribute. The TagLibraryValidator can then use the attribute in one or more ValidationMessage objects. The container |
| then, in turn, can use these values to provide more precise information on the location of an error. |
| |
| <p> |
| The actual prefix of the <code>id</code> attribute may or may not be <code>jsp</code> but it will always map to the |
| namespace <code>http://java.sun.com/JSP/Page</code>. A TagLibraryValidator implementation must rely on the uri, not |
| the prefix, of the <code>id</code> attribute.</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colOne" scope="col">Constructor and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../jakarta/servlet/jsp/tagext/TagLibraryValidator.html#TagLibraryValidator--">TagLibraryValidator</a></span>()</code> |
| <div class="block">Sole constructor.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code>java.util.Map<java.lang.String,java.lang.Object></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../jakarta/servlet/jsp/tagext/TagLibraryValidator.html#getInitParameters--">getInitParameters</a></span>()</code> |
| <div class="block">Get the init parameters data as an immutable Map.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../jakarta/servlet/jsp/tagext/TagLibraryValidator.html#release--">release</a></span>()</code> |
| <div class="block">Release any data kept by this instance for validation purposes.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../jakarta/servlet/jsp/tagext/TagLibraryValidator.html#setInitParameters-java.util.Map-">setInitParameters</a></span>(java.util.Map<java.lang.String,java.lang.Object> map)</code> |
| <div class="block">Set the init data in the TLD for this validator.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../jakarta/servlet/jsp/tagext/ValidationMessage.html" title="class in jakarta.servlet.jsp.tagext">ValidationMessage</a>[]</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../jakarta/servlet/jsp/tagext/TagLibraryValidator.html#validate-java.lang.String-java.lang.String-jakarta.servlet.jsp.tagext.PageData-">validate</a></span>(java.lang.String prefix, |
| java.lang.String uri, |
| <a href="../../../../jakarta/servlet/jsp/tagext/PageData.html" title="class in jakarta.servlet.jsp.tagext">PageData</a> page)</code> |
| <div class="block">Validate a JSP page.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.Object</h3> |
| <code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="TagLibraryValidator--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>TagLibraryValidator</h4> |
| <pre>public TagLibraryValidator()</pre> |
| <div class="block">Sole constructor. (For invocation by subclass constructors, typically implicit.)</div> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="setInitParameters-java.util.Map-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setInitParameters</h4> |
| <pre>public void setInitParameters(java.util.Map<java.lang.String,java.lang.Object> map)</pre> |
| <div class="block">Set the init data in the TLD for this validator. Parameter names are keys, and parameter values are the values.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>map</code> - A Map describing the init parameters</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getInitParameters--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getInitParameters</h4> |
| <pre>public java.util.Map<java.lang.String,java.lang.Object> getInitParameters()</pre> |
| <div class="block">Get the init parameters data as an immutable Map. Parameter names are keys, and parameter values are the values.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The init parameters as an immutable map.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="validate-java.lang.String-java.lang.String-jakarta.servlet.jsp.tagext.PageData-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>validate</h4> |
| <pre>public <a href="../../../../jakarta/servlet/jsp/tagext/ValidationMessage.html" title="class in jakarta.servlet.jsp.tagext">ValidationMessage</a>[] validate(java.lang.String prefix, |
| java.lang.String uri, |
| <a href="../../../../jakarta/servlet/jsp/tagext/PageData.html" title="class in jakarta.servlet.jsp.tagext">PageData</a> page)</pre> |
| <div class="block">Validate a JSP page. This will get invoked once per unique tag library URI in the XML view. This method will |
| return null if the page is valid; otherwise the method should return an array of ValidationMessage objects. An |
| array of length zero is also interpreted as no errors.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>prefix</code> - the first prefix with which the tag library is associated, in the XML view. Note that some tags may |
| use a different prefix if the namespace is redefined.</dd> |
| <dd><code>uri</code> - the tag library's unique identifier</dd> |
| <dd><code>page</code> - the JspData page object</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>A null object, or zero length array if no errors, an array of ValidationMessages otherwise.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="release--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>release</h4> |
| <pre>public void release()</pre> |
| <div class="block">Release any data kept by this instance for validation purposes.</div> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../jakarta/servlet/jsp/tagext/TagLibraryInfo.html" title="class in jakarta.servlet.jsp.tagext"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../jakarta/servlet/jsp/tagext/TagSupport.html" title="class in jakarta.servlet.jsp.tagext"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?jakarta/servlet/jsp/tagext/TagLibraryValidator.html" target="_top">Frames</a></li> |
| <li><a href="TagLibraryValidator.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </body> |
| </html> |
