309185 - Fix the over 300 Javadoc warnings

git-svn-id: svn+ssh://dev.eclipse.org/svnroot/rt/org.eclipse.jetty/jetty/trunk@1623 7e9141cc-0065-0410-87d8-b60c137991c4
This commit is contained in:
Joakim Erdfelt 2010-04-29 20:04:02 +00:00
parent dffed8cef7
commit b6aba1ceae
36 changed files with 153 additions and 184 deletions

View File

@ -121,7 +121,7 @@ import javax.servlet.ServletResponseWrapper;
* <h1>Continuation Timeout</h1>
* <p>
* If a continuation is suspended, but neither {@link #complete()} or {@link #resume()} is
* called during the period set by {@link #setTimeout(long)}, then the continuation will
* called during the period set by {@link #setTimeout()}, then the continuation will
* expire and {@link #isExpired()} will return true.
* </p>
* <p>
@ -241,7 +241,7 @@ public interface Continuation
* </p>
* <p>
* If resume is called before a suspended request is returned to the
* container (ie the thread that called {@link #suspend(long)} is still
* container (ie the thread that called {@link #suspend()} is still
* within the filter chain and/or servlet service method), then the resume
* does not take effect until the call to the filter chain and/or servlet
* returns to the container. In this case both {@link #isSuspended()} and
@ -254,7 +254,7 @@ public interface Continuation
* had been passed a wrapped response.
* </p>
*
* @see {@link #suspend()}
* @see #suspend()
* @exception IllegalStateException if the request is not suspended.
*
*/
@ -267,12 +267,12 @@ public interface Continuation
* <p>
* This method can be called by any thread that has been passed a reference
* to a suspended request. When a request is completed, the associated
* response object commited and flushed. The request is not redispatched.
* response object committed and flushed. The request is not redispatched.
* </p>
*
* <p>
* If complete is called before a suspended request is returned to the
* container (ie the thread that called {@link #suspend(long)} is still
* container (ie the thread that called {@link #suspend()} is still
* within the filter chain and/or servlet service method), then the complete
* does not take effect until the call to the filter chain and/or servlet
* returns to the container. In this case both {@link #isSuspended()} and
@ -295,7 +295,7 @@ public interface Continuation
* not valid hold a request or continuation reference after the end of the
* life cycle.
*
* @see {@link #suspend()}
* @see #suspend()
* @exception IllegalStateException
* if the request is not suspended.
*
@ -304,7 +304,7 @@ public interface Continuation
/* ------------------------------------------------------------ */
/**
* @return true after {@link #suspend(long)} has been called and before the
* @return true after {@link #suspend()} has been called and before the
* request has been redispatched due to being resumed, completed or
* timed out.
*/

View File

@ -147,10 +147,10 @@ public class ContinuationSupport
/* ------------------------------------------------------------ */
/**
* @param request
* @param response
* @param request the servlet request
* @param response the servlet response
* @deprecated use {@link #getContinuation(ServletRequest)}
* @return
* @return the continuation
*/
@Deprecated
public static Continuation getContinuation(final ServletRequest request, final ServletResponse response)

View File

@ -78,8 +78,7 @@ public abstract class AbstractGenerator implements Generator
* Constructor.
*
* @param buffers buffer pool
* @param headerBufferSize Size of the buffer to allocate for HTTP header
* @param contentBufferSize Size of the buffer to allocate for HTTP content
* @param io the end point
*/
public AbstractGenerator(Buffers buffers, EndPoint io)
{

View File

@ -936,7 +936,6 @@ public class HttpFields
* Format a set cookie value
*
* @param cookie The cookie.
* @param cookie2 If true, use the alternate cookie 2 header
*/
public void addSetCookie(HttpCookie cookie)
{
@ -951,12 +950,19 @@ public class HttpFields
cookie.isHttpOnly(),
cookie.getVersion());
}
/* ------------------------------------------------------------ */
/**
* Format a set cookie value
* @param cookie The cookie.
* @param cookie2 If true, use the alternate cookie 2 header
*
* @param name the name
* @param value the value
* @param domain the domain
* @param path the path
* @param maxAge the maximum age
* @param comment the comment (only present on versions > 0)
* @param isSecure true if secure cookie
* @param isHttpOnly true if for http only
* @param version version of cookie logic to use (0 == default behavior)
*/
public void addSetCookie(
final String name,
@ -1236,7 +1242,7 @@ public class HttpFields
/**
* List values in quality order.
*
* @param enum Enumeration of values with quality parameters
* @param e Enumeration of values with quality parameters
* @return values in quality order.
*/
public static List qualityList(Enumeration e)

View File

@ -113,8 +113,7 @@ public class HttpGenerator extends AbstractGenerator
* Constructor.
*
* @param buffers buffer pool
* @param headerBufferSize Size of the buffer to allocate for HTTP header
* @param contentBufferSize Size of the buffer to allocate for HTTP content
* @param io the end point to use
*/
public HttpGenerator(Buffers buffers, EndPoint io)
{

View File

@ -40,7 +40,7 @@ import org.eclipse.jetty.util.TypeUtil;
* </tr>
*
* <tr>
* <td>{@link #CONTINUE}</td>
* <td>{@link #CONTINUE_100}</td>
* <td>100</td>
* <td>Continue</td>
* <td>&nbsp;</td>
@ -49,7 +49,7 @@ import org.eclipse.jetty.util.TypeUtil;
* <td>&nbsp;</td>
* </tr>
* <tr>
* <td>{@link #SWITCHING_PROTOCOLS}</td>
* <td>{@link #SWITCHING_PROTOCOLS_101}</td>
* <td>101</td>
* <td>Switching Protocols</td>
* <td>&nbsp;</td>
@ -58,7 +58,7 @@ import org.eclipse.jetty.util.TypeUtil;
* <td>&nbsp;</td>
* </tr>
* <tr>
* <td>{@link #PROCESSING}</td>
* <td>{@link #PROCESSING_102}</td>
* <td>102</td>
* <td>Processing</td>
* <td>&nbsp;</td>
@ -73,7 +73,7 @@ import org.eclipse.jetty.util.TypeUtil;
* </tr>
*
* <tr>
* <td>{@link #OK}</td>
* <td>{@link #OK_200}</td>
* <td>200</td>
* <td>OK</td>
* <td>
@ -83,7 +83,7 @@ import org.eclipse.jetty.util.TypeUtil;
* <td>&nbsp;</td>
* </tr>
* <tr>
* <td>{@link #CREATED}</td>
* <td>{@link #CREATED_201}</td>
* <td>201</td>
* <td>Created</td>
* <td>
@ -93,7 +93,7 @@ import org.eclipse.jetty.util.TypeUtil;
* <td>&nbsp;</td>
* </tr>
* <tr>
* <td>{@link #ACCEPTED}</td>
* <td>{@link #ACCEPTED_202}</td>
* <td>202</td>
* <td>Accepted</td>
* <td>
@ -103,7 +103,7 @@ import org.eclipse.jetty.util.TypeUtil;
* <td>&nbsp;</td>
* </tr>
* <tr>
* <td>{@link #NON_AUTHORITATIVE_INFORMATION}</td>
* <td>{@link #NON_AUTHORITATIVE_INFORMATION_203}</td>
* <td>203</td>
* <td>Non Authoritative Information</td>
* <td>&nbsp;</td>
@ -112,7 +112,7 @@ import org.eclipse.jetty.util.TypeUtil;
* <td>&nbsp;</td>
* </tr>
* <tr>
* <td>{@link #NO_CONTENT}</td>
* <td>{@link #NO_CONTENT_204}</td>
* <td>204</td>
* <td>No Content</td>
* <td>
@ -122,7 +122,7 @@ import org.eclipse.jetty.util.TypeUtil;
* <td>&nbsp;</td>
* </tr>
* <tr>
* <td>{@link #RESET_CONTENT}</td>
* <td>{@link #RESET_CONTENT_205}</td>
* <td>205</td>
* <td>Reset Content</td>
* <td>&nbsp;</td>
@ -131,7 +131,7 @@ import org.eclipse.jetty.util.TypeUtil;
* <td>&nbsp;</td>
* </tr>
* <tr>
* <td>{@link #PARTIAL_CONTENT}</td>
* <td>{@link #PARTIAL_CONTENT_206}</td>
* <td>206</td>
* <td>Partial Content</td>
* <td>&nbsp;</td>
@ -140,7 +140,7 @@ import org.eclipse.jetty.util.TypeUtil;
* <td>&nbsp;</td>
* </tr>
* <tr>
* <td>{@link #MULTI_STATUS}</td>
* <td>{@link #MULTI_STATUS_207}</td>
* <td>207</td>
* <td>Multi-Status</td>
* <td>&nbsp;</td>
@ -166,7 +166,7 @@ import org.eclipse.jetty.util.TypeUtil;
* </tr>
*
* <tr>
* <td>{@link #MULTIPLE_CHOICES}</td>
* <td>{@link #MULTIPLE_CHOICES_300}</td>
* <td>300</td>
* <td>Multiple Choices</td>
* <td>
@ -176,7 +176,7 @@ import org.eclipse.jetty.util.TypeUtil;
* <td>&nbsp;</td>
* </tr>
* <tr>
* <td>{@link #MOVED_PERMANENTLY}</td>
* <td>{@link #MOVED_PERMANENTLY_301}</td>
* <td>301</td>
* <td>Moved Permanently</td>
* <td>
@ -186,7 +186,7 @@ import org.eclipse.jetty.util.TypeUtil;
* <td>&nbsp;</td>
* </tr>
* <tr>
* <td>{@link #MOVED_TEMPORARILY}</td>
* <td>{@link #MOVED_TEMPORARILY_302}</td>
* <td>302</td>
* <td>Moved Temporarily</td>
* <td>
@ -195,7 +195,7 @@ import org.eclipse.jetty.util.TypeUtil;
* <td>&nbsp;</td>
* </tr>
* <tr>
* <td>{@link #FOUND}</td>
* <td>{@link #FOUND_302}</td>
* <td>302</td>
* <td>Found</td>
* <td>(was "<code>302 Moved Temporarily</code>")</td>
@ -204,7 +204,7 @@ import org.eclipse.jetty.util.TypeUtil;
* <td>&nbsp;</td>
* </tr>
* <tr>
* <td>{@link #SEE_OTHER}</td>
* <td>{@link #SEE_OTHER_303}</td>
* <td>303</td>
* <td>See Other</td>
* <td>&nbsp;</td>
@ -213,7 +213,7 @@ import org.eclipse.jetty.util.TypeUtil;
* <td>&nbsp;</td>
* </tr>
* <tr>
* <td>{@link #NOT_MODIFIED}</td>
* <td>{@link #NOT_MODIFIED_304}</td>
* <td>304</td>
* <td>Not Modified</td>
* <td>
@ -223,7 +223,7 @@ import org.eclipse.jetty.util.TypeUtil;
* <td>&nbsp;</td>
* </tr>
* <tr>
* <td>{@link #USE_PROXY}</td>
* <td>{@link #USE_PROXY_305}</td>
* <td>305</td>
* <td>Use Proxy</td>
* <td>&nbsp;</td>
@ -241,7 +241,7 @@ import org.eclipse.jetty.util.TypeUtil;
* <td>&nbsp;</td>
* </tr>
* <tr>
* <td>{@link #TEMPORARY_REDIRECT}</td>
* <td>{@link #TEMPORARY_REDIRECT_307}</td>
* <td>307</td>
* <td>Temporary Redirect</td>
* <td>&nbsp;</td>
@ -296,7 +296,7 @@ import org.eclipse.jetty.util.TypeUtil;
* <td>&nbsp;</td>
* </tr>
* <tr>
* <td>{@link #NOT_FOUND}</td>
* <td>{@link #NOT_FOUND_404}</td>
* <td>404</td>
* <td>Not Found</td>
* <td>
@ -306,7 +306,7 @@ import org.eclipse.jetty.util.TypeUtil;
* <td>&nbsp;</td>
* </tr>
* <tr>
* <td>{@link #METHOD_NOT_ALLOWED}</td>
* <td>{@link #METHOD_NOT_ALLOWED_405}</td>
* <td>405</td>
* <td>Method Not Allowed</td>
* <td>&nbsp;</td>
@ -315,7 +315,7 @@ import org.eclipse.jetty.util.TypeUtil;
* <td>&nbsp;</td>
* </tr>
* <tr>
* <td>{@link #NOT_ACCEPTABLE}</td>
* <td>{@link #NOT_ACCEPTABLE_406}</td>
* <td>406</td>
* <td>Not Acceptable</td>
* <td>&nbsp;</td>
@ -324,7 +324,7 @@ import org.eclipse.jetty.util.TypeUtil;
* <td>&nbsp;</td>
* </tr>
* <tr>
* <td>{@link #PROXY_AUTHENTICATION_REQUIRED}</td>
* <td>{@link #PROXY_AUTHENTICATION_REQUIRED_407}</td>
* <td>407</td>
* <td>Proxy Authentication Required</td>
* <td>&nbsp;</td>
@ -333,7 +333,7 @@ import org.eclipse.jetty.util.TypeUtil;
* <td>&nbsp;</td>
* </tr>
* <tr>
* <td>{@link #REQUEST_TIMEOUT}</td>
* <td>{@link #REQUEST_TIMEOUT_408}</td>
* <td>408</td>
* <td>Request Timeout</td>
* <td>&nbsp;</td>
@ -342,7 +342,7 @@ import org.eclipse.jetty.util.TypeUtil;
* <td>&nbsp;</td>
* </tr>
* <tr>
* <td>{@link #CONFLICT}</td>
* <td>{@link #CONFLICT_409}</td>
* <td>409</td>
* <td>Conflict</td>
* <td>&nbsp;</td>
@ -352,7 +352,7 @@ import org.eclipse.jetty.util.TypeUtil;
* <td>&nbsp;</td>
* </tr>
* <tr>
* <td>{@link #GONE}</td>
* <td>{@link #GONE_410}</td>
* <td>410</td>
* <td>Gone</td>
* <td>&nbsp;</td>
@ -362,7 +362,7 @@ import org.eclipse.jetty.util.TypeUtil;
* <td>&nbsp;</td>
* </tr>
* <tr>
* <td>{@link #LENGTH_REQUIRED}</td>
* <td>{@link #LENGTH_REQUIRED_411}</td>
* <td>411</td>
* <td>Length Required</td>
* <td>&nbsp;</td>
@ -372,7 +372,7 @@ import org.eclipse.jetty.util.TypeUtil;
* <td>&nbsp;</td>
* </tr>
* <tr>
* <td>{@link #PRECONDITION_FAILED}</td>
* <td>{@link #PRECONDITION_FAILED_412}</td>
* <td>412</td>
* <td>Precondition Failed</td>
* <td>&nbsp;</td>
@ -382,7 +382,7 @@ import org.eclipse.jetty.util.TypeUtil;
* <td>&nbsp;</td>
* </tr>
* <tr>
* <td>{@link #REQUEST_ENTITY_TOO_LARGE}</td>
* <td>{@link #REQUEST_ENTITY_TOO_LARGE_413}</td>
* <td>413</td>
* <td>Request Entity Too Large</td>
* <td>&nbsp;</td>
@ -392,7 +392,7 @@ import org.eclipse.jetty.util.TypeUtil;
* <td>&nbsp;</td>
* </tr>
* <tr>
* <td>{@link #REQUEST_URI_TOO_LONG}</td>
* <td>{@link #REQUEST_URI_TOO_LONG_414}</td>
* <td>414</td>
* <td>Request-URI Too Long</td>
* <td>&nbsp;</td>
@ -402,7 +402,7 @@ import org.eclipse.jetty.util.TypeUtil;
* <td>&nbsp;</td>
* </tr>
* <tr>
* <td>{@link #UNSUPPORTED_MEDIA_TYPE}</td>
* <td>{@link #UNSUPPORTED_MEDIA_TYPE_415}</td>
* <td>415</td>
* <td>Unsupported Media Type</td>
* <td>&nbsp;</td>
@ -412,7 +412,7 @@ import org.eclipse.jetty.util.TypeUtil;
* <td>&nbsp;</td>
* </tr>
* <tr>
* <td>{@link #REQUESTED_RANGE_NOT_SATISFIABLE}</td>
* <td>{@link #REQUESTED_RANGE_NOT_SATISFIABLE_416}</td>
* <td>416</td>
* <td>Requested Range Not Satisfiable</td>
* <td>&nbsp;</td>
@ -422,7 +422,7 @@ import org.eclipse.jetty.util.TypeUtil;
* <td>&nbsp;</td>
* </tr>
* <tr>
* <td>{@link #EXPECTATION_FAILED}</td>
* <td>{@link #EXPECTATION_FAILED_417}</td>
* <td>417</td>
* <td>Expectation Failed</td>
* <td>&nbsp;</td>
@ -495,7 +495,7 @@ import org.eclipse.jetty.util.TypeUtil;
* <td>&nbsp;</td>
* </tr>
* <tr>
* <td>{@link #UNPROCESSABLE_ENTITY}</td>
* <td>{@link #UNPROCESSABLE_ENTITY_422}</td>
* <td>422</td>
* <td>Unprocessable Entity</td>
* <td>&nbsp;</td>
@ -513,7 +513,7 @@ import org.eclipse.jetty.util.TypeUtil;
* <a href="http://tools.ietf.org/html/rfc2518#section-10.4">Sec. 10.4</a></td>
* </tr>
* <tr>
* <td>{@link #FAILED_DEPENDENCY}</td>
* <td>{@link #FAILED_DEPENDENCY_424}</td>
* <td>424</td>
* <td>Failed Dependency</td>
* <td>&nbsp;</td>
@ -528,7 +528,7 @@ import org.eclipse.jetty.util.TypeUtil;
* </tr>
*
* <tr>
* <td>{@link #INTERNAL_SERVER_ERROR}</td>
* <td>{@link #INTERNAL_SERVER_ERROR_500}</td>
* <td>500</td>
* <td>Internal Server Error</td>
* <td>
@ -538,7 +538,7 @@ import org.eclipse.jetty.util.TypeUtil;
* <td>&nbsp;</td>
* </tr>
* <tr>
* <td>{@link #NOT_IMPLEMENTED}</td>
* <td>{@link #NOT_IMPLEMENTED_501}</td>
* <td>501</td>
* <td>Not Implemented</td>
* <td>
@ -548,7 +548,7 @@ import org.eclipse.jetty.util.TypeUtil;
* <td>&nbsp;</td>
* </tr>
* <tr>
* <td>{@link #BAD_GATEWAY}</td>
* <td>{@link #BAD_GATEWAY_502}</td>
* <td>502</td>
* <td>Bad Gateway</td>
* <td>
@ -558,7 +558,7 @@ import org.eclipse.jetty.util.TypeUtil;
* <td>&nbsp;</td>
* </tr>
* <tr>
* <td>{@link #SERVICE_UNAVAILABLE}</td>
* <td>{@link #SERVICE_UNAVAILABLE_503}</td>
* <td>503</td>
* <td>Service Unavailable</td>
* <td>
@ -568,7 +568,7 @@ import org.eclipse.jetty.util.TypeUtil;
* <td>&nbsp;</td>
* </tr>
* <tr>
* <td>{@link #GATEWAY_TIMEOUT}</td>
* <td>{@link #GATEWAY_TIMEOUT_504}</td>
* <td>504</td>
* <td>Gateway Timeout</td>
* <td>&nbsp;</td>
@ -577,7 +577,7 @@ import org.eclipse.jetty.util.TypeUtil;
* <td>&nbsp;</td>
* </tr>
* <tr>
* <td>{@link #HTTP_VERSION_NOT_SUPPORTED}</td>
* <td>{@link #HTTP_VERSION_NOT_SUPPORTED_505}</td>
* <td>505</td>
* <td>HTTP Version Not Supported</td>
* <td>&nbsp;</td>
@ -594,7 +594,7 @@ import org.eclipse.jetty.util.TypeUtil;
* <td>&nbsp;</td>
* </tr>
* <tr>
* <td>{@link #INSUFFICIENT_STORAGE}</td>
* <td>{@link #INSUFFICIENT_STORAGE_507}</td>
* <td>507</td>
* <td>Insufficient Storage</td>
* <td>&nbsp;</td>

View File

@ -28,7 +28,7 @@ import org.eclipse.jetty.util.log.Log;
/**
* A wrapper for the {@link java.io.PrintWriter} that re-throws the instances of
* {@link java.io.IOException} thrown by the underlying implementation of
* {@link java.io.Writer} as {@link RunimeIOException} instances.
* {@link java.io.Writer} as {@link RuntimeIOException} instances.
*/
public class UncheckedPrintWriter extends PrintWriter
{

View File

@ -39,7 +39,6 @@ import org.eclipse.jetty.util.thread.Timeout.Task;
* <p>
* This class works around a number of know JVM bugs. For details
* see http://wiki.eclipse.org/Jetty/Feature/JVM_NIO_Bug
*
*/
public abstract class SelectorManager extends AbstractLifeCycle
{
@ -60,7 +59,7 @@ public abstract class SelectorManager extends AbstractLifeCycle
/* ------------------------------------------------------------ */
/**
* @param maxIdleTime The maximum period in milli seconds that a connection may be idle before it is closed.
* @see {@link #setLowResourcesMaxIdleTime(long)}
* @see #setLowResourcesMaxIdleTime(long)
*/
public void setMaxIdleTime(long maxIdleTime)
{
@ -80,7 +79,7 @@ public abstract class SelectorManager extends AbstractLifeCycle
/* ------------------------------------------------------------ */
/**
* @return
* @return the max idle time
*/
public long getMaxIdleTime()
{
@ -89,7 +88,7 @@ public abstract class SelectorManager extends AbstractLifeCycle
/* ------------------------------------------------------------ */
/**
* @return
* @return the number of select sets in use
*/
public int getSelectSets()
{
@ -120,9 +119,8 @@ public abstract class SelectorManager extends AbstractLifeCycle
}
/* ------------------------------------------------------------ */
/** Register a serverchannel
/** Register a {@link ServerSocketChannel}
* @param acceptChannel
* @return
* @throws IOException
*/
public void register(ServerSocketChannel acceptChannel)
@ -148,7 +146,7 @@ public abstract class SelectorManager extends AbstractLifeCycle
* Set the number of connections, which if exceeded places this manager in low resources state.
* This is not an exact measure as the connection count is averaged over the select sets.
* @param lowResourcesConnections the number of connections
* @see {@link #setLowResourcesMaxIdleTime(long)}
* @see #setLowResourcesMaxIdleTime(long)
*/
public void setLowResourcesConnections(long lowResourcesConnections)
{
@ -167,7 +165,7 @@ public abstract class SelectorManager extends AbstractLifeCycle
/* ------------------------------------------------------------ */
/**
* @param lowResourcesMaxIdleTime the period in ms that a connection is allowed to be idle when this SelectSet has more connections than {@link #getLowResourcesConnections()}
* @see {@link #setMaxIdleTime(long)}
* @see #setMaxIdleTime(long)
*/
public void setLowResourcesMaxIdleTime(long lowResourcesMaxIdleTime)
{
@ -188,8 +186,8 @@ public abstract class SelectorManager extends AbstractLifeCycle
/* ------------------------------------------------------------ */
/**
* @param key
* @return
* @param key the selection key
* @return the SocketChannel created on accept
* @throws IOException
*/
protected abstract SocketChannel acceptChannel(SelectionKey key) throws IOException;
@ -249,10 +247,11 @@ public abstract class SelectorManager extends AbstractLifeCycle
/* ------------------------------------------------------------ */
/**
* Create a new end point
* @param channel
* @param selectSet
* @param sKey
* @return
* @param sKey the selection key
* @return the new endpoint {@link SelectChannelEndPoint}
* @throws IOException
*/
protected abstract SelectChannelEndPoint newEndPoint(SocketChannel channel, SelectorManager.SelectSet selectSet, SelectionKey sKey) throws IOException;

View File

@ -131,14 +131,14 @@ public interface Connector extends LifeCycle
/* ------------------------------------------------------------ */
/**
* @return The port to use when redirecting a request if a data constraint of integral is
* required. See {@link org.eclipse.jetty.server.server.security.Constraint#getDataConstraint()}
* required. See {@link org.eclipse.jetty.http.security.Constraint#getDataConstraint()}
*/
int getIntegralPort();
/* ------------------------------------------------------------ */
/**
* @return The schema to use when redirecting a request if a data constraint of integral is
* required. See {@link org.eclipse.jetty.server.server.security.Constraint#getDataConstraint()}
* required. See {@link org.eclipse.jetty.http.security.Constraint#getDataConstraint()}
*/
String getIntegralScheme();
@ -152,7 +152,7 @@ public interface Connector extends LifeCycle
/* ------------------------------------------------------------ */
/**
* @return The port to use when redirecting a request if a data constraint of confidential is
* required. See {@link org.eclipse.jetty.server.server.security.Constraint#getDataConstraint()}
* required. See {@link org.eclipse.jetty.http.security.Constraint#getDataConstraint()}
*/
int getConfidentialPort();
@ -160,7 +160,7 @@ public interface Connector extends LifeCycle
/* ------------------------------------------------------------ */
/**
* @return The schema to use when redirecting a request if a data constraint of confidential is
* required. See {@link org.eclipse.jetty.server.server.security.Constraint#getDataConstraint()}
* required. See {@link org.eclipse.jetty.http.security.Constraint#getDataConstraint()}
*/
String getConfidentialScheme();
@ -185,7 +185,6 @@ public interface Connector extends LifeCycle
/** Persist an endpoint.
* Called after every request if the connection is to remain open.
* @param endpoint
* @param request
* @throws IOException
*/
void persist(EndPoint endpoint) throws IOException;

View File

@ -18,8 +18,8 @@ import org.eclipse.jetty.util.component.LifeCycle;
/**
* A Handler that contains other Handlers.
* <p>
* The contained handlers may be one (see @{link {@link org.eclipse.jetty.server.server.handler.HandlerWrapper})
* or many (see {@link org.eclipse.jetty.server.server.handler.HandlerList} or {@link org.eclipse.jetty.server.server.handler.HandlerCollection}.
* The contained handlers may be one (see @{link {@link org.eclipse.jetty.server.handler.HandlerWrapper})
* or many (see {@link org.eclipse.jetty.server.handler.HandlerList} or {@link org.eclipse.jetty.server.handler.HandlerCollection}.
*
*/
public interface HandlerContainer extends LifeCycle

View File

@ -41,9 +41,6 @@ import org.eclipse.jetty.util.log.Log;
* servers, and almost all web log analysis software can understand these
* formats.
*
*
*
*
* @org.apache.xbean.XBean element="ncsaLog"
*/
public class NCSARequestLog extends AbstractLifeCycle implements RequestLog
@ -506,7 +503,7 @@ public class NCSARequestLog extends AbstractLifeCycle implements RequestLog
/**
* Set the log file date format.
*
* @see {@link RolloverFileOutputStream#RolloverFileOutputStream(String, boolean, int, TimeZone, String, String)}
* @see RolloverFileOutputStream#RolloverFileOutputStream(String, boolean, int, TimeZone, String, String)
* @param logFileDateFormat
* the logFileDateFormat to pass to
* {@link RolloverFileOutputStream}

View File

@ -80,18 +80,18 @@ import org.eclipse.jetty.util.log.Log;
* passed to. This allows the request object to be as lightweight as possible and not
* actually implement any significant behaviour. For example<ul>
*
* <li>The {@link Request#getContextPath} method will return null, until the requeset has been
* passed to a {@link ContextHandler} which matches the {@link Request#getPathInfo} with a context
* path and calls {@link Request#setContextPath} as a result.</li>
* <li>The {@link Request#getContextPath()} method will return null, until the requeset has been
* passed to a {@link ContextHandler} which matches the {@link Request#getPathInfo()} with a context
* path and calls {@link Request#setContextPath(String)} as a result.</li>
*
* <li>the HTTP session methods
* will all return null sessions until such time as a request has been passed to
* a {@link org.eclipse.jetty.servlet.SessionHandler} which checks for session cookies
* a {@link org.eclipse.jetty.server.session.SessionHandler} which checks for session cookies
* and enables the ability to create new sessions.</li>
*
* <li>The {@link Request#getServletPath} method will return null until the request has been
* <li>The {@link Request#getServletPath()} method will return null until the request has been
* passed to a {@link org.eclipse.jetty.servlet.ServletHandler} and the pathInfo matched
* against the servlet URL patterns and {@link Request#setServletPath} called as a result.</li>
* against the servlet URL patterns and {@link Request#setServletPath(String)} called as a result.</li>
* </ul>
*
* A request instance is created for each {@link HttpConnection} accepted by the server
@ -1560,7 +1560,7 @@ public class Request implements HttpServletRequest
/* ------------------------------------------------------------ */
/**
* @return True if this is the first call of takeNewContext() since the last {@link #setContext(Context)} call.
* @return True if this is the first call of {@link #takeNewContext()} since the last {@link #setContext(Context)} call.
*/
public boolean takeNewContext()
{
@ -1572,7 +1572,7 @@ public class Request implements HttpServletRequest
/* ------------------------------------------------------------ */
/**
* Sets the "context path" for this request
* @see HttpServletRequest#getContextPath
* @see HttpServletRequest#getContextPath()
*/
public void setContextPath(String contextPath)
{

View File

@ -16,9 +16,8 @@ package org.eclipse.jetty.server;
import org.eclipse.jetty.util.component.LifeCycle;
/**
* A <code>RequestLog</code> can be attached to a {@link org.eclipse.jetty.server.server.handler.RequestLogHandler} to enable logging of requests/responses.
*
* @see Server#setRequestLog
* A <code>RequestLog</code> can be attached to a {@link org.eclipse.jetty.server.handler.RequestLogHandler} to enable
* logging of requests/responses.
*/
public interface RequestLog extends LifeCycle
{

View File

@ -437,7 +437,7 @@ public class Server extends HandlerWrapper implements Attributes
/**
* Add a LifeCycle object to be started/stopped
* along with the Server.
* @deprecated Use {@link #addBean(LifeCycle)}
* @deprecated Use {@link #addBean(Object)}
* @param c
*/
@Deprecated
@ -452,7 +452,7 @@ public class Server extends HandlerWrapper implements Attributes
* The bean will be added to the servers {@link Container}
* and if it is a {@link LifeCycle} instance, it will be
* started/stopped along with the Server.
* @param c
* @param o the bean object to add
*/
public void addBean(Object o)
{

View File

@ -20,13 +20,6 @@ import org.eclipse.jetty.util.component.LifeCycle;
/** Session ID Manager.
* Manages session IDs across multiple contexts.
*
*
*/
/* ------------------------------------------------------------ */
/**
*
*
*/
public interface SessionIdManager extends LifeCycle
{
@ -57,7 +50,7 @@ public interface SessionIdManager extends LifeCycle
/**
* @param request
* @param created
* @return
* @return the new session id
*/
public String newSessionId(HttpServletRequest request,long created);
@ -68,7 +61,7 @@ public interface SessionIdManager extends LifeCycle
/** Get a cluster ID from a node ID.
* Strip node identifier from a located session ID.
* @param nodeId
* @return
* @return the cluster id
*/
public String getClusterId(String nodeId);

View File

@ -35,8 +35,8 @@ public interface SessionManager extends LifeCycle
/* ------------------------------------------------------------ */
/**
* Session cookie name.
* Defaults to JSESSIONID, but can be set with the
* org.eclipse.jetty.servlet.SessionCookie context init parameter.
* Defaults to <code>JSESSIONID</code>, but can be set with the
* <code>org.eclipse.jetty.servlet.SessionCookie</code> context init parameter.
*/
public final static String __SessionCookieProperty = "org.eclipse.jetty.servlet.SessionCookie";
public final static String __DefaultSessionCookie = "JSESSIONID";
@ -45,8 +45,8 @@ public interface SessionManager extends LifeCycle
/* ------------------------------------------------------------ */
/**
* Session id path parameter name.
* Defaults to jsessionid, but can be set with the
* org.eclipse.jetty.servlet.SessionIdPathParameterName context init parameter.
* Defaults to <code>jsessionid</code>, but can be set with the
* <code>org.eclipse.jetty.servlet.SessionIdPathParameterName</code> context init parameter.
* If set to null or "none" no URL rewriting will be done.
*/
public final static String __SessionIdPathParameterNameProperty = "org.eclipse.jetty.servlet.SessionIdPathParameterName";
@ -109,7 +109,7 @@ public interface SessionManager extends LifeCycle
/* ------------------------------------------------------------ */
/**
* @return true if session cookies should be HTTP-only (Microsoft extension)
* @see Cookie#isHttpOnly()
* @see org.eclipse.jetty.http.HttpCookie#isHttpOnly()
*/
public boolean getHttpOnly();

View File

@ -28,6 +28,7 @@ import java.util.HashSet;
import java.util.Locale;
import java.util.Map;
import java.util.Set;
import javax.servlet.RequestDispatcher;
import javax.servlet.Servlet;
import javax.servlet.ServletContext;
@ -43,7 +44,6 @@ import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import org.eclipse.jetty.http.HttpException;
import org.eclipse.jetty.http.HttpMethods;
import org.eclipse.jetty.http.MimeTypes;
import org.eclipse.jetty.io.Buffer;
import org.eclipse.jetty.server.Dispatcher;
@ -75,9 +75,6 @@ import org.eclipse.jetty.util.resource.Resource;
* so that they may be managed with JMX.
*
* @org.apache.xbean.XBean description="Creates a basic HTTP context"
*
*
*
*/
public class ContextHandler extends ScopedHandler implements Attributes, Server.Graceful
{
@ -603,7 +600,7 @@ public class ContextHandler extends ScopedHandler implements Attributes, Server.
* call to super.doStart(). This allows derived classes to insert additional
* handling (Eg configuration) before the call to super.doStart by this method
* will start contained handlers.
* @see org.eclipse.jetty.Scope.Context
* @see org.eclipse.jetty.server.handler.ContextHandler.Context
* @see org.eclipse.jetty.webapp.WebAppContext
*/
protected void startContext()

View File

@ -33,7 +33,7 @@ import org.eclipse.jetty.util.log.Log;
/** ContextHandlerCollection.
*
* This {@link org.eclipse.jetty.server.handler.HandlerCollection} is creates a
* {@link org.eclipse.jetty.http.servlet.PathMap} to it's contained handlers based
* {@link org.eclipse.jetty.http.PathMap} to it's contained handlers based
* on the context path and virtual hosts of any contained {@link org.eclipse.jetty.server.handler.ContextHandler}s.
* The contexts do not need to be directly contained, only children of the contained handlers.
* Multiple contexts may have the same context path and they are called in order until one
@ -265,7 +265,7 @@ public class ContextHandlerCollection extends HandlerCollection
/* ------------------------------------------------------------ */
/** Add a context handler.
* @param contextPath The context path to add
* @return
* @return the ContextHandler just added
* @throws IllegalAccessException
* @throws InstantiationException
*/

View File

@ -109,8 +109,8 @@ public class HandlerCollection extends AbstractHandlerContainer
}
/* ------------------------------------------------------------ */
/*
* @see org.eclipse.jetty.server.server.EventHandler#handle(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)
/**
* @see Handler#handle(String, Request, HttpServletRequest, HttpServletResponse)
*/
public void handle(String target, Request baseRequest, HttpServletRequest request, HttpServletResponse response)
throws IOException, ServletException

View File

@ -31,8 +31,8 @@ import org.eclipse.jetty.server.Request;
public class HandlerList extends HandlerCollection
{
/* ------------------------------------------------------------ */
/*
* @see org.eclipse.jetty.server.server.EventHandler#handle(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)
/**
* @see Handler#handle(String, Request, HttpServletRequest, HttpServletResponse)
*/
@Override
public void handle(String target, Request baseRequest, HttpServletRequest request, HttpServletResponse response)

View File

@ -45,7 +45,7 @@ import org.eclipse.jetty.util.thread.Timeout.Task;
* </p>
* <p>
* When used with {@link org.eclipse.jetty.continuation.Continuation}, threadless waits are supported. When
* a filter or servlet calls getEvent on a Continuation, a {@link org.eclipse.jetty.server.RetryRequest}
* a filter or servlet calls getEvent on a Continuation, a
* runtime exception is thrown to allow the thread to exit the current request handling. Jetty will
* catch this exception and will not send a response to the client. Instead the thread is released
* and the Continuation is placed on the timer queue. If the Continuation timeout expires, or it's
@ -56,9 +56,6 @@ import org.eclipse.jetty.util.thread.Timeout.Task;
* </p>
*
* @org.apache.xbean.XBean element="nioConnector" description="Creates an NIO based socket connector"
*
*
*
*/
public class SelectChannelConnector extends AbstractNIOConnector
{
@ -242,7 +239,7 @@ public class SelectChannelConnector extends AbstractNIOConnector
* Set the number of connections, which if exceeded places this manager in low resources state.
* This is not an exact measure as the connection count is averaged over the select sets.
* @param lowResourcesConnections the number of connections
* @see {@link #setLowResourcesMaxIdleTime(int)}
* @see #setLowResourcesMaxIdleTime(int)
*/
public void setLowResourcesConnections(int lowResourcesConnections)
{
@ -265,7 +262,7 @@ public class SelectChannelConnector extends AbstractNIOConnector
* than {@link #getLowResourcesConnections()} connections. This allows the server to rapidly close idle connections
* in order to gracefully handle high load situations.
* @param lowResourcesMaxIdleTime the period in ms that a connection is allowed to be idle when resources are low.
* @see {@link #setMaxIdleTime(long)}
* @see #setMaxIdleTime(long)
*/
@Override
public void setLowResourcesMaxIdleTime(int lowResourcesMaxIdleTime)

View File

@ -55,7 +55,7 @@ import org.eclipse.jetty.util.statistic.SampleStatistic;
* Map.
* <p>
* If the property
* org.eclipse.jetty.servlet.AbstractSessionManager.23Notifications is set to
* <code>org.eclipse.jetty.servlet.AbstractSessionManager.23Notifications</code> is set to
* true, the 2.3 servlet spec notification style will be used.
* <p>
*

View File

@ -33,9 +33,6 @@ import org.eclipse.jetty.util.log.Log;
/* ------------------------------------------------------------ */
/** SessionHandler.
*
*
*
*/
public class SessionHandler extends ScopedHandler
{

View File

@ -20,10 +20,8 @@ import java.util.Queue;
/* ------------------------------------------------------------ */
/** Queue backed by circular array.
*
* This partial Queue implementation (also with {@link #pop()} for stack operation)
* This partial Queue implementation (also with {@link #remove()} for stack operation)
* is backed by a growable circular array.
*
*
*
* @param <E>
*/
@ -214,7 +212,7 @@ public class ArrayQueue<E> extends AbstractList<E> implements Queue<E>
/* ------------------------------------------------------------ */
/**
* Get without synchronization or bounds checking.
* @see get(int)
* @see #get(int)
*/
public E getUnsafe(int index)
{

View File

@ -51,7 +51,6 @@ import java.util.ListIterator;
* An ArrayList of default size is used as the initial LazyList.
*
* @see java.util.List
*
*/
public class LazyList
implements Cloneable, Serializable
@ -283,7 +282,7 @@ public class LazyList
/** Convert a lazylist to an array
* @param list The list to convert
* @param clazz The class of the array, which may be a primitive type
* @return
* @return array of the lazylist entries passed in
*/
@SuppressWarnings("unchecked")
public static Object toArray(Object list,Class<?> clazz)

View File

@ -32,8 +32,8 @@ public abstract class PatternMatcher
* Will iterate over the jar names, matching
* all those starting with "aaa-" first, then "bbb-".
*
* @param pattern
* @param loader
* @param pattern the pattern
* @param uris the uris to test the pattern against
* @param isNullInclusive if true, an empty pattern means all names match, if false, none match
* @throws Exception
*/

View File

@ -120,7 +120,7 @@ public class Scanner
/**
* Get the location of the directory to scan
* @return
* @return the first directory (of {@link #getScanDirs(List)} being scanned)
* @deprecated use getScanDirs() instead
*/
@Deprecated
@ -160,7 +160,7 @@ public class Scanner
/**
* Get any filter applied to files in the scan dir.
* @return
* @return the filename filter
*/
public FilenameFilter getFilenameFilter ()
{
@ -310,7 +310,6 @@ public class Scanner
/**
* Recursively scan all files in the designated directories.
* @return Map of name of file to last modified time
*/
public synchronized void scanFiles ()
{

View File

@ -39,7 +39,6 @@ import java.util.Map;
* get operations are not protected from concurrent updates.
*
* @see java.net.URLEncoder
*
*/
public class UrlEncoded extends MultiMap
{
@ -239,7 +238,10 @@ public class UrlEncoded extends MultiMap
/* -------------------------------------------------------------- */
/** Decoded parameters to Map.
* @param data the byte[] containing the encoded parameters
* @param raw the byte[] containing the encoded parameters
* @param offset the offset within raw to decode from
* @param length the length of the section to decode
* @param map the {@link MultiMap} to use for decoding
*/
public static void decodeUtf8To(byte[] raw,int offset, int length, MultiMap map)
{

View File

@ -187,7 +187,7 @@ public class JSON
/* ------------------------------------------------------------ */
/**
* @param s Stream containing JSON object or array.
* @param in Reader containing JSON object or array.
* @param stripOuterComment If true, an outer comment around the JSON is ignored.
* @return A Map, Object array or primitive array parsed from the JSON.
*/
@ -211,7 +211,7 @@ public class JSON
/* ------------------------------------------------------------ */
/**
* @deprecated use {@link #parse(Reader, boolean)}
* @param s Stream containing JSON object or array.
* @param in Stream containing JSON object or array.
* @param stripOuterComment If true, an outer comment around the JSON is ignored.
* @return A Map, Object array or primitive array parsed from the JSON.
*/
@ -1388,7 +1388,7 @@ public class JSON
/** Static JSON Convertor.
* <p>
* may be implemented to provide static convertors for objects that may be registered
* with {@link JSON#registerConvertor(Class, org.eclipse.jetty.util.ajax.JSON.Convertor).
* with {@link JSON#registerConvertor(Class, org.eclipse.jetty.util.ajax.JSON.Convertor)}.
* These convertors are looked up by class, interface and
* super class by {@link JSON#getConvertor(Class)}. Convertors should be used when the
* classes to be converted cannot implement {@link Convertible} or {@link Generator}.

View File

@ -34,9 +34,6 @@ import org.eclipse.jetty.util.log.Log;
* this.bars=bars;
* }
* </pre>
*
*
*
*/
public class Container
{
@ -73,7 +70,7 @@ public class Container
* @param oldChild The previous value of the child. If this is non null and differs from <code>child</code>, then a remove event is generated.
* @param child The current child. If this is non null and differs from <code>oldChild</code>, then an add event is generated.
* @param relationship The name of the relationship
* @param addRemoveBean If true add/remove is called for the new/old children as well as the relationships
* @param addRemove If true add/remove is called for the new/old children as well as the relationships
*/
public synchronized void update(Object parent, Object oldChild, final Object child, String relationship,boolean addRemove)
{
@ -112,7 +109,7 @@ public class Container
* This array is modified and children that remain in the new children array are nulled out of the old children array.
* @param children The current array of children. An add event is generated for any child in this array but not in the <code>oldChildren</code> array.
* @param relationship The name of the relationship
* @param addRemoveBean If true add/remove is called for the new/old children as well as the relationships
* @param addRemove If true add/remove is called for the new/old children as well as the relationships
*/
public synchronized void update(Object parent, Object[] oldChildren, final Object[] children, String relationship, boolean addRemove)
{

View File

@ -34,10 +34,8 @@ import org.eclipse.jetty.util.log.Log;
/* ------------------------------------------------------------ */
/** Abstract resource class.
*
*
*
/**
* Abstract resource class.
*/
public abstract class Resource implements Serializable
{
@ -259,13 +257,13 @@ public abstract class Resource implements Serializable
/* ------------------------------------------------------------ */
/** Find a classpath resource.
* The {@java.lang.Class#getResource} method is used to lookup the resource. If it is not
* The {@link java.lang.Class#getResource(String)} method is used to lookup the resource. If it is not
* found, then the {@link Loader#getResource(Class, String, boolean)} method is used.
* If it is still not found, then {@link ClassLoader#getSystemResource(String)} is used.
* Unlike {@link #getSystemResource} this method does not check for normal resources.
* @param name The relative name of the resouce
* Unlike {@link ClassLoader#getSystemResource(String)} this method does not check for normal resources.
* @param name The relative name of the resource
* @param useCaches True if URL caches are to be used.
* @param checkParents True if forced searching of parent classloaders is performed to work around
* @param checkParents True if forced searching of parent Classloaders is performed to work around
* loaders with inverted priorities
* @return Resource or null
*/

View File

@ -46,7 +46,7 @@ public class CounterStatistic
/* ------------------------------------------------------------ */
/**
* @param delta
* @param delta the amount to add to the count
*/
public void add(final long delta)
{
@ -64,7 +64,7 @@ public class CounterStatistic
/* ------------------------------------------------------------ */
/**
* @param delta
* @param delta the amount to subtract the count by.
*/
public void subtract(final long delta)
{
@ -89,7 +89,7 @@ public class CounterStatistic
/* ------------------------------------------------------------ */
/**
* @return
* @return max value
*/
public long getMax()
{
@ -98,7 +98,7 @@ public class CounterStatistic
/* ------------------------------------------------------------ */
/**
* @return
* @return current value
*/
public long getCurrent()
{
@ -107,7 +107,7 @@ public class CounterStatistic
/* ------------------------------------------------------------ */
/**
* @return
* @return total value
*/
public long getTotal()
{

View File

@ -27,12 +27,10 @@ import org.eclipse.jetty.util.component.LifeCycle;
import org.eclipse.jetty.util.log.Log;
/* ------------------------------------------------------------ */
/** Jetty ThreadPool using java 5 ThreadPoolExecutor
/**
* Jetty ThreadPool using java 5 ThreadPoolExecutor
* This class wraps a {@link ExecutorService} as a {@link ThreadPool} and
* {@link LifeCycle} interfaces so that it may be used by the Jetty {@link org.eclipse.jetty.Server}
*
*
*
* {@link LifeCycle} interfaces so that it may be used by the Jetty {@link org.eclipse.jetty.server.Server}
*/
public class ExecutorThreadPool extends AbstractLifeCycle implements ThreadPool, LifeCycle
{

View File

@ -28,7 +28,6 @@ import org.eclipse.jetty.util.component.AbstractLifeCycle;
import org.eclipse.jetty.util.component.LifeCycle;
import org.eclipse.jetty.util.log.Log;
public class QueuedThreadPool extends AbstractLifeCycle implements ThreadPool, Executor
{
private final AtomicInteger _threadsStarted = new AtomicInteger();
@ -47,7 +46,7 @@ public class QueuedThreadPool extends AbstractLifeCycle implements ThreadPool, E
private int _maxStopTime=100;
/* ------------------------------------------------------------------- */
/* Construct
/** Construct
*/
public QueuedThreadPool()
{
@ -55,7 +54,7 @@ public class QueuedThreadPool extends AbstractLifeCycle implements ThreadPool, E
}
/* ------------------------------------------------------------------- */
/* Construct
/** Construct
*/
public QueuedThreadPool(int maxThreads)
{
@ -64,7 +63,7 @@ public class QueuedThreadPool extends AbstractLifeCycle implements ThreadPool, E
}
/* ------------------------------------------------------------------- */
/* Construct
/** Construct
*/
public QueuedThreadPool(BlockingQueue<Runnable> jobQ)
{
@ -508,7 +507,7 @@ public class QueuedThreadPool extends AbstractLifeCycle implements ThreadPool, E
/**
* @param id The thread ID to stop.
* @return true if the thread was found and stopped.
* @Deprecated Use {@link #interruptThread(long)} in preference
* @deprecated Use {@link #interruptThread(long)} in preference
*/
@SuppressWarnings("deprecation")
public boolean stopThread(long id)

View File

@ -52,7 +52,7 @@ public class ShutdownThread extends Thread
/**
* Returns the instance of the singleton
*
* @return
* @return the singleton instance of the {@link ShutdownThread}
*/
public static ShutdownThread getInstance()
{

View File

@ -23,10 +23,7 @@ import org.eclipse.jetty.util.log.Log;
* is changed, this affects all scheduled tasks.
* <p>
* The nested class Task should be extended by users of this class to obtain call back notification of
* expiries.
*
*
*
* expires.
*/
public class Timeout
{
@ -91,7 +88,7 @@ public class Timeout
* expired Task, but without calling it's {@link Task#expire()} or
* {@link Task#expired()} methods.
*
* @returns the next expired task or null.
* @return the next expired task or null.
*/
public Task expired()
{