Author: remm Date: Tue May 7 18:16:23 2024 New Revision: 1917558 URL: http://svn.apache.org/viewvc?rev=1917558&view=rev Log: Javadoc update for 9.0.89
Added: tomcat/site/trunk/docs/tomcat-9.0-doc/api/org/apache/tomcat/util/http/parser/HttpHeaderParser.HeaderDataSource.html tomcat/site/trunk/docs/tomcat-9.0-doc/api/org/apache/tomcat/util/http/parser/HttpHeaderParser.HeaderParsePosition.html tomcat/site/trunk/docs/tomcat-9.0-doc/api/org/apache/tomcat/util/http/parser/HttpHeaderParser.HeaderParseStatus.html tomcat/site/trunk/docs/tomcat-9.0-doc/api/org/apache/tomcat/util/http/parser/HttpHeaderParser.html Added: tomcat/site/trunk/docs/tomcat-9.0-doc/api/org/apache/tomcat/util/http/parser/HttpHeaderParser.HeaderDataSource.html URL: http://svn.apache.org/viewvc/tomcat/site/trunk/docs/tomcat-9.0-doc/api/org/apache/tomcat/util/http/parser/HttpHeaderParser.HeaderDataSource.html?rev=1917558&view=auto ============================================================================== --- tomcat/site/trunk/docs/tomcat-9.0-doc/api/org/apache/tomcat/util/http/parser/HttpHeaderParser.HeaderDataSource.html (added) +++ tomcat/site/trunk/docs/tomcat-9.0-doc/api/org/apache/tomcat/util/http/parser/HttpHeaderParser.HeaderDataSource.html Tue May 7 18:16:23 2024 @@ -0,0 +1,164 @@ +<!DOCTYPE HTML> +<html lang="en"> +<head> +<!-- Generated by javadoc (17) --> +<title>HttpHeaderParser.HeaderDataSource (Apache Tomcat 9.0.89 API Documentation)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="declaration: package: org.apache.tomcat.util.http.parser, class: HttpHeaderParser, interface: HeaderDataSource"> +<meta name="generator" content="javadoc/ClassWriterImpl"> +<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../../script-dir/jquery-3.6.1.min.js"></script> +<script type="text/javascript" src="../../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-declaration-page"> +<script type="text/javascript">var evenRowColor = "even-row-color"; +var oddRowColor = "odd-row-color"; +var tableTab = "table-tab"; +var activeTableTab = "active-table-tab"; +var pathtoroot = "../../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<div class="about-language"><b>Apache Tomcat<sup>®</sup> 9.0.89</b></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="nav-bar-cell1-rev">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#class">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div> +<ul class="sub-nav-list"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method-summary">Method</a></li> +</ul> +<ul class="sub-nav-list"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method-detail">Method</a></li> +</ul> +</div> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.tomcat.util.http.parser</a></div> +<h1 title="Interface HttpHeaderParser.HeaderDataSource" class="title">Interface HttpHeaderParser.HeaderDataSource</h1> +</div> +<section class="class-description" id="class-description"> +<dl class="notes"> +<dt>All Known Implementing Classes:</dt> +<dd><code><a href="../../../../coyote/http11/filters/ChunkedInputFilter.html" title="class in org.apache.coyote.http11.filters">ChunkedInputFilter</a></code></dd> +</dl> +<dl class="notes"> +<dt>Enclosing class:</dt> +<dd><a href="HttpHeaderParser.html" title="class in org.apache.tomcat.util.http.parser">HttpHeaderParser</a></dd> +</dl> +<hr> +<div class="type-signature"><span class="modifiers">public static interface </span><span class="element-name type-name-label">HttpHeaderParser.HeaderDataSource</span></div> +</section> +<section class="summary"> +<ul class="summary-list"> +<!-- ========== METHOD SUMMARY =========== --> +<li> +<section class="method-summary" id="method-summary"> +<h2>Method Summary</h2> +<div id="method-summary-table"> +<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab3" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab3', 3)" class="table-tab">Abstract Methods</button></div> +<div id="method-summary-table.tabpanel" role="tabpanel"> +<div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>boolean</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#fillHeaderBuffer()" class="member-name-link">fillHeaderBuffer</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> +<div class="block">Read more data into the header buffer.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/nio/ByteBuffer.html" title="class or interface in java.nio" class="external-link">ByteBuffer</a></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getHeaderByteBuffer()" class="member-name-link">getHeaderByteBuffer</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> +<div class="block">Obtain a reference to the buffer containing the header data.</div> +</div> +</div> +</div> +</div> +</section> +</li> +</ul> +</section> +<section class="details"> +<ul class="details-list"> +<!-- ============ METHOD DETAIL ========== --> +<li> +<section class="method-details" id="method-detail"> +<h2>Method Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="fillHeaderBuffer()"> +<h3>fillHeaderBuffer</h3> +<div class="member-signature"><span class="return-type">boolean</span> <span class="element-name">fillHeaderBuffer</span>() + throws <span class="exceptions"><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></span></div> +<div class="block">Read more data into the header buffer. The implementation is expected to determine if blocking or not + blocking IO should be used.</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd><code>true</code> if more data was added to the buffer, otherwise <code>false</code></dd> +<dt>Throws:</dt> +<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code> - If an I/O error occurred while obtaining more header data</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getHeaderByteBuffer()"> +<h3>getHeaderByteBuffer</h3> +<div class="member-signature"><span class="return-type"><a href="https://docs.oracle.com/javase/8/docs/api/java/nio/ByteBuffer.html" title="class or interface in java.nio" class="external-link">ByteBuffer</a></span> <span class="element-name">getHeaderByteBuffer</span>()</div> +<div class="block">Obtain a reference to the buffer containing the header data.</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>The buffer containing the header data</dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +</ul> +</section> +<!-- ========= END OF CLASS DATA ========= --> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2000-2024 Apache Software Foundation. <br/> Apache Tomcat, Tomcat, Apache, the Apache Tomcat logo and the Apache logo are either registered trademarks or trademarks of the Apache Software Foundation.</small></p> +</footer> +</div> +</div> +</body> +</html> Added: tomcat/site/trunk/docs/tomcat-9.0-doc/api/org/apache/tomcat/util/http/parser/HttpHeaderParser.HeaderParsePosition.html URL: http://svn.apache.org/viewvc/tomcat/site/trunk/docs/tomcat-9.0-doc/api/org/apache/tomcat/util/http/parser/HttpHeaderParser.HeaderParsePosition.html?rev=1917558&view=auto ============================================================================== --- tomcat/site/trunk/docs/tomcat-9.0-doc/api/org/apache/tomcat/util/http/parser/HttpHeaderParser.HeaderParsePosition.html (added) +++ tomcat/site/trunk/docs/tomcat-9.0-doc/api/org/apache/tomcat/util/http/parser/HttpHeaderParser.HeaderParsePosition.html Tue May 7 18:16:23 2024 @@ -0,0 +1,285 @@ +<!DOCTYPE HTML> +<html lang="en"> +<head> +<!-- Generated by javadoc (17) --> +<title>HttpHeaderParser.HeaderParsePosition (Apache Tomcat 9.0.89 API Documentation)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="declaration: package: org.apache.tomcat.util.http.parser, class: HttpHeaderParser, enum: HeaderParsePosition"> +<meta name="generator" content="javadoc/ClassWriterImpl"> +<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../../script-dir/jquery-3.6.1.min.js"></script> +<script type="text/javascript" src="../../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-declaration-page"> +<script type="text/javascript">var evenRowColor = "even-row-color"; +var oddRowColor = "odd-row-color"; +var tableTab = "table-tab"; +var activeTableTab = "active-table-tab"; +var pathtoroot = "../../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<div class="about-language"><b>Apache Tomcat<sup>®</sup> 9.0.89</b></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="nav-bar-cell1-rev">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#class">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div> +<ul class="sub-nav-list"> +<li>Summary: </li> +<li><a href="#nested-class-summary">Nested</a> | </li> +<li><a href="#enum-constant-summary">Enum Constants</a> | </li> +<li>Field | </li> +<li><a href="#method-summary">Method</a></li> +</ul> +<ul class="sub-nav-list"> +<li>Detail: </li> +<li><a href="#enum-constant-detail">Enum Constants</a> | </li> +<li>Field | </li> +<li><a href="#method-detail">Method</a></li> +</ul> +</div> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.tomcat.util.http.parser</a></div> +<h1 title="Enum HttpHeaderParser.HeaderParsePosition" class="title">Enum HttpHeaderParser.HeaderParsePosition</h1> +</div> +<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> +<div class="inheritance"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html" title="class or interface in java.lang" class="external-link">java.lang.Enum</a><<a href="HttpHeaderParser.HeaderParsePosition.html" title="enum in org.apache.tomcat.util.http.parser">HttpHeaderParser.HeaderParsePosition</a>> +<div class="inheritance">org.apache.tomcat.util.http.parser.HttpHeaderParser.HeaderParsePosition</div> +</div> +</div> +<section class="class-description" id="class-description"> +<dl class="notes"> +<dt>All Implemented Interfaces:</dt> +<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html" title="class or interface in java.io" class="external-link">Serializable</a></code>, <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Comparable.html" title="class or interface in java.lang" class="external-link">Comparable</a><<a href="HttpHeaderParser.HeaderParsePosition.html" title="enum in org.apache.tomcat.util.http.parser">HttpHeaderParser.HeaderParsePosition</a>></code>, <code>java.lang.constant.Constable</code></dd> +</dl> +<dl class="notes"> +<dt>Enclosing class:</dt> +<dd><a href="HttpHeaderParser.html" title="class in org.apache.tomcat.util.http.parser">HttpHeaderParser</a></dd> +</dl> +<hr> +<div class="type-signature"><span class="modifiers">public static enum </span><span class="element-name type-name-label">HttpHeaderParser.HeaderParsePosition</span> +<span class="extends-implements">extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html" title="class or interface in java.lang" class="external-link">Enum</a><<a href="HttpHeaderParser.HeaderParsePosition.html" title="enum in org.apache.tomcat.util.http.parser">HttpHeaderParser.HeaderParsePosition</a>></span></div> +</section> +<section class="summary"> +<ul class="summary-list"> +<!-- ======== NESTED CLASS SUMMARY ======== --> +<li> +<section class="nested-class-summary" id="nested-class-summary"> +<h2>Nested Class Summary</h2> +<div class="inherited-list"> +<h2 id="nested-classes-inherited-from-class-java.lang.Enum">Nested classes/interfaces inherited from class java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html" title="class or interface in java.lang" class="external-link">Enum</a></h2> +<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.EnumDesc.html" title="class or interface in java.lang" class="external-link">Enum.EnumDesc</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.EnumDesc.html" title="class or interface in java.lang" class="external-link">E</a> extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html" title="class or interface in java.lang" class="external-link">Enum</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.EnumDesc.html" title="class or interface in java.lang" class="external-link">E</a>>></code></div> +</section> +</li> +<!-- =========== ENUM CONSTANT SUMMARY =========== --> +<li> +<section class="constants-summary" id="enum-constant-summary"> +<h2>Enum Constant Summary</h2> +<div class="caption"><span>Enum Constants</span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Enum Constant</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code><a href="#HEADER_MULTI_LINE" class="member-name-link">HEADER_MULTI_LINE</a></code></div> +<div class="col-last even-row-color"> +<div class="block">Before reading a new line of a header.</div> +</div> +<div class="col-first odd-row-color"><code><a href="#HEADER_NAME" class="member-name-link">HEADER_NAME</a></code></div> +<div class="col-last odd-row-color"> +<div class="block">Reading a header name.</div> +</div> +<div class="col-first even-row-color"><code><a href="#HEADER_SKIPLINE" class="member-name-link">HEADER_SKIPLINE</a></code></div> +<div class="col-last even-row-color"> +<div class="block">Reading all bytes until the next CRLF.</div> +</div> +<div class="col-first odd-row-color"><code><a href="#HEADER_START" class="member-name-link">HEADER_START</a></code></div> +<div class="col-last odd-row-color"> +<div class="block">Start of a new header.</div> +</div> +<div class="col-first even-row-color"><code><a href="#HEADER_VALUE" class="member-name-link">HEADER_VALUE</a></code></div> +<div class="col-last even-row-color"> +<div class="block">Reading the header value.</div> +</div> +<div class="col-first odd-row-color"><code><a href="#HEADER_VALUE_START" class="member-name-link">HEADER_VALUE_START</a></code></div> +<div class="col-last odd-row-color"> +<div class="block">Skipping whitespace before text of header value starts, either on the first line of header value (just after + ':') or on subsequent lines when it is known that subsequent line starts with SP or HT.</div> +</div> +</div> +</section> +</li> +<!-- ========== METHOD SUMMARY =========== --> +<li> +<section class="method-summary" id="method-summary"> +<h2>Method Summary</h2> +<div id="method-summary-table"> +<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> +<div id="method-summary-table.tabpanel" role="tabpanel"> +<div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="HttpHeaderParser.HeaderParsePosition.html" title="enum in org.apache.tomcat.util.http.parser">HttpHeaderParser.HeaderParsePosition</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#valueOf(java.lang.String)" class="member-name-link">valueOf</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Returns the enum constant of this type with the specified name.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="HttpHeaderParser.HeaderParsePosition.html" title="enum in org.apache.tomcat.util.http.parser">HttpHeaderParser.HeaderParsePosition</a>[]</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#values()" class="member-name-link">values</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Returns an array containing the constants of this enum type, in +the order they are declared.</div> +</div> +</div> +</div> +</div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-java.lang.Enum">Methods inherited from class java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html" title="class or interface in java.lang" class="external-link">Enum</a></h3> +<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html#clone--" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html#compareTo-E-" title="class or interface in java.lang" class="external-link">compareTo</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html#describeConstable--" title="class or interface in java.lang" class="external-link">describeConstable</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html#equals-java.lang.Object-" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html#finalize--" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html#getDeclaringClass--" title="class or interface in java.lang" class="external-link">getDeclaringCla ss</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html#hashCode--" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html#name--" title="class or interface in java.lang" class="external-link">name</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html#ordinal--" title="class or interface in java.lang" class="external-link">ordinal</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html#toString--" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html#valueOf-java.lang.Class-java.lang.String-" title="class or interface in java.lang" class="external-link">valueOf</a></code></div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> +<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-" title="class or interface in java.lang" class="external-link">wait</a></code></div> +</section> +</li> +</ul> +</section> +<section class="details"> +<ul class="details-list"> +<!-- ============ ENUM CONSTANT DETAIL =========== --> +<li> +<section class="constant-details" id="enum-constant-detail"> +<h2>Enum Constant Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="HEADER_START"> +<h3>HEADER_START</h3> +<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="HttpHeaderParser.HeaderParsePosition.html" title="enum in org.apache.tomcat.util.http.parser">HttpHeaderParser.HeaderParsePosition</a></span> <span class="element-name">HEADER_START</span></div> +<div class="block">Start of a new header. A CRLF here means that there are no more headers. Any other character starts a header + name.</div> +</section> +</li> +<li> +<section class="detail" id="HEADER_NAME"> +<h3>HEADER_NAME</h3> +<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="HttpHeaderParser.HeaderParsePosition.html" title="enum in org.apache.tomcat.util.http.parser">HttpHeaderParser.HeaderParsePosition</a></span> <span class="element-name">HEADER_NAME</span></div> +<div class="block">Reading a header name. All characters of header are HTTP_TOKEN_CHAR. Header name is followed by ':'. No + whitespace is allowed.<br> + Any non-HTTP_TOKEN_CHAR (this includes any whitespace) encountered before ':' will result in the whole line + being ignored.</div> +</section> +</li> +<li> +<section class="detail" id="HEADER_VALUE_START"> +<h3>HEADER_VALUE_START</h3> +<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="HttpHeaderParser.HeaderParsePosition.html" title="enum in org.apache.tomcat.util.http.parser">HttpHeaderParser.HeaderParsePosition</a></span> <span class="element-name">HEADER_VALUE_START</span></div> +<div class="block">Skipping whitespace before text of header value starts, either on the first line of header value (just after + ':') or on subsequent lines when it is known that subsequent line starts with SP or HT.</div> +</section> +</li> +<li> +<section class="detail" id="HEADER_VALUE"> +<h3>HEADER_VALUE</h3> +<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="HttpHeaderParser.HeaderParsePosition.html" title="enum in org.apache.tomcat.util.http.parser">HttpHeaderParser.HeaderParsePosition</a></span> <span class="element-name">HEADER_VALUE</span></div> +<div class="block">Reading the header value. We are inside the value. Either on the first line or on any subsequent line. We + come into this state from HEADER_VALUE_START after the first non-SP/non-HT byte is encountered on the line.</div> +</section> +</li> +<li> +<section class="detail" id="HEADER_MULTI_LINE"> +<h3>HEADER_MULTI_LINE</h3> +<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="HttpHeaderParser.HeaderParsePosition.html" title="enum in org.apache.tomcat.util.http.parser">HttpHeaderParser.HeaderParsePosition</a></span> <span class="element-name">HEADER_MULTI_LINE</span></div> +<div class="block">Before reading a new line of a header. Once the next byte is peeked, the state changes without advancing our + position. The state becomes either HEADER_VALUE_START (if that first byte is SP or HT), or HEADER_START + (otherwise).</div> +</section> +</li> +<li> +<section class="detail" id="HEADER_SKIPLINE"> +<h3>HEADER_SKIPLINE</h3> +<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="HttpHeaderParser.HeaderParsePosition.html" title="enum in org.apache.tomcat.util.http.parser">HttpHeaderParser.HeaderParsePosition</a></span> <span class="element-name">HEADER_SKIPLINE</span></div> +<div class="block">Reading all bytes until the next CRLF. The line is being ignored.</div> +</section> +</li> +</ul> +</section> +</li> +<!-- ============ METHOD DETAIL ========== --> +<li> +<section class="method-details" id="method-detail"> +<h2>Method Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="values()"> +<h3>values</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="HttpHeaderParser.HeaderParsePosition.html" title="enum in org.apache.tomcat.util.http.parser">HttpHeaderParser.HeaderParsePosition</a>[]</span> <span class="element-name">values</span>()</div> +<div class="block">Returns an array containing the constants of this enum type, in +the order they are declared.</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>an array containing the constants of this enum type, in the order they are declared</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="valueOf(java.lang.String)"> +<h3>valueOf</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="HttpHeaderParser.HeaderParsePosition.html" title="enum in org.apache.tomcat.util.http.parser">HttpHeaderParser.HeaderParsePosition</a></span> <span class="element-name">valueOf</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name)</span></div> +<div class="block">Returns the enum constant of this type with the specified name. +The string must match <i>exactly</i> an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>name</code> - the name of the enum constant to be returned.</dd> +<dt>Returns:</dt> +<dd>the enum constant with the specified name</dd> +<dt>Throws:</dt> +<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - if this enum type has no constant with the specified name</dd> +<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/NullPointerException.html" title="class or interface in java.lang" class="external-link">NullPointerException</a></code> - if the argument is null</dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +</ul> +</section> +<!-- ========= END OF CLASS DATA ========= --> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2000-2024 Apache Software Foundation. <br/> Apache Tomcat, Tomcat, Apache, the Apache Tomcat logo and the Apache logo are either registered trademarks or trademarks of the Apache Software Foundation.</small></p> +</footer> +</div> +</div> +</body> +</html> Added: tomcat/site/trunk/docs/tomcat-9.0-doc/api/org/apache/tomcat/util/http/parser/HttpHeaderParser.HeaderParseStatus.html URL: http://svn.apache.org/viewvc/tomcat/site/trunk/docs/tomcat-9.0-doc/api/org/apache/tomcat/util/http/parser/HttpHeaderParser.HeaderParseStatus.html?rev=1917558&view=auto ============================================================================== --- tomcat/site/trunk/docs/tomcat-9.0-doc/api/org/apache/tomcat/util/http/parser/HttpHeaderParser.HeaderParseStatus.html (added) +++ tomcat/site/trunk/docs/tomcat-9.0-doc/api/org/apache/tomcat/util/http/parser/HttpHeaderParser.HeaderParseStatus.html Tue May 7 18:16:23 2024 @@ -0,0 +1,234 @@ +<!DOCTYPE HTML> +<html lang="en"> +<head> +<!-- Generated by javadoc (17) --> +<title>HttpHeaderParser.HeaderParseStatus (Apache Tomcat 9.0.89 API Documentation)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="declaration: package: org.apache.tomcat.util.http.parser, class: HttpHeaderParser, enum: HeaderParseStatus"> +<meta name="generator" content="javadoc/ClassWriterImpl"> +<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../../script-dir/jquery-3.6.1.min.js"></script> +<script type="text/javascript" src="../../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-declaration-page"> +<script type="text/javascript">var evenRowColor = "even-row-color"; +var oddRowColor = "odd-row-color"; +var tableTab = "table-tab"; +var activeTableTab = "active-table-tab"; +var pathtoroot = "../../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<div class="about-language"><b>Apache Tomcat<sup>®</sup> 9.0.89</b></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="nav-bar-cell1-rev">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#class">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div> +<ul class="sub-nav-list"> +<li>Summary: </li> +<li><a href="#nested-class-summary">Nested</a> | </li> +<li><a href="#enum-constant-summary">Enum Constants</a> | </li> +<li>Field | </li> +<li><a href="#method-summary">Method</a></li> +</ul> +<ul class="sub-nav-list"> +<li>Detail: </li> +<li><a href="#enum-constant-detail">Enum Constants</a> | </li> +<li>Field | </li> +<li><a href="#method-detail">Method</a></li> +</ul> +</div> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.tomcat.util.http.parser</a></div> +<h1 title="Enum HttpHeaderParser.HeaderParseStatus" class="title">Enum HttpHeaderParser.HeaderParseStatus</h1> +</div> +<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> +<div class="inheritance"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html" title="class or interface in java.lang" class="external-link">java.lang.Enum</a><<a href="HttpHeaderParser.HeaderParseStatus.html" title="enum in org.apache.tomcat.util.http.parser">HttpHeaderParser.HeaderParseStatus</a>> +<div class="inheritance">org.apache.tomcat.util.http.parser.HttpHeaderParser.HeaderParseStatus</div> +</div> +</div> +<section class="class-description" id="class-description"> +<dl class="notes"> +<dt>All Implemented Interfaces:</dt> +<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html" title="class or interface in java.io" class="external-link">Serializable</a></code>, <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Comparable.html" title="class or interface in java.lang" class="external-link">Comparable</a><<a href="HttpHeaderParser.HeaderParseStatus.html" title="enum in org.apache.tomcat.util.http.parser">HttpHeaderParser.HeaderParseStatus</a>></code>, <code>java.lang.constant.Constable</code></dd> +</dl> +<dl class="notes"> +<dt>Enclosing class:</dt> +<dd><a href="HttpHeaderParser.html" title="class in org.apache.tomcat.util.http.parser">HttpHeaderParser</a></dd> +</dl> +<hr> +<div class="type-signature"><span class="modifiers">public static enum </span><span class="element-name type-name-label">HttpHeaderParser.HeaderParseStatus</span> +<span class="extends-implements">extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html" title="class or interface in java.lang" class="external-link">Enum</a><<a href="HttpHeaderParser.HeaderParseStatus.html" title="enum in org.apache.tomcat.util.http.parser">HttpHeaderParser.HeaderParseStatus</a>></span></div> +</section> +<section class="summary"> +<ul class="summary-list"> +<!-- ======== NESTED CLASS SUMMARY ======== --> +<li> +<section class="nested-class-summary" id="nested-class-summary"> +<h2>Nested Class Summary</h2> +<div class="inherited-list"> +<h2 id="nested-classes-inherited-from-class-java.lang.Enum">Nested classes/interfaces inherited from class java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html" title="class or interface in java.lang" class="external-link">Enum</a></h2> +<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.EnumDesc.html" title="class or interface in java.lang" class="external-link">Enum.EnumDesc</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.EnumDesc.html" title="class or interface in java.lang" class="external-link">E</a> extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html" title="class or interface in java.lang" class="external-link">Enum</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.EnumDesc.html" title="class or interface in java.lang" class="external-link">E</a>>></code></div> +</section> +</li> +<!-- =========== ENUM CONSTANT SUMMARY =========== --> +<li> +<section class="constants-summary" id="enum-constant-summary"> +<h2>Enum Constant Summary</h2> +<div class="caption"><span>Enum Constants</span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Enum Constant</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code><a href="#DONE" class="member-name-link">DONE</a></code></div> +<div class="col-last even-row-color"> </div> +<div class="col-first odd-row-color"><code><a href="#HAVE_MORE_HEADERS" class="member-name-link">HAVE_MORE_HEADERS</a></code></div> +<div class="col-last odd-row-color"> </div> +<div class="col-first even-row-color"><code><a href="#NEED_MORE_DATA" class="member-name-link">NEED_MORE_DATA</a></code></div> +<div class="col-last even-row-color"> </div> +</div> +</section> +</li> +<!-- ========== METHOD SUMMARY =========== --> +<li> +<section class="method-summary" id="method-summary"> +<h2>Method Summary</h2> +<div id="method-summary-table"> +<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> +<div id="method-summary-table.tabpanel" role="tabpanel"> +<div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="HttpHeaderParser.HeaderParseStatus.html" title="enum in org.apache.tomcat.util.http.parser">HttpHeaderParser.HeaderParseStatus</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#valueOf(java.lang.String)" class="member-name-link">valueOf</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Returns the enum constant of this type with the specified name.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="HttpHeaderParser.HeaderParseStatus.html" title="enum in org.apache.tomcat.util.http.parser">HttpHeaderParser.HeaderParseStatus</a>[]</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#values()" class="member-name-link">values</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> +<div class="block">Returns an array containing the constants of this enum type, in +the order they are declared.</div> +</div> +</div> +</div> +</div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-java.lang.Enum">Methods inherited from class java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html" title="class or interface in java.lang" class="external-link">Enum</a></h3> +<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html#clone--" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html#compareTo-E-" title="class or interface in java.lang" class="external-link">compareTo</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html#describeConstable--" title="class or interface in java.lang" class="external-link">describeConstable</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html#equals-java.lang.Object-" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html#finalize--" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html#getDeclaringClass--" title="class or interface in java.lang" class="external-link">getDeclaringCla ss</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html#hashCode--" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html#name--" title="class or interface in java.lang" class="external-link">name</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html#ordinal--" title="class or interface in java.lang" class="external-link">ordinal</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html#toString--" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html#valueOf-java.lang.Class-java.lang.String-" title="class or interface in java.lang" class="external-link">valueOf</a></code></div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> +<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-" title="class or interface in java.lang" class="external-link">wait</a></code></div> +</section> +</li> +</ul> +</section> +<section class="details"> +<ul class="details-list"> +<!-- ============ ENUM CONSTANT DETAIL =========== --> +<li> +<section class="constant-details" id="enum-constant-detail"> +<h2>Enum Constant Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="DONE"> +<h3>DONE</h3> +<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="HttpHeaderParser.HeaderParseStatus.html" title="enum in org.apache.tomcat.util.http.parser">HttpHeaderParser.HeaderParseStatus</a></span> <span class="element-name">DONE</span></div> +</section> +</li> +<li> +<section class="detail" id="HAVE_MORE_HEADERS"> +<h3>HAVE_MORE_HEADERS</h3> +<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="HttpHeaderParser.HeaderParseStatus.html" title="enum in org.apache.tomcat.util.http.parser">HttpHeaderParser.HeaderParseStatus</a></span> <span class="element-name">HAVE_MORE_HEADERS</span></div> +</section> +</li> +<li> +<section class="detail" id="NEED_MORE_DATA"> +<h3>NEED_MORE_DATA</h3> +<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="HttpHeaderParser.HeaderParseStatus.html" title="enum in org.apache.tomcat.util.http.parser">HttpHeaderParser.HeaderParseStatus</a></span> <span class="element-name">NEED_MORE_DATA</span></div> +</section> +</li> +</ul> +</section> +</li> +<!-- ============ METHOD DETAIL ========== --> +<li> +<section class="method-details" id="method-detail"> +<h2>Method Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="values()"> +<h3>values</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="HttpHeaderParser.HeaderParseStatus.html" title="enum in org.apache.tomcat.util.http.parser">HttpHeaderParser.HeaderParseStatus</a>[]</span> <span class="element-name">values</span>()</div> +<div class="block">Returns an array containing the constants of this enum type, in +the order they are declared.</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>an array containing the constants of this enum type, in the order they are declared</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="valueOf(java.lang.String)"> +<h3>valueOf</h3> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="HttpHeaderParser.HeaderParseStatus.html" title="enum in org.apache.tomcat.util.http.parser">HttpHeaderParser.HeaderParseStatus</a></span> <span class="element-name">valueOf</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name)</span></div> +<div class="block">Returns the enum constant of this type with the specified name. +The string must match <i>exactly</i> an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>name</code> - the name of the enum constant to be returned.</dd> +<dt>Returns:</dt> +<dd>the enum constant with the specified name</dd> +<dt>Throws:</dt> +<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - if this enum type has no constant with the specified name</dd> +<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/NullPointerException.html" title="class or interface in java.lang" class="external-link">NullPointerException</a></code> - if the argument is null</dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +</ul> +</section> +<!-- ========= END OF CLASS DATA ========= --> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2000-2024 Apache Software Foundation. <br/> Apache Tomcat, Tomcat, Apache, the Apache Tomcat logo and the Apache logo are either registered trademarks or trademarks of the Apache Software Foundation.</small></p> +</footer> +</div> +</div> +</body> +</html> Added: tomcat/site/trunk/docs/tomcat-9.0-doc/api/org/apache/tomcat/util/http/parser/HttpHeaderParser.html URL: http://svn.apache.org/viewvc/tomcat/site/trunk/docs/tomcat-9.0-doc/api/org/apache/tomcat/util/http/parser/HttpHeaderParser.html?rev=1917558&view=auto ============================================================================== --- tomcat/site/trunk/docs/tomcat-9.0-doc/api/org/apache/tomcat/util/http/parser/HttpHeaderParser.html (added) +++ tomcat/site/trunk/docs/tomcat-9.0-doc/api/org/apache/tomcat/util/http/parser/HttpHeaderParser.html Tue May 7 18:16:23 2024 @@ -0,0 +1,208 @@ +<!DOCTYPE HTML> +<html lang="en"> +<head> +<!-- Generated by javadoc (17) --> +<title>HttpHeaderParser (Apache Tomcat 9.0.89 API Documentation)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta name="description" content="declaration: package: org.apache.tomcat.util.http.parser, class: HttpHeaderParser"> +<meta name="generator" content="javadoc/ClassWriterImpl"> +<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../../script-dir/jquery-3.6.1.min.js"></script> +<script type="text/javascript" src="../../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-declaration-page"> +<script type="text/javascript">var evenRowColor = "even-row-color"; +var oddRowColor = "odd-row-color"; +var tableTab = "table-tab"; +var activeTableTab = "active-table-tab"; +var pathtoroot = "../../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<div class="about-language"><b>Apache Tomcat<sup>®</sup> 9.0.89</b></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="nav-bar-cell1-rev">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#class">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div> +<ul class="sub-nav-list"> +<li>Summary: </li> +<li><a href="#nested-class-summary">Nested</a> | </li> +<li>Field | </li> +<li><a href="#constructor-summary">Constr</a> | </li> +<li><a href="#method-summary">Method</a></li> +</ul> +<ul class="sub-nav-list"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor-detail">Constr</a> | </li> +<li><a href="#method-detail">Method</a></li> +</ul> +</div> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.tomcat.util.http.parser</a></div> +<h1 title="Class HttpHeaderParser" class="title">Class HttpHeaderParser</h1> +</div> +<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> +<div class="inheritance">org.apache.tomcat.util.http.parser.HttpHeaderParser</div> +</div> +<section class="class-description" id="class-description"> +<hr> +<div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">HttpHeaderParser</span> +<span class="extends-implements">extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></span></div> +</section> +<section class="summary"> +<ul class="summary-list"> +<!-- ======== NESTED CLASS SUMMARY ======== --> +<li> +<section class="nested-class-summary" id="nested-class-summary"> +<h2>Nested Class Summary</h2> +<div class="caption"><span>Nested Classes</span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Class</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code>static interface </code></div> +<div class="col-second even-row-color"><code><a href="HttpHeaderParser.HeaderDataSource.html" class="type-name-link" title="interface in org.apache.tomcat.util.http.parser">HttpHeaderParser.HeaderDataSource</a></code></div> +<div class="col-last even-row-color"> </div> +<div class="col-first odd-row-color"><code>static enum </code></div> +<div class="col-second odd-row-color"><code><a href="HttpHeaderParser.HeaderParsePosition.html" class="type-name-link" title="enum in org.apache.tomcat.util.http.parser">HttpHeaderParser.HeaderParsePosition</a></code></div> +<div class="col-last odd-row-color"> </div> +<div class="col-first even-row-color"><code>static enum </code></div> +<div class="col-second even-row-color"><code><a href="HttpHeaderParser.HeaderParseStatus.html" class="type-name-link" title="enum in org.apache.tomcat.util.http.parser">HttpHeaderParser.HeaderParseStatus</a></code></div> +<div class="col-last even-row-color"> </div> +</div> +</section> +</li> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<li> +<section class="constructor-summary" id="constructor-summary"> +<h2>Constructor Summary</h2> +<div class="caption"><span>Constructors</span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Constructor</div> +<div class="table-header col-last">Description</div> +<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(org.apache.tomcat.util.http.parser.HttpHeaderParser.HeaderDataSource,org.apache.tomcat.util.http.MimeHeaders,boolean)" class="member-name-link">HttpHeaderParser</a><wbr>(<a href="HttpHeaderParser.HeaderDataSource.html" title="interface in org.apache.tomcat.util.http.parser">HttpHeaderParser.HeaderDataSource</a> source, + <a href="../MimeHeaders.html" title="class in org.apache.tomcat.util.http">MimeHeaders</a> headers, + boolean tolerantEol)</code></div> +<div class="col-last even-row-color"> </div> +</div> +</section> +</li> +<!-- ========== METHOD SUMMARY =========== --> +<li> +<section class="method-summary" id="method-summary"> +<h2>Method Summary</h2> +<div id="method-summary-table"> +<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> +<div id="method-summary-table.tabpanel" role="tabpanel"> +<div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="HttpHeaderParser.HeaderParseStatus.html" title="enum in org.apache.tomcat.util.http.parser">HttpHeaderParser.HeaderParseStatus</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#parseHeader()" class="member-name-link">parseHeader</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Parse an HTTP header.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#recycle()" class="member-name-link">recycle</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> +</div> +</div> +</div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> +<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.o racle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-" title="class or interface in java.lang" class="external-link">wait</a></code></div> +</section> +</li> +</ul> +</section> +<section class="details"> +<ul class="details-list"> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<li> +<section class="constructor-details" id="constructor-detail"> +<h2>Constructor Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="<init>(org.apache.tomcat.util.http.parser.HttpHeaderParser.HeaderDataSource,org.apache.tomcat.util.http.MimeHeaders,boolean)"> +<h3>HttpHeaderParser</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">HttpHeaderParser</span><wbr><span class="parameters">(<a href="HttpHeaderParser.HeaderDataSource.html" title="interface in org.apache.tomcat.util.http.parser">HttpHeaderParser.HeaderDataSource</a> source, + <a href="../MimeHeaders.html" title="class in org.apache.tomcat.util.http">MimeHeaders</a> headers, + boolean tolerantEol)</span></div> +</section> +</li> +</ul> +</section> +</li> +<!-- ============ METHOD DETAIL ========== --> +<li> +<section class="method-details" id="method-detail"> +<h2>Method Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="recycle()"> +<h3>recycle</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">recycle</span>()</div> +</section> +</li> +<li> +<section class="detail" id="parseHeader()"> +<h3>parseHeader</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="HttpHeaderParser.HeaderParseStatus.html" title="enum in org.apache.tomcat.util.http.parser">HttpHeaderParser.HeaderParseStatus</a></span> <span class="element-name">parseHeader</span>() + throws <span class="exceptions"><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></span></div> +<div class="block">Parse an HTTP header.</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>One of <a href="HttpHeaderParser.HeaderParseStatus.html#NEED_MORE_DATA"><code>HttpHeaderParser.HeaderParseStatus.NEED_MORE_DATA</code></a>, <a href="HttpHeaderParser.HeaderParseStatus.html#HAVE_MORE_HEADERS"><code>HttpHeaderParser.HeaderParseStatus.HAVE_MORE_HEADERS</code></a> or + <a href="HttpHeaderParser.HeaderParseStatus.html#DONE"><code>HttpHeaderParser.HeaderParseStatus.DONE</code></a>.</dd> +<dt>Throws:</dt> +<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code> - If an error occurs during the parsing of the headers</dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +</ul> +</section> +<!-- ========= END OF CLASS DATA ========= --> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2000-2024 Apache Software Foundation. <br/> Apache Tomcat, Tomcat, Apache, the Apache Tomcat logo and the Apache logo are either registered trademarks or trademarks of the Apache Software Foundation.</small></p> +</footer> +</div> +</div> +</body> +</html> --------------------------------------------------------------------- To unsubscribe, e-mail: dev-unsubscr...@tomcat.apache.org For additional commands, e-mail: dev-h...@tomcat.apache.org