| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <title>XMLString</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="XMLString"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":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="../../../../org/apache/jasper/xmlparser/XMLEncodingDetector.html" title="class in org.apache.jasper.xmlparser"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/jasper/xmlparser/XMLStringBuffer.html" title="class in org.apache.jasper.xmlparser"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/jasper/xmlparser/XMLString.html" target="_top">Frames</a></li> |
| <li><a href="XMLString.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><a href="#field.summary">Field</a> | </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><a href="#field.detail">Field</a> | </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">org.apache.jasper.xmlparser</div> |
| <h2 title="Class XMLString" class="title">Class XMLString</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li>java.lang.Object</li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.jasper.xmlparser.XMLString</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>Direct Known Subclasses:</dt> |
| <dd><a href="../../../../org/apache/jasper/xmlparser/XMLStringBuffer.html" title="class in org.apache.jasper.xmlparser">XMLStringBuffer</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public class <span class="typeNameLabel">XMLString</span> |
| extends java.lang.Object</pre> |
| <div class="block">This class is used as a structure to pass text contained in the underlying |
| character buffer of the scanner. The offset and length fields allow the |
| buffer to be re-used without creating new character arrays. |
| <p> |
| <strong>Note:</strong> Methods that are passed an XMLString structure |
| should consider the contents read-only and not make any modifications |
| to the contents of the buffer. The method receiving this structure |
| should also not modify the offset and length if this structure (or |
| the values of this structure) are passed to another method. |
| <p> |
| <strong>Note:</strong> Methods that are passed an XMLString structure |
| are required to copy the information out of the buffer if it is to be |
| saved for use beyond the scope of the method. The contents of the |
| structure are volatile and the contents of the character buffer cannot |
| be assured once the method that is passed this structure returns. |
| Therefore, methods passed this structure should not save any reference |
| to the structure or the character array contained in the structure.</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field.summary"> |
| <!-- --> |
| </a> |
| <h3>Field Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> |
| <caption><span>Fields</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Field and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>char[]</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/jasper/xmlparser/XMLString.html#ch">ch</a></span></code> |
| <div class="block">The character array.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/jasper/xmlparser/XMLString.html#length">length</a></span></code> |
| <div class="block">The length of characters from the offset.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/jasper/xmlparser/XMLString.html#offset">offset</a></span></code> |
| <div class="block">The offset into the character array.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ======== 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="../../../../org/apache/jasper/xmlparser/XMLString.html#XMLString--">XMLString</a></span>()</code> |
| <div class="block">Default constructor.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/jasper/xmlparser/XMLString.html#XMLString-char:A-int-int-">XMLString</a></span>(char[] ch, |
| int offset, |
| int length)</code> |
| <div class="block">Constructs an XMLString structure preset with the specified |
| values.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/jasper/xmlparser/XMLString.html#XMLString-org.apache.jasper.xmlparser.XMLString-">XMLString</a></span>(<a href="../../../../org/apache/jasper/xmlparser/XMLString.html" title="class in org.apache.jasper.xmlparser">XMLString</a> string)</code> |
| <div class="block">Constructs an XMLString structure with copies of the values in |
| the given structure.</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>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/jasper/xmlparser/XMLString.html#clear--">clear</a></span>()</code> |
| <div class="block">Resets all of the values to their defaults.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/jasper/xmlparser/XMLString.html#equals-char:A-int-int-">equals</a></span>(char[] ch, |
| int offset, |
| int length)</code> |
| <div class="block">Returns true if the contents of this XMLString structure and |
| the specified array are equal.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/jasper/xmlparser/XMLString.html#equals-java.lang.String-">equals</a></span>(java.lang.String s)</code> |
| <div class="block">Returns true if the contents of this XMLString structure and |
| the specified string are equal.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/jasper/xmlparser/XMLString.html#setValues-char:A-int-int-">setValues</a></span>(char[] ch, |
| int offset, |
| int length)</code> |
| <div class="block">Initializes the contents of the XMLString structure with the |
| specified values.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/jasper/xmlparser/XMLString.html#setValues-org.apache.jasper.xmlparser.XMLString-">setValues</a></span>(<a href="../../../../org/apache/jasper/xmlparser/XMLString.html" title="class in org.apache.jasper.xmlparser">XMLString</a> s)</code> |
| <div class="block">Initializes the contents of the XMLString structure with copies |
| of the given string structure.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>java.lang.String</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/jasper/xmlparser/XMLString.html#toString--">toString</a></span>()</code> |
| <div class="block">Returns a string representation of this object.</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, wait, wait, wait</code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field.detail"> |
| <!-- --> |
| </a> |
| <h3>Field Detail</h3> |
| <a name="ch"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>ch</h4> |
| <pre>public char[] ch</pre> |
| <div class="block">The character array.</div> |
| </li> |
| </ul> |
| <a name="offset"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>offset</h4> |
| <pre>public int offset</pre> |
| <div class="block">The offset into the character array.</div> |
| </li> |
| </ul> |
| <a name="length"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>length</h4> |
| <pre>public int length</pre> |
| <div class="block">The length of characters from the offset.</div> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="XMLString--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>XMLString</h4> |
| <pre>public XMLString()</pre> |
| <div class="block">Default constructor.</div> |
| </li> |
| </ul> |
| <a name="XMLString-char:A-int-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>XMLString</h4> |
| <pre>public XMLString(char[] ch, |
| int offset, |
| int length)</pre> |
| <div class="block">Constructs an XMLString structure preset with the specified |
| values.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>ch</code> - The character array.</dd> |
| <dd><code>offset</code> - The offset into the character array.</dd> |
| <dd><code>length</code> - The length of characters from the offset.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="XMLString-org.apache.jasper.xmlparser.XMLString-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>XMLString</h4> |
| <pre>public XMLString(<a href="../../../../org/apache/jasper/xmlparser/XMLString.html" title="class in org.apache.jasper.xmlparser">XMLString</a> string)</pre> |
| <div class="block">Constructs an XMLString structure with copies of the values in |
| the given structure. |
| <p> |
| <strong>Note:</strong> This does not copy the character array; |
| only the reference to the array is copied.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>string</code> - The XMLString to copy.</dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="setValues-char:A-int-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setValues</h4> |
| <pre>public void setValues(char[] ch, |
| int offset, |
| int length)</pre> |
| <div class="block">Initializes the contents of the XMLString structure with the |
| specified values.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>ch</code> - The character array.</dd> |
| <dd><code>offset</code> - The offset into the character array.</dd> |
| <dd><code>length</code> - The length of characters from the offset.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setValues-org.apache.jasper.xmlparser.XMLString-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setValues</h4> |
| <pre>public void setValues(<a href="../../../../org/apache/jasper/xmlparser/XMLString.html" title="class in org.apache.jasper.xmlparser">XMLString</a> s)</pre> |
| <div class="block">Initializes the contents of the XMLString structure with copies |
| of the given string structure. |
| <p> |
| <strong>Note:</strong> This does not copy the character array; |
| only the reference to the array is copied.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>s</code> - </dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="clear--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>clear</h4> |
| <pre>public void clear()</pre> |
| <div class="block">Resets all of the values to their defaults.</div> |
| </li> |
| </ul> |
| <a name="equals-char:A-int-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>equals</h4> |
| <pre>public boolean equals(char[] ch, |
| int offset, |
| int length)</pre> |
| <div class="block">Returns true if the contents of this XMLString structure and |
| the specified array are equal.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>ch</code> - The character array.</dd> |
| <dd><code>offset</code> - The offset into the character array.</dd> |
| <dd><code>length</code> - The length of characters from the offset.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="equals-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>equals</h4> |
| <pre>public boolean equals(java.lang.String s)</pre> |
| <div class="block">Returns true if the contents of this XMLString structure and |
| the specified string are equal.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>s</code> - The string to compare.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="toString--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>toString</h4> |
| <pre>public java.lang.String toString()</pre> |
| <div class="block">Returns a string representation of this object.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code>toString</code> in class <code>java.lang.Object</code></dd> |
| </dl> |
| </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="../../../../org/apache/jasper/xmlparser/XMLEncodingDetector.html" title="class in org.apache.jasper.xmlparser"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/jasper/xmlparser/XMLStringBuffer.html" title="class in org.apache.jasper.xmlparser"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/jasper/xmlparser/XMLString.html" target="_top">Frames</a></li> |
| <li><a href="XMLString.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><a href="#field.summary">Field</a> | </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><a href="#field.detail">Field</a> | </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> |
