You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@tomcat.apache.org by ma...@apache.org on 2023/04/14 11:30:00 UTC
[tomcat] branch 9.0.x updated (4fb5d7a1df -> 8e92da0ace)
This is an automated email from the ASF dual-hosted git repository.
markt pushed a change to branch 9.0.x
in repository https://gitbox.apache.org/repos/asf/tomcat.git
from 4fb5d7a1df Tweak formatting settings
new 3b1b9412dc Code clean-up - no functional change
new 9087b3a84f Code clean-up - no functional change
new 3a378cae7c Code clean-up - no functional change
new ecc2d82c46 Code clean-up - no functional change
new 6e0aeb5b41 Code clean-up - no functional change
new cf8605a1aa Code clean-up - no functional change
new 215a3f0ba8 Align with Java EE 8
new 8e92da0ace Code clean-up - no functional change
The 8 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails. The revisions
listed as "add" were already present in the repository and have only
been added to this reference.
Summary of changes:
java/javax/annotation/Generated.java | 11 +-
java/javax/annotation/PostConstruct.java | 3 +-
java/javax/annotation/PreDestroy.java | 3 +-
java/javax/annotation/Priority.java | 6 +-
java/javax/annotation/Resource.java | 9 +-
java/javax/annotation/security/DenyAll.java | 2 +-
java/javax/annotation/security/PermitAll.java | 2 +-
java/javax/annotation/security/RolesAllowed.java | 2 +-
.../javax/annotation/sql/DataSourceDefinition.java | 2 +
java/javax/ejb/EJB.java | 7 +-
java/javax/el/BeanELResolver.java | 12 +-
java/javax/el/ELContext.java | 10 +-
java/javax/el/ELManager.java | 2 +-
java/javax/el/ExpressionFactory.java | 14 +-
java/javax/el/ImportHandler.java | 12 +-
java/javax/el/LambdaExpression.java | 4 +-
java/javax/el/MapELResolver.java | 18 +-
java/javax/el/StandardELContext.java | 14 +-
java/javax/el/StaticFieldELResolver.java | 8 +-
java/javax/el/Util.java | 6 +-
java/javax/mail/Session.java | 1 +
java/javax/mail/internet/MimeMessage.java | 2 +
java/javax/persistence/PersistenceContext.java | 6 +-
java/javax/persistence/PersistenceProperty.java | 1 +
java/javax/persistence/PersistenceUnit.java | 3 +-
java/javax/security/auth/message/ClientAuth.java | 4 +-
java/javax/security/auth/message/ServerAuth.java | 4 +-
.../message/callback/CallerPrincipalCallback.java | 4 +-
.../auth/message/callback/CertStoreCallback.java | 3 +-
.../message/callback/GroupPrincipalCallback.java | 3 +-
.../callback/PasswordValidationCallback.java | 4 +-
.../auth/message/callback/PrivateKeyCallback.java | 5 +-
.../auth/message/callback/SecretKeyCallback.java | 4 +-
.../auth/message/callback/TrustStoreCallback.java | 3 +-
.../auth/message/config/AuthConfigFactory.java | 56 +-
.../auth/message/config/AuthConfigProvider.java | 6 +-
.../auth/message/config/ClientAuthConfig.java | 3 +-
.../auth/message/config/ServerAuthConfig.java | 3 +-
.../auth/message/module/ClientAuthModule.java | 4 +-
.../auth/message/module/ServerAuthModule.java | 4 +-
java/javax/servlet/AsyncContext.java | 78 +-
java/javax/servlet/AsyncEvent.java | 26 +-
java/javax/servlet/AsyncListener.java | 26 +-
java/javax/servlet/DispatcherType.java | 10 +-
java/javax/servlet/Filter.java | 95 +-
java/javax/servlet/FilterChain.java | 26 +-
java/javax/servlet/FilterConfig.java | 34 +-
java/javax/servlet/FilterRegistration.java | 55 +-
java/javax/servlet/GenericFilter.java | 16 +-
java/javax/servlet/GenericServlet.java | 165 ++-
java/javax/servlet/HttpConstraintElement.java | 44 +-
.../javax/servlet/HttpMethodConstraintElement.java | 33 +-
java/javax/servlet/MultipartConfigElement.java | 29 +-
java/javax/servlet/ReadListener.java | 10 +-
java/javax/servlet/Registration.java | 49 +-
java/javax/servlet/RequestDispatcher.java | 269 ++---
java/javax/servlet/Servlet.java | 144 +--
java/javax/servlet/ServletConfig.java | 40 +-
.../javax/servlet/ServletContainerInitializer.java | 30 +-
java/javax/servlet/ServletContext.java | 1207 ++++++++++----------
.../servlet/ServletContextAttributeEvent.java | 20 +-
.../servlet/ServletContextAttributeListener.java | 23 +-
java/javax/servlet/ServletContextEvent.java | 6 +-
java/javax/servlet/ServletContextListener.java | 22 +-
java/javax/servlet/ServletException.java | 46 +-
java/javax/servlet/ServletInputStream.java | 67 +-
java/javax/servlet/ServletOutputStream.java | 176 ++-
java/javax/servlet/ServletRegistration.java | 62 +-
java/javax/servlet/ServletRequest.java | 425 +++----
.../servlet/ServletRequestAttributeEvent.java | 31 +-
.../servlet/ServletRequestAttributeListener.java | 31 +-
java/javax/servlet/ServletRequestEvent.java | 16 +-
java/javax/servlet/ServletRequestListener.java | 22 +-
java/javax/servlet/ServletRequestWrapper.java | 165 ++-
java/javax/servlet/ServletResponse.java | 331 +++---
java/javax/servlet/ServletResponseWrapper.java | 82 +-
java/javax/servlet/ServletSecurityElement.java | 59 +-
java/javax/servlet/SessionCookieConfig.java | 29 +-
java/javax/servlet/SingleThreadModel.java | 25 +-
java/javax/servlet/UnavailableException.java | 115 +-
java/javax/servlet/WriteListener.java | 10 +-
java/javax/servlet/annotation/HandlesTypes.java | 4 +-
java/javax/servlet/annotation/HttpConstraint.java | 26 +-
.../servlet/annotation/HttpMethodConstraint.java | 26 +-
java/javax/servlet/annotation/MultipartConfig.java | 13 +-
java/javax/servlet/annotation/ServletSecurity.java | 19 +-
java/javax/servlet/annotation/WebFilter.java | 32 +-
java/javax/servlet/annotation/WebInitParam.java | 6 +-
java/javax/servlet/annotation/WebListener.java | 19 +-
java/javax/servlet/annotation/WebServlet.java | 29 +-
.../servlet/descriptor/JspConfigDescriptor.java | 15 +-
.../descriptor/JspPropertyGroupDescriptor.java | 22 +-
java/javax/servlet/http/Cookie.java | 4 +-
java/javax/servlet/http/HttpServlet.java | 13 +-
java/javax/servlet/http/HttpServletRequest.java | 2 +-
.../servlet/http/HttpServletRequestWrapper.java | 2 +-
java/javax/servlet/http/HttpServletResponse.java | 4 +-
.../servlet/http/HttpServletResponseWrapper.java | 4 +-
java/javax/servlet/http/HttpSession.java | 15 +-
java/javax/servlet/http/HttpSessionContext.java | 6 +-
java/javax/servlet/http/HttpUtils.java | 6 +-
java/javax/servlet/jsp/ErrorData.java | 21 +-
java/javax/servlet/jsp/HttpJspPage.java | 37 +-
java/javax/servlet/jsp/JspApplicationContext.java | 25 +-
java/javax/servlet/jsp/JspContext.java | 206 ++--
java/javax/servlet/jsp/JspEngineInfo.java | 17 +-
java/javax/servlet/jsp/JspException.java | 42 +-
java/javax/servlet/jsp/JspFactory.java | 81 +-
java/javax/servlet/jsp/JspPage.java | 67 +-
java/javax/servlet/jsp/JspTagException.java | 50 +-
java/javax/servlet/jsp/JspWriter.java | 363 +++---
java/javax/servlet/jsp/PageContext.java | 377 +++---
java/javax/servlet/jsp/SkipPageException.java | 28 +-
java/javax/servlet/jsp/el/ELException.java | 16 +-
java/javax/servlet/jsp/el/ELParseException.java | 9 +-
java/javax/servlet/jsp/el/Expression.java | 35 +-
java/javax/servlet/jsp/el/ExpressionEvaluator.java | 105 +-
java/javax/servlet/jsp/el/FunctionMapper.java | 20 +-
.../servlet/jsp/el/ImplicitObjectELResolver.java | 29 +-
.../servlet/jsp/el/ScopedAttributeELResolver.java | 9 +-
java/javax/servlet/jsp/el/VariableResolver.java | 25 +-
java/javax/servlet/jsp/tagext/BodyContent.java | 46 +-
java/javax/servlet/jsp/tagext/BodyTag.java | 147 +--
java/javax/servlet/jsp/tagext/BodyTagSupport.java | 41 +-
.../servlet/jsp/tagext/DynamicAttributes.java | 29 +-
java/javax/servlet/jsp/tagext/FunctionInfo.java | 7 +-
java/javax/servlet/jsp/tagext/IterationTag.java | 118 +-
java/javax/servlet/jsp/tagext/JspFragment.java | 64 +-
java/javax/servlet/jsp/tagext/JspIdConsumer.java | 3 +-
java/javax/servlet/jsp/tagext/JspTag.java | 3 +-
java/javax/servlet/jsp/tagext/PageData.java | 15 +-
java/javax/servlet/jsp/tagext/SimpleTag.java | 132 +--
.../javax/servlet/jsp/tagext/SimpleTagSupport.java | 126 +-
java/javax/servlet/jsp/tagext/Tag.java | 254 ++--
java/javax/servlet/jsp/tagext/TagAdapter.java | 81 +-
.../javax/servlet/jsp/tagext/TagAttributeInfo.java | 126 +-
java/javax/servlet/jsp/tagext/TagData.java | 56 +-
java/javax/servlet/jsp/tagext/TagExtraInfo.java | 92 +-
java/javax/servlet/jsp/tagext/TagFileInfo.java | 35 +-
java/javax/servlet/jsp/tagext/TagInfo.java | 273 ++---
java/javax/servlet/jsp/tagext/TagLibraryInfo.java | 97 +-
.../servlet/jsp/tagext/TagLibraryValidator.java | 110 +-
java/javax/servlet/jsp/tagext/TagSupport.java | 87 +-
java/javax/servlet/jsp/tagext/TagVariableInfo.java | 40 +-
java/javax/servlet/jsp/tagext/TryCatchFinally.java | 61 +-
.../servlet/jsp/tagext/ValidationMessage.java | 35 +-
java/javax/servlet/jsp/tagext/VariableInfo.java | 128 +--
java/javax/transaction/Synchronization.java | 1 +
java/javax/transaction/Transaction.java | 12 +-
java/javax/transaction/TransactionManager.java | 9 +-
java/javax/transaction/UserTransaction.java | 6 +-
java/javax/websocket/ClientEndpoint.java | 6 +-
java/javax/websocket/ClientEndpointConfig.java | 34 +-
java/javax/websocket/CloseReason.java | 6 +-
java/javax/websocket/ContainerProvider.java | 17 +-
java/javax/websocket/DecodeException.java | 3 +-
.../websocket/DefaultClientEndpointConfig.java | 8 +-
java/javax/websocket/Encoder.java | 6 +-
java/javax/websocket/Endpoint.java | 9 +-
java/javax/websocket/EndpointConfig.java | 2 +-
java/javax/websocket/Extension.java | 2 +
java/javax/websocket/HandshakeResponse.java | 2 +-
java/javax/websocket/MessageHandler.java | 7 +-
java/javax/websocket/PongMessage.java | 6 +-
java/javax/websocket/RemoteEndpoint.java | 186 ++-
java/javax/websocket/SendResult.java | 2 +-
java/javax/websocket/Session.java | 95 +-
java/javax/websocket/WebSocketContainer.java | 70 +-
.../server/DefaultServerEndpointConfig.java | 11 +-
java/javax/websocket/server/HandshakeRequest.java | 12 +-
java/javax/websocket/server/PathParam.java | 5 +-
.../websocket/server/ServerApplicationConfig.java | 27 +-
java/javax/websocket/server/ServerEndpoint.java | 7 +-
.../websocket/server/ServerEndpointConfig.java | 72 +-
java/javax/xml/ws/WebServiceRef.java | 6 +-
175 files changed, 3809 insertions(+), 5274 deletions(-)
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@tomcat.apache.org
For additional commands, e-mail: dev-help@tomcat.apache.org
[tomcat] 04/08: Code clean-up - no functional change
Posted by ma...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
markt pushed a commit to branch 9.0.x
in repository https://gitbox.apache.org/repos/asf/tomcat.git
commit ecc2d82c46f5d9411e842f6aa03245f782bf1f18
Author: Mark Thomas <ma...@apache.org>
AuthorDate: Fri Apr 14 11:37:02 2023 +0100
Code clean-up - no functional change
---
java/javax/security/auth/message/ClientAuth.java | 4 +-
java/javax/security/auth/message/ServerAuth.java | 4 +-
.../message/callback/CallerPrincipalCallback.java | 4 +-
.../auth/message/callback/CertStoreCallback.java | 3 +-
.../message/callback/GroupPrincipalCallback.java | 3 +-
.../callback/PasswordValidationCallback.java | 4 +-
.../auth/message/callback/PrivateKeyCallback.java | 5 +-
.../auth/message/callback/SecretKeyCallback.java | 4 +-
.../auth/message/callback/TrustStoreCallback.java | 3 +-
.../auth/message/config/AuthConfigFactory.java | 56 ++++++++++------------
.../auth/message/config/AuthConfigProvider.java | 6 +--
.../auth/message/config/ClientAuthConfig.java | 3 +-
.../auth/message/config/ServerAuthConfig.java | 3 +-
.../auth/message/module/ClientAuthModule.java | 4 +-
.../auth/message/module/ServerAuthModule.java | 4 +-
15 files changed, 48 insertions(+), 62 deletions(-)
diff --git a/java/javax/security/auth/message/ClientAuth.java b/java/javax/security/auth/message/ClientAuth.java
index a537ef2a17..a8f9a77ae7 100644
--- a/java/javax/security/auth/message/ClientAuth.java
+++ b/java/javax/security/auth/message/ClientAuth.java
@@ -22,8 +22,8 @@ public interface ClientAuth {
AuthStatus secureRequest(MessageInfo messageInfo, Subject clientSubject) throws AuthException;
- AuthStatus validateResponse(MessageInfo messageInfo, Subject clientSubject,
- Subject serviceSubject) throws AuthException;
+ AuthStatus validateResponse(MessageInfo messageInfo, Subject clientSubject, Subject serviceSubject)
+ throws AuthException;
void cleanSubject(MessageInfo messageInfo, Subject subject) throws AuthException;
}
diff --git a/java/javax/security/auth/message/ServerAuth.java b/java/javax/security/auth/message/ServerAuth.java
index bb404f558b..23f5c66ecb 100644
--- a/java/javax/security/auth/message/ServerAuth.java
+++ b/java/javax/security/auth/message/ServerAuth.java
@@ -20,8 +20,8 @@ import javax.security.auth.Subject;
public interface ServerAuth {
- AuthStatus validateRequest(MessageInfo messageInfo, Subject clientSubject,
- Subject serviceSubject) throws AuthException;
+ AuthStatus validateRequest(MessageInfo messageInfo, Subject clientSubject, Subject serviceSubject)
+ throws AuthException;
AuthStatus secureResponse(MessageInfo messageInfo, Subject serviceSubject) throws AuthException;
diff --git a/java/javax/security/auth/message/callback/CallerPrincipalCallback.java b/java/javax/security/auth/message/callback/CallerPrincipalCallback.java
index 2c7010f680..803856d67b 100644
--- a/java/javax/security/auth/message/callback/CallerPrincipalCallback.java
+++ b/java/javax/security/auth/message/callback/CallerPrincipalCallback.java
@@ -22,8 +22,8 @@ import javax.security.auth.Subject;
import javax.security.auth.callback.Callback;
/**
- * Callback that enables an authentication module to inform the runtime of the
- * call principal or name of the caller principal.
+ * Callback that enables an authentication module to inform the runtime of the call principal or name of the caller
+ * principal.
*/
public class CallerPrincipalCallback implements Callback {
diff --git a/java/javax/security/auth/message/callback/CertStoreCallback.java b/java/javax/security/auth/message/callback/CertStoreCallback.java
index 13734e8ce0..963d7b29dc 100644
--- a/java/javax/security/auth/message/callback/CertStoreCallback.java
+++ b/java/javax/security/auth/message/callback/CertStoreCallback.java
@@ -21,8 +21,7 @@ import java.security.cert.CertStore;
import javax.security.auth.callback.Callback;
/**
- * Callback that enables a runtime to inform authentication modules of the
- * CertStore to use.
+ * Callback that enables a runtime to inform authentication modules of the CertStore to use.
*/
public class CertStoreCallback implements Callback {
diff --git a/java/javax/security/auth/message/callback/GroupPrincipalCallback.java b/java/javax/security/auth/message/callback/GroupPrincipalCallback.java
index f44c04629a..4261f9d791 100644
--- a/java/javax/security/auth/message/callback/GroupPrincipalCallback.java
+++ b/java/javax/security/auth/message/callback/GroupPrincipalCallback.java
@@ -20,8 +20,7 @@ import javax.security.auth.Subject;
import javax.security.auth.callback.Callback;
/**
- * Callback that enables an authentication module to inform the runtime of the
- * groups a user is in.
+ * Callback that enables an authentication module to inform the runtime of the groups a user is in.
*/
public class GroupPrincipalCallback implements Callback {
diff --git a/java/javax/security/auth/message/callback/PasswordValidationCallback.java b/java/javax/security/auth/message/callback/PasswordValidationCallback.java
index 2eaad2d898..9cdbc081ad 100644
--- a/java/javax/security/auth/message/callback/PasswordValidationCallback.java
+++ b/java/javax/security/auth/message/callback/PasswordValidationCallback.java
@@ -22,8 +22,8 @@ import javax.security.auth.Subject;
import javax.security.auth.callback.Callback;
/**
- * Callback that enables an authentication module to supply a user name and
- * password (to a runtime?) and determine if the result of validation.
+ * Callback that enables an authentication module to supply a user name and password (to a runtime?) and determine if
+ * the result of validation.
*/
public class PasswordValidationCallback implements Callback {
diff --git a/java/javax/security/auth/message/callback/PrivateKeyCallback.java b/java/javax/security/auth/message/callback/PrivateKeyCallback.java
index 473450384b..d4dbd89303 100644
--- a/java/javax/security/auth/message/callback/PrivateKeyCallback.java
+++ b/java/javax/security/auth/message/callback/PrivateKeyCallback.java
@@ -24,9 +24,8 @@ import javax.security.auth.callback.Callback;
import javax.security.auth.x500.X500Principal;
/**
- * Callback that enables an authentication module to request a certificate chain
- * and private key from the runtime. The information specifying the chain and
- * key may be an alias, a digest, a subject key, or an issuer ID. Other request
+ * Callback that enables an authentication module to request a certificate chain and private key from the runtime. The
+ * information specifying the chain and key may be an alias, a digest, a subject key, or an issuer ID. Other request
* types may be supported.
*/
public class PrivateKeyCallback implements Callback {
diff --git a/java/javax/security/auth/message/callback/SecretKeyCallback.java b/java/javax/security/auth/message/callback/SecretKeyCallback.java
index 0a88a5ca4f..a0122d01f9 100644
--- a/java/javax/security/auth/message/callback/SecretKeyCallback.java
+++ b/java/javax/security/auth/message/callback/SecretKeyCallback.java
@@ -20,8 +20,8 @@ import javax.crypto.SecretKey;
import javax.security.auth.callback.Callback;
/**
- * A callback enabling an authentication module to request a secret key from the
- * runtime, by supplying an alias. Other request types may also be supported.
+ * A callback enabling an authentication module to request a secret key from the runtime, by supplying an alias. Other
+ * request types may also be supported.
*/
public class SecretKeyCallback implements Callback {
diff --git a/java/javax/security/auth/message/callback/TrustStoreCallback.java b/java/javax/security/auth/message/callback/TrustStoreCallback.java
index 8312e44fd9..8bc1d943a8 100644
--- a/java/javax/security/auth/message/callback/TrustStoreCallback.java
+++ b/java/javax/security/auth/message/callback/TrustStoreCallback.java
@@ -21,8 +21,7 @@ import java.security.KeyStore;
import javax.security.auth.callback.Callback;
/**
- * A Callback enabling an authentication module to request a truststore from the
- * runtime.
+ * A Callback enabling an authentication module to request a truststore from the runtime.
*/
public class TrustStoreCallback implements Callback {
diff --git a/java/javax/security/auth/message/config/AuthConfigFactory.java b/java/javax/security/auth/message/config/AuthConfigFactory.java
index 306a54246d..bf8ad1d52f 100644
--- a/java/javax/security/auth/message/config/AuthConfigFactory.java
+++ b/java/javax/security/auth/message/config/AuthConfigFactory.java
@@ -27,14 +27,10 @@ import java.util.Map;
public abstract class AuthConfigFactory {
- public static final String DEFAULT_FACTORY_SECURITY_PROPERTY =
- "authconfigprovider.factory";
- public static final String GET_FACTORY_PERMISSION_NAME =
- "getProperty.authconfigprovider.factory";
- public static final String SET_FACTORY_PERMISSION_NAME =
- "setProperty.authconfigprovider.factory";
- public static final String PROVIDER_REGISTRATION_PERMISSION_NAME =
- "setProperty.authconfigfactory.provider";
+ public static final String DEFAULT_FACTORY_SECURITY_PROPERTY = "authconfigprovider.factory";
+ public static final String GET_FACTORY_PERMISSION_NAME = "getProperty.authconfigprovider.factory";
+ public static final String SET_FACTORY_PERMISSION_NAME = "setProperty.authconfigprovider.factory";
+ public static final String PROVIDER_REGISTRATION_PERMISSION_NAME = "setProperty.authconfigfactory.provider";
public static final SecurityPermission getFactorySecurityPermission =
new SecurityPermission(GET_FACTORY_PERMISSION_NAME);
@@ -63,24 +59,23 @@ public abstract class AuthConfigFactory {
if (factory == null) {
final String className = getFactoryClassName();
try {
- factory = AccessController.doPrivileged(
- (PrivilegedExceptionAction<AuthConfigFactory>) () -> {
- // Load this class with the same class loader as used for
- // this class. Note that the Thread context class loader
- // should not be used since that would trigger a memory leak
- // in container environments.
- if (className.equals("org.apache.catalina.authenticator.jaspic.AuthConfigFactoryImpl")) {
- return new org.apache.catalina.authenticator.jaspic.AuthConfigFactoryImpl();
- } else {
- Class<?> clazz = Class.forName(className);
- return (AuthConfigFactory) clazz.getConstructor().newInstance();
- }
- });
+ factory = AccessController.doPrivileged((PrivilegedExceptionAction<AuthConfigFactory>) () -> {
+ // Load this class with the same class loader as used for
+ // this class. Note that the Thread context class loader
+ // should not be used since that would trigger a memory leak
+ // in container environments.
+ if (className.equals("org.apache.catalina.authenticator.jaspic.AuthConfigFactoryImpl")) {
+ return new org.apache.catalina.authenticator.jaspic.AuthConfigFactoryImpl();
+ } else {
+ Class<?> clazz = Class.forName(className);
+ return (AuthConfigFactory) clazz.getConstructor().newInstance();
+ }
+ });
} catch (PrivilegedActionException e) {
Exception inner = e.getException();
if (inner instanceof InstantiationException) {
- throw new SecurityException("AuthConfigFactory error:" +
- inner.getCause().getMessage(), inner.getCause());
+ throw new SecurityException("AuthConfigFactory error:" + inner.getCause().getMessage(),
+ inner.getCause());
} else {
throw new SecurityException("AuthConfigFactory error: " + inner, inner);
}
@@ -100,16 +95,15 @@ public abstract class AuthConfigFactory {
RegistrationListener listener);
@SuppressWarnings("rawtypes") // JASPIC API uses raw types
- public abstract String registerConfigProvider(String className, Map properties, String layer,
- String appContext, String description);
+ public abstract String registerConfigProvider(String className, Map properties, String layer, String appContext,
+ String description);
- public abstract String registerConfigProvider(AuthConfigProvider provider, String layer,
- String appContext, String description);
+ public abstract String registerConfigProvider(AuthConfigProvider provider, String layer, String appContext,
+ String description);
public abstract boolean removeRegistration(String registrationID);
- public abstract String[] detachListener(RegistrationListener listener, String layer,
- String appContext);
+ public abstract String[] detachListener(RegistrationListener listener, String layer, String appContext);
public abstract String[] getRegistrationIDs(AuthConfigProvider provider);
@@ -125,8 +119,8 @@ public abstract class AuthConfigFactory {
}
private static String getFactoryClassName() {
- String className = AccessController.doPrivileged(
- (PrivilegedAction<String>) () -> Security.getProperty(DEFAULT_FACTORY_SECURITY_PROPERTY));
+ String className = AccessController
+ .doPrivileged((PrivilegedAction<String>) () -> Security.getProperty(DEFAULT_FACTORY_SECURITY_PROPERTY));
if (className != null) {
return className;
diff --git a/java/javax/security/auth/message/config/AuthConfigProvider.java b/java/javax/security/auth/message/config/AuthConfigProvider.java
index ddde485f7b..335e617acf 100644
--- a/java/javax/security/auth/message/config/AuthConfigProvider.java
+++ b/java/javax/security/auth/message/config/AuthConfigProvider.java
@@ -21,11 +21,9 @@ import javax.security.auth.message.AuthException;
public interface AuthConfigProvider {
- ClientAuthConfig getClientAuthConfig(String layer, String appContext, CallbackHandler handler)
- throws AuthException;
+ ClientAuthConfig getClientAuthConfig(String layer, String appContext, CallbackHandler handler) throws AuthException;
- ServerAuthConfig getServerAuthConfig(String layer, String appContext, CallbackHandler handler)
- throws AuthException;
+ ServerAuthConfig getServerAuthConfig(String layer, String appContext, CallbackHandler handler) throws AuthException;
void refresh();
}
diff --git a/java/javax/security/auth/message/config/ClientAuthConfig.java b/java/javax/security/auth/message/config/ClientAuthConfig.java
index 2c135845e4..f1a486e979 100644
--- a/java/javax/security/auth/message/config/ClientAuthConfig.java
+++ b/java/javax/security/auth/message/config/ClientAuthConfig.java
@@ -24,6 +24,5 @@ import javax.security.auth.message.AuthException;
public interface ClientAuthConfig extends AuthConfig {
@SuppressWarnings("rawtypes") // JASPIC API uses raw types
- ClientAuthContext getAuthContext(String authContextID, Subject clientSubject, Map properties)
- throws AuthException;
+ ClientAuthContext getAuthContext(String authContextID, Subject clientSubject, Map properties) throws AuthException;
}
diff --git a/java/javax/security/auth/message/config/ServerAuthConfig.java b/java/javax/security/auth/message/config/ServerAuthConfig.java
index de22a513d7..6c207eb4e1 100644
--- a/java/javax/security/auth/message/config/ServerAuthConfig.java
+++ b/java/javax/security/auth/message/config/ServerAuthConfig.java
@@ -24,6 +24,5 @@ import javax.security.auth.message.AuthException;
public interface ServerAuthConfig extends AuthConfig {
@SuppressWarnings("rawtypes") // JASPIC API uses raw types
- ServerAuthContext getAuthContext(String authContextID, Subject serviceSubject, Map properties)
- throws AuthException;
+ ServerAuthContext getAuthContext(String authContextID, Subject serviceSubject, Map properties) throws AuthException;
}
diff --git a/java/javax/security/auth/message/module/ClientAuthModule.java b/java/javax/security/auth/message/module/ClientAuthModule.java
index 6cb5c4ee10..c0bccfef40 100644
--- a/java/javax/security/auth/message/module/ClientAuthModule.java
+++ b/java/javax/security/auth/message/module/ClientAuthModule.java
@@ -26,8 +26,8 @@ import javax.security.auth.message.MessagePolicy;
public interface ClientAuthModule extends ClientAuth {
@SuppressWarnings("rawtypes") // JASPIC API uses raw types
- void initialize(MessagePolicy requestPolicy, MessagePolicy responsePolicy,
- CallbackHandler handler, Map options) throws AuthException;
+ void initialize(MessagePolicy requestPolicy, MessagePolicy responsePolicy, CallbackHandler handler, Map options)
+ throws AuthException;
@SuppressWarnings("rawtypes") // JASPIC API uses raw types
Class[] getSupportedMessageTypes();
diff --git a/java/javax/security/auth/message/module/ServerAuthModule.java b/java/javax/security/auth/message/module/ServerAuthModule.java
index 4b3a6fb891..6e82000907 100644
--- a/java/javax/security/auth/message/module/ServerAuthModule.java
+++ b/java/javax/security/auth/message/module/ServerAuthModule.java
@@ -26,8 +26,8 @@ import javax.security.auth.message.ServerAuth;
public interface ServerAuthModule extends ServerAuth {
@SuppressWarnings("rawtypes") // JASPIC API uses raw types
- void initialize(MessagePolicy requestPolicy, MessagePolicy responsePolicy,
- CallbackHandler handler, Map options) throws AuthException;
+ void initialize(MessagePolicy requestPolicy, MessagePolicy responsePolicy, CallbackHandler handler, Map options)
+ throws AuthException;
@SuppressWarnings("rawtypes") // JASPIC API uses raw types
Class[] getSupportedMessageTypes();
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@tomcat.apache.org
For additional commands, e-mail: dev-help@tomcat.apache.org
[tomcat] 02/08: Code clean-up - no functional change
Posted by ma...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
markt pushed a commit to branch 9.0.x
in repository https://gitbox.apache.org/repos/asf/tomcat.git
commit 9087b3a84f604e2940f39204afb3793b38b52954
Author: Mark Thomas <ma...@apache.org>
AuthorDate: Fri Apr 14 11:36:51 2023 +0100
Code clean-up - no functional change
---
java/javax/servlet/AsyncContext.java | 78 +-
java/javax/servlet/AsyncEvent.java | 26 +-
java/javax/servlet/AsyncListener.java | 26 +-
java/javax/servlet/DispatcherType.java | 10 +-
java/javax/servlet/Filter.java | 95 +-
java/javax/servlet/FilterChain.java | 26 +-
java/javax/servlet/FilterConfig.java | 34 +-
java/javax/servlet/FilterRegistration.java | 55 +-
java/javax/servlet/GenericFilter.java | 16 +-
java/javax/servlet/GenericServlet.java | 165 ++-
java/javax/servlet/HttpConstraintElement.java | 44 +-
.../javax/servlet/HttpMethodConstraintElement.java | 33 +-
java/javax/servlet/MultipartConfigElement.java | 29 +-
java/javax/servlet/ReadListener.java | 10 +-
java/javax/servlet/Registration.java | 49 +-
java/javax/servlet/RequestDispatcher.java | 269 ++---
java/javax/servlet/Servlet.java | 144 +--
java/javax/servlet/ServletConfig.java | 40 +-
.../javax/servlet/ServletContainerInitializer.java | 30 +-
java/javax/servlet/ServletContext.java | 1207 ++++++++++----------
.../servlet/ServletContextAttributeEvent.java | 20 +-
.../servlet/ServletContextAttributeListener.java | 23 +-
java/javax/servlet/ServletContextEvent.java | 6 +-
java/javax/servlet/ServletContextListener.java | 22 +-
java/javax/servlet/ServletException.java | 46 +-
java/javax/servlet/ServletInputStream.java | 67 +-
java/javax/servlet/ServletOutputStream.java | 176 ++-
java/javax/servlet/ServletRegistration.java | 62 +-
java/javax/servlet/ServletRequest.java | 425 +++----
.../servlet/ServletRequestAttributeEvent.java | 31 +-
.../servlet/ServletRequestAttributeListener.java | 31 +-
java/javax/servlet/ServletRequestEvent.java | 16 +-
java/javax/servlet/ServletRequestListener.java | 22 +-
java/javax/servlet/ServletRequestWrapper.java | 165 ++-
java/javax/servlet/ServletResponse.java | 331 +++---
java/javax/servlet/ServletResponseWrapper.java | 82 +-
java/javax/servlet/ServletSecurityElement.java | 59 +-
java/javax/servlet/SessionCookieConfig.java | 29 +-
java/javax/servlet/SingleThreadModel.java | 25 +-
java/javax/servlet/UnavailableException.java | 115 +-
java/javax/servlet/WriteListener.java | 10 +-
java/javax/servlet/annotation/HandlesTypes.java | 4 +-
java/javax/servlet/annotation/HttpConstraint.java | 26 +-
.../servlet/annotation/HttpMethodConstraint.java | 26 +-
java/javax/servlet/annotation/MultipartConfig.java | 13 +-
java/javax/servlet/annotation/ServletSecurity.java | 19 +-
java/javax/servlet/annotation/WebFilter.java | 32 +-
java/javax/servlet/annotation/WebInitParam.java | 6 +-
java/javax/servlet/annotation/WebListener.java | 19 +-
java/javax/servlet/annotation/WebServlet.java | 29 +-
.../servlet/descriptor/JspConfigDescriptor.java | 15 +-
.../descriptor/JspPropertyGroupDescriptor.java | 22 +-
java/javax/servlet/http/Cookie.java | 4 +-
java/javax/servlet/http/HttpServlet.java | 13 +-
java/javax/servlet/http/HttpServletRequest.java | 2 +-
.../servlet/http/HttpServletRequestWrapper.java | 2 +-
java/javax/servlet/http/HttpServletResponse.java | 4 +-
.../servlet/http/HttpServletResponseWrapper.java | 4 +-
java/javax/servlet/http/HttpSession.java | 15 +-
java/javax/servlet/http/HttpSessionContext.java | 6 +-
java/javax/servlet/http/HttpUtils.java | 6 +-
61 files changed, 1870 insertions(+), 2546 deletions(-)
diff --git a/java/javax/servlet/AsyncContext.java b/java/javax/servlet/AsyncContext.java
index 68c86a971d..3910940f46 100644
--- a/java/javax/servlet/AsyncContext.java
+++ b/java/javax/servlet/AsyncContext.java
@@ -26,38 +26,32 @@ public interface AsyncContext {
/**
* The attribute name for the URI of the async request
*/
- String ASYNC_REQUEST_URI =
- "javax.servlet.async.request_uri";
+ String ASYNC_REQUEST_URI = "javax.servlet.async.request_uri";
/**
* The attribute name for the Context Path of the async request
*/
- String ASYNC_CONTEXT_PATH =
- "javax.servlet.async.context_path";
+ String ASYNC_CONTEXT_PATH = "javax.servlet.async.context_path";
/**
* The attribute name for the Mapping of the async request
*/
- String ASYNC_MAPPING =
- "javax.servlet.async.mapping";
+ String ASYNC_MAPPING = "javax.servlet.async.mapping";
/**
* The attribute name for the Path Info of the async request
*/
- String ASYNC_PATH_INFO =
- "javax.servlet.async.path_info";
+ String ASYNC_PATH_INFO = "javax.servlet.async.path_info";
/**
* The attribute name for the Servlet Path of the async request
*/
- String ASYNC_SERVLET_PATH =
- "javax.servlet.async.servlet_path";
+ String ASYNC_SERVLET_PATH = "javax.servlet.async.servlet_path";
/**
* The attribute name for the Query String of the async request
*/
- String ASYNC_QUERY_STRING =
- "javax.servlet.async.query_string";
+ String ASYNC_QUERY_STRING = "javax.servlet.async.query_string";
/**
* @return a reference to the ServletRequest object
@@ -75,41 +69,39 @@ public interface AsyncContext {
boolean hasOriginalRequestAndResponse();
/**
- * @throws IllegalStateException if this method is called when the request
- * is not in asynchronous mode. The request is in asynchronous mode after
- * {@link javax.servlet.http.HttpServletRequest#startAsync()} or
- * {@link javax.servlet.http.HttpServletRequest#startAsync(ServletRequest,
- * ServletResponse)} has been called and before {@link #complete()} or any
- * other dispatch() method has been called.
+ * @throws IllegalStateException if this method is called when the request is not in asynchronous mode. The request
+ * is in asynchronous mode after
+ * {@link javax.servlet.http.HttpServletRequest#startAsync()} or
+ * {@link javax.servlet.http.HttpServletRequest#startAsync(ServletRequest, ServletResponse)}
+ * has been called and before {@link #complete()} or any other dispatch() method
+ * has been called.
*/
void dispatch();
/**
- * @param path The path to which the request/response should be dispatched
- * relative to the {@link ServletContext} from which this async
- * request was started.
+ * @param path The path to which the request/response should be dispatched relative to the {@link ServletContext}
+ * from which this async request was started.
*
- * @throws IllegalStateException if this method is called when the request
- * is not in asynchronous mode. The request is in asynchronous mode after
- * {@link javax.servlet.http.HttpServletRequest#startAsync()} or
- * {@link javax.servlet.http.HttpServletRequest#startAsync(ServletRequest,
- * ServletResponse)} has been called and before {@link #complete()} or any
- * other dispatch() method has been called.
+ * @throws IllegalStateException if this method is called when the request is not in asynchronous mode. The request
+ * is in asynchronous mode after
+ * {@link javax.servlet.http.HttpServletRequest#startAsync()} or
+ * {@link javax.servlet.http.HttpServletRequest#startAsync(ServletRequest, ServletResponse)}
+ * has been called and before {@link #complete()} or any other dispatch() method
+ * has been called.
*/
void dispatch(String path);
/**
- * @param path The path to which the request/response should be dispatched
- * relative to the specified {@link ServletContext}.
- * @param context The {@link ServletContext} to which the request/response
- * should be dispatched.
+ * @param path The path to which the request/response should be dispatched relative to the specified
+ * {@link ServletContext}.
+ * @param context The {@link ServletContext} to which the request/response should be dispatched.
*
- * @throws IllegalStateException if this method is called when the request
- * is not in asynchronous mode. The request is in asynchronous mode after
- * {@link javax.servlet.http.HttpServletRequest#startAsync()} or
- * {@link javax.servlet.http.HttpServletRequest#startAsync(ServletRequest,
- * ServletResponse)} has been called and before {@link #complete()} or any
- * other dispatch() method has been called.
+ * @throws IllegalStateException if this method is called when the request is not in asynchronous mode. The request
+ * is in asynchronous mode after
+ * {@link javax.servlet.http.HttpServletRequest#startAsync()} or
+ * {@link javax.servlet.http.HttpServletRequest#startAsync(ServletRequest, ServletResponse)}
+ * has been called and before {@link #complete()} or any other dispatch() method
+ * has been called.
*/
void dispatch(ServletContext context, String path);
@@ -136,18 +128,19 @@ public interface AsyncContext {
* Adds an event listener that will be called when different AsyncEvents fire
*
* @param listener an AsyncListener that will be called with AsyncEvent objects
- * @param request the ServletRequest that will be passed with the AsyncEvent
+ * @param request the ServletRequest that will be passed with the AsyncEvent
* @param response the ServletResponse that will be passed with the AsyncEvent
*/
- void addListener(AsyncListener listener, ServletRequest request,
- ServletResponse response);
+ void addListener(AsyncListener listener, ServletRequest request, ServletResponse response);
/**
* Creates and returns an AsyncListener object
*
- * @param <T> The type to create that extends AsyncListener
+ * @param <T> The type to create that extends AsyncListener
* @param clazz The class to instantiate to create the listener
+ *
* @return the newly created AsyncListener object
+ *
* @throws ServletException if the listener cannot be created
*/
<T extends AsyncListener> T createListener(Class<T> clazz) throws ServletException;
@@ -155,8 +148,7 @@ public interface AsyncContext {
/**
* Set the timeout.
*
- * @param timeout The timeout in milliseconds. 0 or less indicates no
- * timeout.
+ * @param timeout The timeout in milliseconds. 0 or less indicates no timeout.
*/
void setTimeout(long timeout);
diff --git a/java/javax/servlet/AsyncEvent.java b/java/javax/servlet/AsyncEvent.java
index 00442798bd..d09e5a3cee 100644
--- a/java/javax/servlet/AsyncEvent.java
+++ b/java/javax/servlet/AsyncEvent.java
@@ -30,7 +30,7 @@ public class AsyncEvent {
/**
* Creates an instance using the provide parameters.
*
- * @param context The asynchronous context associated with the event
+ * @param context The asynchronous context associated with the event
*/
public AsyncEvent(AsyncContext context) {
this.context = context;
@@ -42,12 +42,11 @@ public class AsyncEvent {
/**
* Creates an instance using the provide parameters.
*
- * @param context The asynchronous context associated with the event
- * @param request The request associated with the event
- * @param response The response associated with the event
+ * @param context The asynchronous context associated with the event
+ * @param request The request associated with the event
+ * @param response The response associated with the event
*/
- public AsyncEvent(AsyncContext context, ServletRequest request,
- ServletResponse response) {
+ public AsyncEvent(AsyncContext context, ServletRequest request, ServletResponse response) {
this.context = context;
this.request = request;
this.response = response;
@@ -75,8 +74,7 @@ public class AsyncEvent {
* @param response The response associated with the event
* @param throwable The throwable associated with the event
*/
- public AsyncEvent(AsyncContext context, ServletRequest request,
- ServletResponse response, Throwable throwable) {
+ public AsyncEvent(AsyncContext context, ServletRequest request, ServletResponse response, Throwable throwable) {
this.context = context;
this.request = request;
this.response = response;
@@ -86,8 +84,7 @@ public class AsyncEvent {
/**
* Obtain the asynchronous context associated with the event.
*
- * @return The asynchronous context associated with the event or
- * {@code null} if one was not specified
+ * @return The asynchronous context associated with the event or {@code null} if one was not specified
*/
public AsyncContext getAsyncContext() {
return context;
@@ -96,8 +93,7 @@ public class AsyncEvent {
/**
* Obtain the request associated with the event.
*
- * @return The request associated with the event or
- * {@code null} if one was not specified
+ * @return The request associated with the event or {@code null} if one was not specified
*/
public ServletRequest getSuppliedRequest() {
return request;
@@ -106,8 +102,7 @@ public class AsyncEvent {
/**
* Obtain the response associated with the event.
*
- * @return The response associated with the event or
- * {@code null} if one was not specified
+ * @return The response associated with the event or {@code null} if one was not specified
*/
public ServletResponse getSuppliedResponse() {
return response;
@@ -116,8 +111,7 @@ public class AsyncEvent {
/**
* Obtain the throwable associated with the event.
*
- * @return The throwable associated with the event or
- * {@code null} if one was not specified
+ * @return The throwable associated with the event or {@code null} if one was not specified
*/
public Throwable getThrowable() {
return throwable;
diff --git a/java/javax/servlet/AsyncListener.java b/java/javax/servlet/AsyncListener.java
index aa716d51e6..59b488a4fe 100644
--- a/java/javax/servlet/AsyncListener.java
+++ b/java/javax/servlet/AsyncListener.java
@@ -27,47 +27,41 @@ import java.util.EventListener;
public interface AsyncListener extends EventListener {
/**
- * This event is fired after the call to {@link AsyncContext#complete()}
- * has been processed by the container.
+ * This event is fired after the call to {@link AsyncContext#complete()} has been processed by the container.
*
* @param event Provides access to the objects associated with the event
*
- * @throws IOException Should be thrown if an I/O error occurs during the
- * processing of the event
+ * @throws IOException Should be thrown if an I/O error occurs during the processing of the event
*/
void onComplete(AsyncEvent event) throws IOException;
/**
- * This event is fired if an asynchronous operation times out but before
- * the container takes any action as a result of the timeout.
+ * This event is fired if an asynchronous operation times out but before the container takes any action as a result
+ * of the timeout.
*
* @param event Provides access to the objects associated with the event
*
- * @throws IOException Should be thrown if an I/O error occurs during the
- * processing of the event
+ * @throws IOException Should be thrown if an I/O error occurs during the processing of the event
*/
void onTimeout(AsyncEvent event) throws IOException;
/**
- * This event is fired if an error occurs during an asynchronous operation
- * but before the container takes any action as a result of the error.
+ * This event is fired if an error occurs during an asynchronous operation but before the container takes any action
+ * as a result of the error.
*
* @param event Provides access to the objects associated with the event
*
- * @throws IOException Should be thrown if an I/O error occurs during the
- * processing of the event
+ * @throws IOException Should be thrown if an I/O error occurs during the processing of the event
*/
void onError(AsyncEvent event) throws IOException;
/**
- * This event is fired if new call is made to
- * {@link ServletRequest#startAsync()} after the completion of the
+ * This event is fired if new call is made to {@link ServletRequest#startAsync()} after the completion of the
* {@link AsyncContext} to which this listener was added.
*
* @param event Provides access to the objects associated with the event
*
- * @throws IOException Should be thrown if an I/O error occurs during the
- * processing of the event
+ * @throws IOException Should be thrown if an I/O error occurs during the processing of the event
*/
void onStartAsync(AsyncEvent event) throws IOException;
}
diff --git a/java/javax/servlet/DispatcherType.java b/java/javax/servlet/DispatcherType.java
index df2ab5b53a..62cc39bc1f 100644
--- a/java/javax/servlet/DispatcherType.java
+++ b/java/javax/servlet/DispatcherType.java
@@ -17,8 +17,8 @@
package javax.servlet;
/**
- * Enumeration of dispatcher types. Used both to define filter mappings and by
- * Servlets to determine why they were called.
+ * Enumeration of dispatcher types. Used both to define filter mappings and by Servlets to determine why they were
+ * called.
*
* @since Servlet 3.0
*/
@@ -40,15 +40,13 @@ public enum DispatcherType {
REQUEST,
/**
- * {@link AsyncContext#dispatch()}, {@link AsyncContext#dispatch(String)}
- * and
+ * {@link AsyncContext#dispatch()}, {@link AsyncContext#dispatch(String)} and
* {@link AsyncContext#addListener(AsyncListener, ServletRequest, ServletResponse)}
*/
ASYNC,
/**
- * When the container has passed processing to the error handler mechanism
- * such as a defined error page.
+ * When the container has passed processing to the error handler mechanism such as a defined error page.
*/
ERROR
}
diff --git a/java/javax/servlet/Filter.java b/java/javax/servlet/Filter.java
index 06d13fc2e2..351f2f4c56 100644
--- a/java/javax/servlet/Filter.java
+++ b/java/javax/servlet/Filter.java
@@ -19,14 +19,12 @@ package javax.servlet;
import java.io.IOException;
/**
- * A filter is an object that performs filtering tasks on either the request to
- * a resource (a servlet or static content), or on the response from a resource,
- * or both. <br>
+ * A filter is an object that performs filtering tasks on either the request to a resource (a servlet or static
+ * content), or on the response from a resource, or both. <br>
* <br>
- * Filters perform filtering in the <code>doFilter</code> method. Every Filter
- * has access to a FilterConfig object from which it can obtain its
- * initialization parameters, a reference to the ServletContext which it can
- * use, for example, to load resources needed for filtering tasks.
+ * Filters perform filtering in the <code>doFilter</code> method. Every Filter has access to a FilterConfig object from
+ * which it can obtain its initialization parameters, a reference to the ServletContext which it can use, for example,
+ * to load resources needed for filtering tasks.
* <p>
* Filters are configured in the deployment descriptor of a web application
* <p>
@@ -46,75 +44,62 @@ import java.io.IOException;
public interface Filter {
/**
- * Called by the web container to indicate to a filter that it is being
- * placed into service. The servlet container calls the init method exactly
- * once after instantiating the filter. The init method must complete
- * successfully before the filter is asked to do any filtering work.
+ * Called by the web container to indicate to a filter that it is being placed into service. The servlet container
+ * calls the init method exactly once after instantiating the filter. The init method must complete successfully
+ * before the filter is asked to do any filtering work.
* <p>
- * The web container cannot place the filter into service if the init method
- * either:
+ * The web container cannot place the filter into service if the init method either:
* <ul>
* <li>Throws a ServletException</li>
- * <li>Does not return within a time period defined by the web
- * container</li>
+ * <li>Does not return within a time period defined by the web container</li>
* </ul>
* The default implementation is a NO-OP.
*
- * @param filterConfig The configuration information associated with the
- * filter instance being initialised
+ * @param filterConfig The configuration information associated with the filter instance being initialised
*
* @throws ServletException if the initialisation fails
*/
- default void init(FilterConfig filterConfig) throws ServletException {}
+ default void init(FilterConfig filterConfig) throws ServletException {
+ }
/**
- * The <code>doFilter</code> method of the Filter is called by the container
- * each time a request/response pair is passed through the chain due to a
- * client request for a resource at the end of the chain. The FilterChain
- * passed in to this method allows the Filter to pass on the request and
- * response to the next entity in the chain.
+ * The <code>doFilter</code> method of the Filter is called by the container each time a request/response pair is
+ * passed through the chain due to a client request for a resource at the end of the chain. The FilterChain passed
+ * in to this method allows the Filter to pass on the request and response to the next entity in the chain.
* <p>
- * A typical implementation of this method would follow the following
- * pattern:- <br>
+ * A typical implementation of this method would follow the following pattern:- <br>
* 1. Examine the request<br>
- * 2. Optionally wrap the request object with a custom implementation to
- * filter content or headers for input filtering <br>
- * 3. Optionally wrap the response object with a custom implementation to
- * filter content or headers for output filtering <br>
- * 4. a) <strong>Either</strong> invoke the next entity in the chain using
- * the FilterChain object (<code>chain.doFilter()</code>), <br>
- * 4. b) <strong>or</strong> not pass on the request/response pair to the
- * next entity in the filter chain to block the request processing<br>
- * 5. Directly set headers on the response after invocation of the next
- * entity in the filter chain.
+ * 2. Optionally wrap the request object with a custom implementation to filter content or headers for input
+ * filtering <br>
+ * 3. Optionally wrap the response object with a custom implementation to filter content or headers for output
+ * filtering <br>
+ * 4. a) <strong>Either</strong> invoke the next entity in the chain using the FilterChain object
+ * (<code>chain.doFilter()</code>), <br>
+ * 4. b) <strong>or</strong> not pass on the request/response pair to the next entity in the filter chain to block
+ * the request processing<br>
+ * 5. Directly set headers on the response after invocation of the next entity in the filter chain.
*
* @param request The request to process
* @param response The response associated with the request
- * @param chain Provides access to the next filter in the chain for this
- * filter to pass the request and response to for further
- * processing
+ * @param chain Provides access to the next filter in the chain for this filter to pass the request and response
+ * to for further processing
*
- * @throws IOException if an I/O error occurs during this filter's
- * processing of the request
+ * @throws IOException if an I/O error occurs during this filter's processing of the request
* @throws ServletException if the processing fails for any other reason
*/
- void doFilter(ServletRequest request, ServletResponse response,
- FilterChain chain) throws IOException, ServletException;
+ void doFilter(ServletRequest request, ServletResponse response, FilterChain chain)
+ throws IOException, ServletException;
/**
- * Called by the web container to indicate to a filter that it is being
- * taken out of service. This method is only called once all threads within
- * the filter's doFilter method have exited or after a timeout period has
- * passed. After the web container calls this method, it will not call the
- * doFilter method again on this instance of the filter. <br>
+ * Called by the web container to indicate to a filter that it is being taken out of service. This method is only
+ * called once all threads within the filter's doFilter method have exited or after a timeout period has passed.
+ * After the web container calls this method, it will not call the doFilter method again on this instance of the
+ * filter. <br>
* <br>
- *
- * This method gives the filter an opportunity to clean up any resources
- * that are being held (for example, memory, file handles, threads) and make
- * sure that any persistent state is synchronized with the filter's current
- * state in memory.
- *
- * The default implementation is a NO-OP.
+ * This method gives the filter an opportunity to clean up any resources that are being held (for example, memory,
+ * file handles, threads) and make sure that any persistent state is synchronized with the filter's current state in
+ * memory. The default implementation is a NO-OP.
*/
- default void destroy() {}
+ default void destroy() {
+ }
}
diff --git a/java/javax/servlet/FilterChain.java b/java/javax/servlet/FilterChain.java
index 79ec8b7bc2..71951f66a4 100644
--- a/java/javax/servlet/FilterChain.java
+++ b/java/javax/servlet/FilterChain.java
@@ -19,32 +19,26 @@ package javax.servlet;
import java.io.IOException;
/**
- * A FilterChain is an object provided by the servlet container to the developer
- * giving a view into the invocation chain of a filtered request for a resource.
- * Filters use the FilterChain to invoke the next filter in the chain, or if the
- * calling filter is the last filter in the chain, to invoke the resource at the
- * end of the chain.
+ * A FilterChain is an object provided by the servlet container to the developer giving a view into the invocation chain
+ * of a filtered request for a resource. Filters use the FilterChain to invoke the next filter in the chain, or if the
+ * calling filter is the last filter in the chain, to invoke the resource at the end of the chain.
*
* @see Filter
+ *
* @since Servlet 2.3
*/
public interface FilterChain {
/**
- * Causes the next filter in the chain to be invoked, or if the calling
- * filter is the last filter in the chain, causes the resource at the end of
- * the chain to be invoked.
+ * Causes the next filter in the chain to be invoked, or if the calling filter is the last filter in the chain,
+ * causes the resource at the end of the chain to be invoked.
*
- * @param request
- * the request to pass along the chain.
- * @param response
- * the response to pass along the chain.
+ * @param request the request to pass along the chain.
+ * @param response the response to pass along the chain.
*
- * @throws IOException if an I/O error occurs during the processing of the
- * request
+ * @throws IOException if an I/O error occurs during the processing of the request
* @throws ServletException if the processing fails for any other reason
*/
- void doFilter(ServletRequest request, ServletResponse response)
- throws IOException, ServletException;
+ void doFilter(ServletRequest request, ServletResponse response) throws IOException, ServletException;
}
diff --git a/java/javax/servlet/FilterConfig.java b/java/javax/servlet/FilterConfig.java
index 202f70085a..0ea585fb1c 100644
--- a/java/javax/servlet/FilterConfig.java
+++ b/java/javax/servlet/FilterConfig.java
@@ -19,10 +19,10 @@ package javax.servlet;
import java.util.Enumeration;
/**
- * A filter configuration object used by a servlet container to pass information
- * to a filter during initialization.
+ * A filter configuration object used by a servlet container to pass information to a filter during initialization.
*
* @see Filter
+ *
* @since Servlet 2.3
*/
public interface FilterConfig {
@@ -30,43 +30,35 @@ public interface FilterConfig {
/**
* Get the name of the filter.
*
- * @return The filter-name of this filter as defined in the deployment
- * descriptor.
+ * @return The filter-name of this filter as defined in the deployment descriptor.
*/
String getFilterName();
/**
- * Returns a reference to the {@link ServletContext} in which the caller is
- * executing.
+ * Returns a reference to the {@link ServletContext} in which the caller is executing.
*
- * @return {@link ServletContext} object, used by the caller to interact
- * with its servlet container
+ * @return {@link ServletContext} object, used by the caller to interact with its servlet container
*
* @see ServletContext
*/
ServletContext getServletContext();
/**
- * Returns a <code>String</code> containing the value of the named
- * initialization parameter, or <code>null</code> if the parameter does not
- * exist.
+ * Returns a <code>String</code> containing the value of the named initialization parameter, or <code>null</code> if
+ * the parameter does not exist.
*
- * @param name
- * <code>String</code> specifying the name of the initialization
- * parameter
+ * @param name <code>String</code> specifying the name of the initialization parameter
*
- * @return <code>String</code> containing the value of the initialization
- * parameter
+ * @return <code>String</code> containing the value of the initialization parameter
*/
String getInitParameter(String name);
/**
- * Returns the names of the filter's initialization parameters as an
- * <code>Enumeration</code> of <code>String</code> objects, or an empty
- * <code>Enumeration</code> if the filter has no initialization parameters.
+ * Returns the names of the filter's initialization parameters as an <code>Enumeration</code> of <code>String</code>
+ * objects, or an empty <code>Enumeration</code> if the filter has no initialization parameters.
*
- * @return <code>Enumeration</code> of <code>String</code> objects
- * containing the names of the filter's initialization parameters
+ * @return <code>Enumeration</code> of <code>String</code> objects containing the names of the filter's
+ * initialization parameters
*/
Enumeration<String> getInitParameterNames();
diff --git a/java/javax/servlet/FilterRegistration.java b/java/javax/servlet/FilterRegistration.java
index 15f8294983..c9f6bc153e 100644
--- a/java/javax/servlet/FilterRegistration.java
+++ b/java/javax/servlet/FilterRegistration.java
@@ -29,25 +29,19 @@ public interface FilterRegistration extends Registration {
/**
* Add a mapping for this filter to one or more named Servlets.
*
- * @param dispatcherTypes The dispatch types to which this filter should
- * apply
- * @param isMatchAfter Should this filter be applied after any mappings
- * defined in the deployment descriptor
- * (<code>true</code>) or before?
- * @param servletNames Requests mapped to these servlets will be
- * processed by this filter
- * @throws IllegalArgumentException if the list of servlet names is empty
- * or null
- * @throws IllegalStateException if the associated ServletContext has
- * already been initialised
+ * @param dispatcherTypes The dispatch types to which this filter should apply
+ * @param isMatchAfter Should this filter be applied after any mappings defined in the deployment descriptor
+ * (<code>true</code>) or before?
+ * @param servletNames Requests mapped to these servlets will be processed by this filter
+ *
+ * @throws IllegalArgumentException if the list of servlet names is empty or null
+ * @throws IllegalStateException if the associated ServletContext has already been initialised
*/
- void addMappingForServletNames(
- EnumSet<DispatcherType> dispatcherTypes,
- boolean isMatchAfter, String... servletNames);
+ void addMappingForServletNames(EnumSet<DispatcherType> dispatcherTypes, boolean isMatchAfter,
+ String... servletNames);
/**
- * Gets the currently available servlet name mappings of the Filter
- * represented by this FilterRegistration.
+ * Gets the currently available servlet name mappings of the Filter represented by this FilterRegistration.
*
* @return a Collection of the Servlet name mappings
*/
@@ -56,33 +50,26 @@ public interface FilterRegistration extends Registration {
/**
* Add a mapping for this filter to one or more URL patterns.
*
- * @param dispatcherTypes The dispatch types to which this filter should
- * apply
- * @param isMatchAfter Should this filter be applied after any mappings
- * defined in the deployment descriptor
- * (<code>true</code>) or before?
- * @param urlPatterns The URL patterns to which this filter should be
- * applied
- * @throws IllegalArgumentException if the list of URL patterns is empty or
- * null
- * @throws IllegalStateException if the associated ServletContext has
- * already been initialised
+ * @param dispatcherTypes The dispatch types to which this filter should apply
+ * @param isMatchAfter Should this filter be applied after any mappings defined in the deployment descriptor
+ * (<code>true</code>) or before?
+ * @param urlPatterns The URL patterns to which this filter should be applied
+ *
+ * @throws IllegalArgumentException if the list of URL patterns is empty or null
+ * @throws IllegalStateException if the associated ServletContext has already been initialised
*/
- void addMappingForUrlPatterns(
- EnumSet<DispatcherType> dispatcherTypes,
- boolean isMatchAfter, String... urlPatterns);
+ void addMappingForUrlPatterns(EnumSet<DispatcherType> dispatcherTypes, boolean isMatchAfter, String... urlPatterns);
/**
- * Gets the currently available URL pattern mappings of the Filter
- * represented by this FilterRegistration.
+ * Gets the currently available URL pattern mappings of the Filter represented by this FilterRegistration.
*
* @return a Collection of the URL pattern mappings
*/
Collection<String> getUrlPatternMappings();
/**
- * Interface through which a Filter registered via one of the addFilter
- * methods on ServletContext may be further configured.
+ * Interface through which a Filter registered via one of the addFilter methods on ServletContext may be further
+ * configured.
*/
interface Dynamic extends FilterRegistration, Registration.Dynamic {
// No additional methods
diff --git a/java/javax/servlet/GenericFilter.java b/java/javax/servlet/GenericFilter.java
index bdcac0c9ba..284e790ff8 100644
--- a/java/javax/servlet/GenericFilter.java
+++ b/java/javax/servlet/GenericFilter.java
@@ -20,8 +20,8 @@ import java.io.Serializable;
import java.util.Enumeration;
/**
- * Provides a base class that implements the Filter and FilterConfig interfaces
- * to reduce boilerplate when writing new filters.
+ * Provides a base class that implements the Filter and FilterConfig interfaces to reduce boilerplate when writing new
+ * filters.
*
* @see javax.servlet.Filter
* @see javax.servlet.FilterConfig
@@ -53,8 +53,7 @@ public abstract class GenericFilter implements Filter, FilterConfig, Serializabl
/**
* Obtain the FilterConfig used to initialise this Filter instance.
*
- * @return The config previously passed to the {@link #init(FilterConfig)}
- * method
+ * @return The config previously passed to the {@link #init(FilterConfig)} method
*/
public FilterConfig getFilterConfig() {
return filterConfig;
@@ -69,17 +68,16 @@ public abstract class GenericFilter implements Filter, FilterConfig, Serializabl
@Override
public void init(FilterConfig filterConfig) throws ServletException {
- this.filterConfig = filterConfig;
+ this.filterConfig = filterConfig;
init();
}
/**
- * Convenience method for sub-classes to save them having to call
- * <code>super.init(config)</code>. This is a NO-OP by default.
+ * Convenience method for sub-classes to save them having to call <code>super.init(config)</code>. This is a NO-OP
+ * by default.
*
- * @throws ServletException If an exception occurs that interrupts the
- * Filter's normal operation
+ * @throws ServletException If an exception occurs that interrupts the Filter's normal operation
*/
public void init() throws ServletException {
// NO-OP
diff --git a/java/javax/servlet/GenericServlet.java b/java/javax/servlet/GenericServlet.java
index da70a61a6e..0a0ed281cd 100644
--- a/java/javax/servlet/GenericServlet.java
+++ b/java/javax/servlet/GenericServlet.java
@@ -20,41 +20,36 @@ import java.io.IOException;
import java.util.Enumeration;
/**
- * Defines a generic, protocol-independent servlet. To write an HTTP servlet for
- * use on the Web, extend {@link javax.servlet.http.HttpServlet} instead.
+ * Defines a generic, protocol-independent servlet. To write an HTTP servlet for use on the Web, extend
+ * {@link javax.servlet.http.HttpServlet} instead.
* <p>
- * <code>GenericServlet</code> implements the <code>Servlet</code> and
- * <code>ServletConfig</code> interfaces. <code>GenericServlet</code> may be
- * directly extended by a servlet, although it's more common to extend a
+ * <code>GenericServlet</code> implements the <code>Servlet</code> and <code>ServletConfig</code> interfaces.
+ * <code>GenericServlet</code> may be directly extended by a servlet, although it's more common to extend a
* protocol-specific subclass such as <code>HttpServlet</code>.
* <p>
- * <code>GenericServlet</code> makes writing servlets easier. It provides simple
- * versions of the lifecycle methods <code>init</code> and <code>destroy</code>
- * and of the methods in the <code>ServletConfig</code> interface.
- * <code>GenericServlet</code> also implements the <code>log</code> method,
- * declared in the <code>ServletContext</code> interface.
+ * <code>GenericServlet</code> makes writing servlets easier. It provides simple versions of the lifecycle methods
+ * <code>init</code> and <code>destroy</code> and of the methods in the <code>ServletConfig</code> interface.
+ * <code>GenericServlet</code> also implements the <code>log</code> method, declared in the <code>ServletContext</code>
+ * interface.
* <p>
- * To write a generic servlet, you need only override the abstract
- * <code>service</code> method.
+ * To write a generic servlet, you need only override the abstract <code>service</code> method.
*/
-public abstract class GenericServlet implements Servlet, ServletConfig,
- java.io.Serializable {
+public abstract class GenericServlet implements Servlet, ServletConfig, java.io.Serializable {
private static final long serialVersionUID = 1L;
private transient ServletConfig config;
/**
- * Does nothing. All of the servlet initialization is done by one of the
- * <code>init</code> methods.
+ * Does nothing. All of the servlet initialization is done by one of the <code>init</code> methods.
*/
public GenericServlet() {
// NOOP
}
/**
- * Called by the servlet container to indicate to a servlet that the servlet
- * is being taken out of service. See {@link Servlet#destroy}.
+ * Called by the servlet container to indicate to a servlet that the servlet is being taken out of service. See
+ * {@link Servlet#destroy}.
*/
@Override
public void destroy() {
@@ -62,18 +57,15 @@ public abstract class GenericServlet implements Servlet, ServletConfig,
}
/**
- * Returns a <code>String</code> containing the value of the named
- * initialization parameter, or <code>null</code> if the parameter does not
- * exist. See {@link ServletConfig#getInitParameter}.
+ * Returns a <code>String</code> containing the value of the named initialization parameter, or <code>null</code> if
+ * the parameter does not exist. See {@link ServletConfig#getInitParameter}.
* <p>
- * This method is supplied for convenience. It gets the value of the named
- * parameter from the servlet's <code>ServletConfig</code> object.
+ * This method is supplied for convenience. It gets the value of the named parameter from the servlet's
+ * <code>ServletConfig</code> object.
*
- * @param name
- * a <code>String</code> specifying the name of the
- * initialization parameter
- * @return String a <code>String</code> containing the value of the
- * initialization parameter
+ * @param name a <code>String</code> specifying the name of the initialization parameter
+ *
+ * @return String a <code>String</code> containing the value of the initialization parameter
*/
@Override
public String getInitParameter(String name) {
@@ -81,16 +73,15 @@ public abstract class GenericServlet implements Servlet, ServletConfig,
}
/**
- * Returns the names of the servlet's initialization parameters as an
- * <code>Enumeration</code> of <code>String</code> objects, or an empty
- * <code>Enumeration</code> if the servlet has no initialization parameters.
- * See {@link ServletConfig#getInitParameterNames}.
+ * Returns the names of the servlet's initialization parameters as an <code>Enumeration</code> of
+ * <code>String</code> objects, or an empty <code>Enumeration</code> if the servlet has no initialization
+ * parameters. See {@link ServletConfig#getInitParameterNames}.
* <p>
- * This method is supplied for convenience. It gets the parameter names from
- * the servlet's <code>ServletConfig</code> object.
+ * This method is supplied for convenience. It gets the parameter names from the servlet's
+ * <code>ServletConfig</code> object.
*
- * @return Enumeration an enumeration of <code>String</code> objects
- * containing the names of the servlet's initialization parameters
+ * @return Enumeration an enumeration of <code>String</code> objects containing the names of the servlet's
+ * initialization parameters
*/
@Override
public Enumeration<String> getInitParameterNames() {
@@ -100,8 +91,7 @@ public abstract class GenericServlet implements Servlet, ServletConfig,
/**
* Returns this servlet's {@link ServletConfig} object.
*
- * @return ServletConfig the <code>ServletConfig</code> object that
- * initialized this servlet
+ * @return ServletConfig the <code>ServletConfig</code> object that initialized this servlet
*/
@Override
public ServletConfig getServletConfig() {
@@ -109,14 +99,14 @@ public abstract class GenericServlet implements Servlet, ServletConfig,
}
/**
- * Returns a reference to the {@link ServletContext} in which this servlet
- * is running. See {@link ServletConfig#getServletContext}.
+ * Returns a reference to the {@link ServletContext} in which this servlet is running. See
+ * {@link ServletConfig#getServletContext}.
* <p>
- * This method is supplied for convenience. It gets the context from the
- * servlet's <code>ServletConfig</code> object.
+ * This method is supplied for convenience. It gets the context from the servlet's <code>ServletConfig</code>
+ * object.
*
- * @return ServletContext the <code>ServletContext</code> object passed to
- * this servlet by the <code>init</code> method
+ * @return ServletContext the <code>ServletContext</code> object passed to this servlet by the <code>init</code>
+ * method
*/
@Override
public ServletContext getServletContext() {
@@ -124,10 +114,8 @@ public abstract class GenericServlet implements Servlet, ServletConfig,
}
/**
- * Returns information about the servlet, such as author, version, and
- * copyright. By default, this method returns an empty string. Override this
- * method to have it return a meaningful value. See
- * {@link Servlet#getServletInfo}.
+ * Returns information about the servlet, such as author, version, and copyright. By default, this method returns an
+ * empty string. Override this method to have it return a meaningful value. See {@link Servlet#getServletInfo}.
*
* @return String information about this servlet, by default an empty string
*/
@@ -137,19 +125,16 @@ public abstract class GenericServlet implements Servlet, ServletConfig,
}
/**
- * Called by the servlet container to indicate to a servlet that the servlet
- * is being placed into service. See {@link Servlet#init}.
+ * Called by the servlet container to indicate to a servlet that the servlet is being placed into service. See
+ * {@link Servlet#init}.
* <p>
- * This implementation stores the {@link ServletConfig} object it receives
- * from the servlet container for later use. When overriding this form of
- * the method, call <code>super.init(config)</code>.
+ * This implementation stores the {@link ServletConfig} object it receives from the servlet container for later use.
+ * When overriding this form of the method, call <code>super.init(config)</code>.
+ *
+ * @param config the <code>ServletConfig</code> object that contains configuration information for this servlet
+ *
+ * @exception ServletException if an exception occurs that interrupts the servlet's normal operation
*
- * @param config
- * the <code>ServletConfig</code> object that contains
- * configuration information for this servlet
- * @exception ServletException
- * if an exception occurs that interrupts the servlet's
- * normal operation
* @see UnavailableException
*/
@Override
@@ -159,75 +144,55 @@ public abstract class GenericServlet implements Servlet, ServletConfig,
}
/**
- * A convenience method which can be overridden so that there's no need to
- * call <code>super.init(config)</code>.
+ * A convenience method which can be overridden so that there's no need to call <code>super.init(config)</code>.
* <p>
- * Instead of overriding {@link #init(ServletConfig)}, simply override this
- * method and it will be called by
- * <code>GenericServlet.init(ServletConfig config)</code>. The
- * <code>ServletConfig</code> object can still be retrieved via
- * {@link #getServletConfig}.
+ * Instead of overriding {@link #init(ServletConfig)}, simply override this method and it will be called by
+ * <code>GenericServlet.init(ServletConfig config)</code>. The <code>ServletConfig</code> object can still be
+ * retrieved via {@link #getServletConfig}.
*
- * @exception ServletException
- * if an exception occurs that interrupts the servlet's
- * normal operation
+ * @exception ServletException if an exception occurs that interrupts the servlet's normal operation
*/
public void init() throws ServletException {
// NOOP by default
}
/**
- * Writes the specified message to a servlet log file, prepended by the
- * servlet's name. See {@link ServletContext#log(String)}.
+ * Writes the specified message to a servlet log file, prepended by the servlet's name. See
+ * {@link ServletContext#log(String)}.
*
- * @param message
- * a <code>String</code> specifying the message to be written to
- * the log file
+ * @param message a <code>String</code> specifying the message to be written to the log file
*/
public void log(String message) {
getServletContext().log(getServletName() + ": " + message);
}
/**
- * Writes an explanatory message and a stack trace for a given
- * <code>Throwable</code> exception to the servlet log file, prepended by
- * the servlet's name. See {@link ServletContext#log(String, Throwable)}.
+ * Writes an explanatory message and a stack trace for a given <code>Throwable</code> exception to the servlet log
+ * file, prepended by the servlet's name. See {@link ServletContext#log(String, Throwable)}.
*
- * @param message
- * a <code>String</code> that describes the error or exception
- * @param t
- * the <code>java.lang.Throwable</code> error or exception
+ * @param message a <code>String</code> that describes the error or exception
+ * @param t the <code>java.lang.Throwable</code> error or exception
*/
public void log(String message, Throwable t) {
getServletContext().log(getServletName() + ": " + message, t);
}
/**
- * Called by the servlet container to allow the servlet to respond to a
- * request. See {@link Servlet#service}.
+ * Called by the servlet container to allow the servlet to respond to a request. See {@link Servlet#service}.
* <p>
- * This method is declared abstract so subclasses, such as
- * <code>HttpServlet</code>, must override it.
+ * This method is declared abstract so subclasses, such as <code>HttpServlet</code>, must override it.
+ *
+ * @param req the <code>ServletRequest</code> object that contains the client's request
+ * @param res the <code>ServletResponse</code> object that will contain the servlet's response
*
- * @param req
- * the <code>ServletRequest</code> object that contains the
- * client's request
- * @param res
- * the <code>ServletResponse</code> object that will contain the
- * servlet's response
- * @exception ServletException
- * if an exception occurs that interferes with the servlet's
- * normal operation occurred
- * @exception IOException
- * if an input or output exception occurs
+ * @exception ServletException if an exception occurs that interferes with the servlet's normal operation occurred
+ * @exception IOException if an input or output exception occurs
*/
@Override
- public abstract void service(ServletRequest req, ServletResponse res)
- throws ServletException, IOException;
+ public abstract void service(ServletRequest req, ServletResponse res) throws ServletException, IOException;
/**
- * Returns the name of this servlet instance. See
- * {@link ServletConfig#getServletName}.
+ * Returns the name of this servlet instance. See {@link ServletConfig#getServletName}.
*
* @return the name of this servlet instance
*/
diff --git a/java/javax/servlet/HttpConstraintElement.java b/java/javax/servlet/HttpConstraintElement.java
index fd55c869be..faab1e6aea 100644
--- a/java/javax/servlet/HttpConstraintElement.java
+++ b/java/javax/servlet/HttpConstraintElement.java
@@ -22,8 +22,7 @@ import javax.servlet.annotation.ServletSecurity.EmptyRoleSemantic;
import javax.servlet.annotation.ServletSecurity.TransportGuarantee;
/**
- * Equivalent of {@link javax.servlet.annotation.HttpConstraint} for
- * programmatic configuration of security constraints.
+ * Equivalent of {@link javax.servlet.annotation.HttpConstraint} for programmatic configuration of security constraints.
*
* @since Servlet 3.0
*/
@@ -47,11 +46,9 @@ public class HttpConstraintElement {
}
/**
- * Construct a constraint with an empty role semantic. Typically used with
- * {@link EmptyRoleSemantic#DENY}.
+ * Construct a constraint with an empty role semantic. Typically used with {@link EmptyRoleSemantic#DENY}.
*
- * @param emptyRoleSemantic The empty role semantic to apply to the newly
- * created constraint
+ * @param emptyRoleSemantic The empty role semantic to apply to the newly created constraint
*/
public HttpConstraintElement(EmptyRoleSemantic emptyRoleSemantic) {
this.emptyRoleSemantic = emptyRoleSemantic;
@@ -62,36 +59,28 @@ public class HttpConstraintElement {
/**
* Construct a constraint with a transport guarantee and roles.
*
- * @param transportGuarantee The transport guarantee to apply to the newly
- * created constraint
- * @param rolesAllowed The roles to associate with the newly created
- * constraint
+ * @param transportGuarantee The transport guarantee to apply to the newly created constraint
+ * @param rolesAllowed The roles to associate with the newly created constraint
*/
- public HttpConstraintElement(TransportGuarantee transportGuarantee,
- String... rolesAllowed) {
+ public HttpConstraintElement(TransportGuarantee transportGuarantee, String... rolesAllowed) {
this.emptyRoleSemantic = EmptyRoleSemantic.PERMIT;
this.transportGuarantee = transportGuarantee;
this.rolesAllowed = rolesAllowed;
}
/**
- * Construct a constraint with an empty role semantic, a transport guarantee
- * and roles.
+ * Construct a constraint with an empty role semantic, a transport guarantee and roles.
+ *
+ * @param emptyRoleSemantic The empty role semantic to apply to the newly created constraint
+ * @param transportGuarantee The transport guarantee to apply to the newly created constraint
+ * @param rolesAllowed The roles to associate with the newly created constraint
*
- * @param emptyRoleSemantic The empty role semantic to apply to the newly
- * created constraint
- * @param transportGuarantee The transport guarantee to apply to the newly
- * created constraint
- * @param rolesAllowed The roles to associate with the newly created
- * constraint
* @throws IllegalArgumentException if roles are specified when DENY is used
*/
- public HttpConstraintElement(EmptyRoleSemantic emptyRoleSemantic,
- TransportGuarantee transportGuarantee, String... rolesAllowed) {
- if (rolesAllowed != null && rolesAllowed.length > 0 &&
- EmptyRoleSemantic.DENY.equals(emptyRoleSemantic)) {
- throw new IllegalArgumentException(lStrings.getString(
- "httpConstraintElement.invalidRolesDeny"));
+ public HttpConstraintElement(EmptyRoleSemantic emptyRoleSemantic, TransportGuarantee transportGuarantee,
+ String... rolesAllowed) {
+ if (rolesAllowed != null && rolesAllowed.length > 0 && EmptyRoleSemantic.DENY.equals(emptyRoleSemantic)) {
+ throw new IllegalArgumentException(lStrings.getString("httpConstraintElement.invalidRolesDeny"));
}
this.emptyRoleSemantic = emptyRoleSemantic;
this.transportGuarantee = transportGuarantee;
@@ -100,6 +89,7 @@ public class HttpConstraintElement {
/**
* TODO
+ *
* @return TODO
*/
public EmptyRoleSemantic getEmptyRoleSemantic() {
@@ -108,6 +98,7 @@ public class HttpConstraintElement {
/**
* TODO
+ *
* @return TODO
*/
public TransportGuarantee getTransportGuarantee() {
@@ -116,6 +107,7 @@ public class HttpConstraintElement {
/**
* TODO
+ *
* @return TODO
*/
public String[] getRolesAllowed() {
diff --git a/java/javax/servlet/HttpMethodConstraintElement.java b/java/javax/servlet/HttpMethodConstraintElement.java
index 7645856b2f..da27bc189a 100644
--- a/java/javax/servlet/HttpMethodConstraintElement.java
+++ b/java/javax/servlet/HttpMethodConstraintElement.java
@@ -19,8 +19,7 @@ package javax.servlet;
import java.util.ResourceBundle;
/**
- * Programmatic equivalent of a security constraint defined for a single HTTP
- * method.
+ * Programmatic equivalent of a security constraint defined for a single HTTP method.
*
* @since Servlet 3.0
*/
@@ -33,43 +32,35 @@ public class HttpMethodConstraintElement extends HttpConstraintElement {
private final String methodName;
/**
- * Construct an instance for the given HTTP method name and a default
- * {@link HttpConstraintElement}.
+ * Construct an instance for the given HTTP method name and a default {@link HttpConstraintElement}.
*
- * @param methodName The HTTP method name
+ * @param methodName The HTTP method name
*/
public HttpMethodConstraintElement(String methodName) {
if (methodName == null || methodName.length() == 0) {
- throw new IllegalArgumentException(lStrings.getString(
- "httpMethodConstraintElement.invalidMethod"));
+ throw new IllegalArgumentException(lStrings.getString("httpMethodConstraintElement.invalidMethod"));
}
this.methodName = methodName;
}
/**
- * Construct an instance for the given HTTP method name and
- * {@link HttpConstraintElement}.
+ * Construct an instance for the given HTTP method name and {@link HttpConstraintElement}.
*
- * @param methodName The HTTP method name
- * @param constraint The constraint for the given method
+ * @param methodName The HTTP method name
+ * @param constraint The constraint for the given method
*/
- public HttpMethodConstraintElement(String methodName,
- HttpConstraintElement constraint) {
- super(constraint.getEmptyRoleSemantic(),
- constraint.getTransportGuarantee(),
- constraint.getRolesAllowed());
+ public HttpMethodConstraintElement(String methodName, HttpConstraintElement constraint) {
+ super(constraint.getEmptyRoleSemantic(), constraint.getTransportGuarantee(), constraint.getRolesAllowed());
if (methodName == null || methodName.length() == 0) {
- throw new IllegalArgumentException(lStrings.getString(
- "httpMethodConstraintElement.invalidMethod"));
+ throw new IllegalArgumentException(lStrings.getString("httpMethodConstraintElement.invalidMethod"));
}
this.methodName = methodName;
}
/**
- * Obtain the name of the HTTP method for which this constraint was
- * created.
+ * Obtain the name of the HTTP method for which this constraint was created.
*
- * @return The HTTP method name as provided to the constructor
+ * @return The HTTP method name as provided to the constructor
*/
public String getMethodName() {
return methodName;
diff --git a/java/javax/servlet/MultipartConfigElement.java b/java/javax/servlet/MultipartConfigElement.java
index c49a0ffa63..0583cbf51b 100644
--- a/java/javax/servlet/MultipartConfigElement.java
+++ b/java/javax/servlet/MultipartConfigElement.java
@@ -19,9 +19,8 @@ package javax.servlet;
import javax.servlet.annotation.MultipartConfig;
/**
- * The programmatic equivalent of
- * {@link javax.servlet.annotation.MultipartConfig} used to configure
- * multi-part handling for a Servlet when registering a Servlet via code.
+ * The programmatic equivalent of {@link javax.servlet.annotation.MultipartConfig} used to configure multi-part handling
+ * for a Servlet when registering a Servlet via code.
*
* @since Servlet 3.0
*/
@@ -33,10 +32,10 @@ public class MultipartConfigElement {
private final int fileSizeThreshold;// = 0;
/**
- * Create a programmatic multi-part configuration with a specific location
- * and defaults for the remaining configuration elements.
+ * Create a programmatic multi-part configuration with a specific location and defaults for the remaining
+ * configuration elements.
*
- * @param location The temporary location to store files
+ * @param location The temporary location to store files
*/
public MultipartConfigElement(String location) {
// Keep empty string default if location is null
@@ -51,18 +50,15 @@ public class MultipartConfigElement {
}
/**
- * Create a programmatic multi-part configuration from the individual
- * configuration elements.
+ * Create a programmatic multi-part configuration from the individual configuration elements.
*
* @param location The temporary location to store files
* @param maxFileSize The maximum permitted size for a single file
* @param maxRequestSize The maximum permitted size for a request
- * @param fileSizeThreshold The size above which the file is save in the
- * temporary location rather than retained in
+ * @param fileSizeThreshold The size above which the file is save in the temporary location rather than retained in
* memory.
*/
- public MultipartConfigElement(String location, long maxFileSize,
- long maxRequestSize, int fileSizeThreshold) {
+ public MultipartConfigElement(String location, long maxFileSize, long maxRequestSize, int fileSizeThreshold) {
// Keep empty string default if location is null
if (location != null) {
this.location = location;
@@ -83,8 +79,7 @@ public class MultipartConfigElement {
/**
* Create a programmatic configuration from an annotation.
*
- * @param annotation The source annotation to copy to create the
- * programmatic equivalent.
+ * @param annotation The source annotation to copy to create the programmatic equivalent.
*/
public MultipartConfigElement(MultipartConfig annotation) {
location = annotation.location();
@@ -121,11 +116,9 @@ public class MultipartConfigElement {
}
/**
- * Obtain the size above which the file is save in the temporary location
- * rather than retained in memory.
+ * Obtain the size above which the file is save in the temporary location rather than retained in memory.
*
- * @return the size above which the file is save in the temporary location
- * rather than retained in memory.
+ * @return the size above which the file is save in the temporary location rather than retained in memory.
*/
public int getFileSizeThreshold() {
return fileSizeThreshold;
diff --git a/java/javax/servlet/ReadListener.java b/java/javax/servlet/ReadListener.java
index ecf5b61a88..2bfe552e42 100644
--- a/java/javax/servlet/ReadListener.java
+++ b/java/javax/servlet/ReadListener.java
@@ -23,14 +23,12 @@ import java.io.IOException;
*
* @since Servlet 3.1
*/
-public interface ReadListener extends java.util.EventListener{
+public interface ReadListener extends java.util.EventListener {
/**
- * Invoked when data is available to read. The container will invoke this
- * method the first time for a request as soon as there is data to read.
- * Subsequent invocations will only occur if a call to
- * {@link ServletInputStream#isReady()} has returned false and data has
- * subsequently become available to read.
+ * Invoked when data is available to read. The container will invoke this method the first time for a request as
+ * soon as there is data to read. Subsequent invocations will only occur if a call to
+ * {@link ServletInputStream#isReady()} has returned false and data has subsequently become available to read.
*
* @throws IOException id an I/O error occurs while processing the event
*/
diff --git a/java/javax/servlet/Registration.java b/java/javax/servlet/Registration.java
index b0caa986c2..2bfaa6e72d 100644
--- a/java/javax/servlet/Registration.java
+++ b/java/javax/servlet/Registration.java
@@ -45,65 +45,60 @@ public interface Registration {
*
* @param name Name of initialisation parameter
* @param value Value of initialisation parameter
- * @return <code>true</code> if the initialisation parameter was set,
- * <code>false</code> if the initialisation parameter was not set
- * because an initialisation parameter of the same name already
- * existed
+ *
+ * @return <code>true</code> if the initialisation parameter was set, <code>false</code> if the initialisation
+ * parameter was not set because an initialisation parameter of the same name already existed
+ *
* @throws IllegalArgumentException if name or value is <code>null</code>
- * @throws IllegalStateException if the ServletContext associated with this
- * registration has already been initialised
+ * @throws IllegalStateException if the ServletContext associated with this registration has already been
+ * initialised
*/
boolean setInitParameter(String name, String value);
/**
* Get the value of an initialisation parameter.
*
- * @param name The initialisation parameter whose value is required
+ * @param name The initialisation parameter whose value is required
*
* @return The value of the named initialisation parameter
*/
String getInitParameter(String name);
/**
- * Add multiple initialisation parameters. If any of the supplied
- * initialisation parameter conflicts with an existing initialisation
- * parameter, no updates will be performed.
+ * Add multiple initialisation parameters. If any of the supplied initialisation parameter conflicts with an
+ * existing initialisation parameter, no updates will be performed.
*
* @param initParameters The initialisation parameters to add
*
- * @return The set of initialisation parameter names that conflicted with
- * existing initialisation parameter. If there are no conflicts,
- * this Set will be empty.
- * @throws IllegalArgumentException if any of the supplied initialisation
- * parameters have a null name or value
- * @throws IllegalStateException if the ServletContext associated with this
- * registration has already been initialised
+ * @return The set of initialisation parameter names that conflicted with existing initialisation parameter. If
+ * there are no conflicts, this Set will be empty.
+ *
+ * @throws IllegalArgumentException if any of the supplied initialisation parameters have a null name or value
+ * @throws IllegalStateException if the ServletContext associated with this registration has already been
+ * initialised
*/
Set<String> setInitParameters(Map<String,String> initParameters);
/**
* Get the names and values of all the initialisation parameters.
*
- * @return A Map of initialisation parameter names and associated values
- * keyed by name
+ * @return A Map of initialisation parameter names and associated values keyed by name
*/
- Map<String, String> getInitParameters();
+ Map<String,String> getInitParameters();
/**
- * Interface through which a Servlet or Filter registered via one of the
- * addServlet or addFilter methods, respectively, on ServletContext may be
- * further configured.
+ * Interface through which a Servlet or Filter registered via one of the addServlet or addFilter methods,
+ * respectively, on ServletContext may be further configured.
*/
interface Dynamic extends Registration {
/**
* Mark this Servlet/Filter as supported asynchronous processing.
*
- * @param isAsyncSupported Should this Servlet/Filter support
- * asynchronous processing
+ * @param isAsyncSupported Should this Servlet/Filter support asynchronous processing
*
- * @throws IllegalStateException if the ServletContext associated with
- * this registration has already been initialised
+ * @throws IllegalStateException if the ServletContext associated with this registration has already been
+ * initialised
*/
void setAsyncSupported(boolean isAsyncSupported);
}
diff --git a/java/javax/servlet/RequestDispatcher.java b/java/javax/servlet/RequestDispatcher.java
index c675295985..47a6ef40e9 100644
--- a/java/javax/servlet/RequestDispatcher.java
+++ b/java/javax/servlet/RequestDispatcher.java
@@ -19,15 +19,12 @@ package javax.servlet;
import java.io.IOException;
/**
- * Defines an object that receives requests from the client and sends them to
- * any resource (such as a servlet, HTML file, or JSP file) on the server. The
- * servlet container creates the <code>RequestDispatcher</code> object, which is
- * used as a wrapper around a server resource located at a particular path or
- * given by a particular name.
- *
+ * Defines an object that receives requests from the client and sends them to any resource (such as a servlet, HTML
+ * file, or JSP file) on the server. The servlet container creates the <code>RequestDispatcher</code> object, which is
+ * used as a wrapper around a server resource located at a particular path or given by a particular name.
* <p>
- * This interface is intended to wrap servlets, but a servlet container can
- * create <code>RequestDispatcher</code> objects to wrap any type of resource.
+ * This interface is intended to wrap servlets, but a servlet container can create <code>RequestDispatcher</code>
+ * objects to wrap any type of resource.
*
* @see ServletContext#getRequestDispatcher(java.lang.String)
* @see ServletContext#getNamedDispatcher(java.lang.String)
@@ -36,280 +33,228 @@ import java.io.IOException;
public interface RequestDispatcher {
/**
- * The name of the request attribute that should be set by the container
- * when the {@link #forward(ServletRequest, ServletResponse)} method is
- * called. It provides the original value of a path-related property of the
- * request. See the chapter "Forwarded Request Parameters" in the Servlet
- * Specification for details.
+ * The name of the request attribute that should be set by the container when the
+ * {@link #forward(ServletRequest, ServletResponse)} method is called. It provides the original value of a
+ * path-related property of the request. See the chapter "Forwarded Request Parameters" in the Servlet Specification
+ * for details.
*
* @since Servlet 3.0
*/
String FORWARD_REQUEST_URI = "javax.servlet.forward.request_uri";
/**
- * The name of the request attribute that should be set by the container
- * when the {@link #forward(ServletRequest, ServletResponse)} method is
- * called. It provides the original value of a path-related property of the
- * request. See the chapter "Forwarded Request Parameters" in the Servlet
- * Specification for details.
+ * The name of the request attribute that should be set by the container when the
+ * {@link #forward(ServletRequest, ServletResponse)} method is called. It provides the original value of a
+ * path-related property of the request. See the chapter "Forwarded Request Parameters" in the Servlet Specification
+ * for details.
*
* @since Servlet 3.0
*/
String FORWARD_CONTEXT_PATH = "javax.servlet.forward.context_path";
/**
- * The name of the request attribute that should be set by the container
- * when the {@link #forward(ServletRequest, ServletResponse)} method is
- * called. It provides the original value of a path-related property of the
- * request. See the chapter "Forwarded Request Parameters" in the Servlet
- * Specification for details.
+ * The name of the request attribute that should be set by the container when the
+ * {@link #forward(ServletRequest, ServletResponse)} method is called. It provides the original value of a
+ * path-related property of the request. See the chapter "Forwarded Request Parameters" in the Servlet Specification
+ * for details.
*
* @since Servlet 4.0
*/
String FORWARD_MAPPING = "javax.servlet.forward.mapping";
/**
- * The name of the request attribute that should be set by the container
- * when the {@link #forward(ServletRequest, ServletResponse)} method is
- * called. It provides the original value of a path-related property of the
- * request. See the chapter "Forwarded Request Parameters" in the Servlet
- * Specification for details.
+ * The name of the request attribute that should be set by the container when the
+ * {@link #forward(ServletRequest, ServletResponse)} method is called. It provides the original value of a
+ * path-related property of the request. See the chapter "Forwarded Request Parameters" in the Servlet Specification
+ * for details.
*
* @since Servlet 3.0
*/
String FORWARD_PATH_INFO = "javax.servlet.forward.path_info";
/**
- * The name of the request attribute that should be set by the container
- * when the {@link #forward(ServletRequest, ServletResponse)} method is
- * called. It provides the original value of a path-related property of the
- * request. See the chapter "Forwarded Request Parameters" in the Servlet
- * Specification for details.
+ * The name of the request attribute that should be set by the container when the
+ * {@link #forward(ServletRequest, ServletResponse)} method is called. It provides the original value of a
+ * path-related property of the request. See the chapter "Forwarded Request Parameters" in the Servlet Specification
+ * for details.
*
* @since Servlet 3.0
*/
String FORWARD_SERVLET_PATH = "javax.servlet.forward.servlet_path";
/**
- * The name of the request attribute that should be set by the container
- * when the {@link #forward(ServletRequest, ServletResponse)} method is
- * called. It provides the original value of a path-related property of the
- * request. See the chapter "Forwarded Request Parameters" in the Servlet
- * Specification for details.
+ * The name of the request attribute that should be set by the container when the
+ * {@link #forward(ServletRequest, ServletResponse)} method is called. It provides the original value of a
+ * path-related property of the request. See the chapter "Forwarded Request Parameters" in the Servlet Specification
+ * for details.
*
* @since Servlet 3.0
*/
String FORWARD_QUERY_STRING = "javax.servlet.forward.query_string";
/**
- * The name of the request attribute that should be set by the container
- * when the {@link #include(ServletRequest, ServletResponse)} method is
- * called on the {@code RequestDispatcher} obtained by a path and not by a
- * name. It provides information on the path that was used to obtain the
- * {@code RequestDispatcher} instance for this include call. See the chapter
- * "Included Request Parameters" in the Servlet Specification for details.
+ * The name of the request attribute that should be set by the container when the
+ * {@link #include(ServletRequest, ServletResponse)} method is called on the {@code RequestDispatcher} obtained by a
+ * path and not by a name. It provides information on the path that was used to obtain the {@code RequestDispatcher}
+ * instance for this include call. See the chapter "Included Request Parameters" in the Servlet Specification for
+ * details.
*
* @since Servlet 3.0
*/
String INCLUDE_REQUEST_URI = "javax.servlet.include.request_uri";
/**
- * The name of the request attribute that should be set by the container
- * when the {@link #include(ServletRequest, ServletResponse)} method is
- * called on the {@code RequestDispatcher} obtained by a path and not by a
- * name. It provides information on the path that was used to obtain the
- * {@code RequestDispatcher} instance for this include call. See the chapter
- * "Included Request Parameters" in the Servlet Specification for details.
+ * The name of the request attribute that should be set by the container when the
+ * {@link #include(ServletRequest, ServletResponse)} method is called on the {@code RequestDispatcher} obtained by a
+ * path and not by a name. It provides information on the path that was used to obtain the {@code RequestDispatcher}
+ * instance for this include call. See the chapter "Included Request Parameters" in the Servlet Specification for
+ * details.
*
* @since Servlet 3.0
*/
String INCLUDE_CONTEXT_PATH = "javax.servlet.include.context_path";
/**
- * The name of the request attribute that should be set by the container
- * when the {@link #include(ServletRequest, ServletResponse)} method is
- * called on the {@code RequestDispatcher} obtained by a path and not by a
- * name. It provides information on the path that was used to obtain the
- * {@code RequestDispatcher} instance for this include call. See the chapter
- * "Included Request Parameters" in the Servlet Specification for details.
+ * The name of the request attribute that should be set by the container when the
+ * {@link #include(ServletRequest, ServletResponse)} method is called on the {@code RequestDispatcher} obtained by a
+ * path and not by a name. It provides information on the path that was used to obtain the {@code RequestDispatcher}
+ * instance for this include call. See the chapter "Included Request Parameters" in the Servlet Specification for
+ * details.
*
* @since Servlet 3.0
*/
String INCLUDE_PATH_INFO = "javax.servlet.include.path_info";
/**
- * The name of the request attribute that should be set by the container
- * when the {@link #include(ServletRequest, ServletResponse)} method is
- * called on the {@code RequestDispatcher} obtained by a path and not by a
- * name. It provides information on the path that was used to obtain the
- * {@code RequestDispatcher} instance for this include call. See the chapter
- * "Included Request Parameters" in the Servlet Specification for details.
+ * The name of the request attribute that should be set by the container when the
+ * {@link #include(ServletRequest, ServletResponse)} method is called on the {@code RequestDispatcher} obtained by a
+ * path and not by a name. It provides information on the path that was used to obtain the {@code RequestDispatcher}
+ * instance for this include call. See the chapter "Included Request Parameters" in the Servlet Specification for
+ * details.
*
* @since Servlet 4.0
*/
String INCLUDE_MAPPING = "javax.servlet.include.mapping";
/**
- * The name of the request attribute that should be set by the container
- * when the {@link #include(ServletRequest, ServletResponse)} method is
- * called on the {@code RequestDispatcher} obtained by a path and not by a
- * name. It provides information on the path that was used to obtain the
- * {@code RequestDispatcher} instance for this include call. See the chapter
- * "Included Request Parameters" in the Servlet Specification for details.
+ * The name of the request attribute that should be set by the container when the
+ * {@link #include(ServletRequest, ServletResponse)} method is called on the {@code RequestDispatcher} obtained by a
+ * path and not by a name. It provides information on the path that was used to obtain the {@code RequestDispatcher}
+ * instance for this include call. See the chapter "Included Request Parameters" in the Servlet Specification for
+ * details.
*
* @since Servlet 3.0
*/
String INCLUDE_SERVLET_PATH = "javax.servlet.include.servlet_path";
/**
- * The name of the request attribute that should be set by the container
- * when the {@link #include(ServletRequest, ServletResponse)} method is
- * called on the {@code RequestDispatcher} obtained by a path and not by a
- * name. It provides information on the path that was used to obtain the
- * {@code RequestDispatcher} instance for this include call. See the chapter
- * "Included Request Parameters" in the Servlet Specification for details.
+ * The name of the request attribute that should be set by the container when the
+ * {@link #include(ServletRequest, ServletResponse)} method is called on the {@code RequestDispatcher} obtained by a
+ * path and not by a name. It provides information on the path that was used to obtain the {@code RequestDispatcher}
+ * instance for this include call. See the chapter "Included Request Parameters" in the Servlet Specification for
+ * details.
*
* @since Servlet 3.0
*/
String INCLUDE_QUERY_STRING = "javax.servlet.include.query_string";
/**
- * The name of the request attribute that should be set by the container
- * when custom error-handling servlet or JSP page is invoked. The value of
- * the attribute is of type {@code java.lang.Throwable}. See the chapter
- * "Error Handling" in the Servlet Specification for details.
+ * The name of the request attribute that should be set by the container when custom error-handling servlet or JSP
+ * page is invoked. The value of the attribute is of type {@code java.lang.Throwable}. See the chapter "Error
+ * Handling" in the Servlet Specification for details.
*
* @since Servlet 3.0
*/
String ERROR_EXCEPTION = "javax.servlet.error.exception";
/**
- * The name of the request attribute that should be set by the container
- * when custom error-handling servlet or JSP page is invoked. The value of
- * the attribute is of type {@code java.lang.Class}. See the chapter
- * "Error Handling" in the Servlet Specification for details.
+ * The name of the request attribute that should be set by the container when custom error-handling servlet or JSP
+ * page is invoked. The value of the attribute is of type {@code java.lang.Class}. See the chapter "Error Handling"
+ * in the Servlet Specification for details.
*
* @since Servlet 3.0
*/
String ERROR_EXCEPTION_TYPE = "javax.servlet.error.exception_type";
/**
- * The name of the request attribute that should be set by the container
- * when custom error-handling servlet or JSP page is invoked. The value of
- * the attribute is of type {@code java.lang.String}. See the chapter
- * "Error Handling" in the Servlet Specification for details.
+ * The name of the request attribute that should be set by the container when custom error-handling servlet or JSP
+ * page is invoked. The value of the attribute is of type {@code java.lang.String}. See the chapter "Error Handling"
+ * in the Servlet Specification for details.
*
* @since Servlet 3.0
*/
String ERROR_MESSAGE = "javax.servlet.error.message";
/**
- * The name of the request attribute that should be set by the container
- * when custom error-handling servlet or JSP page is invoked. The value of
- * the attribute is of type {@code java.lang.String}. See the chapter
- * "Error Handling" in the Servlet Specification for details.
+ * The name of the request attribute that should be set by the container when custom error-handling servlet or JSP
+ * page is invoked. The value of the attribute is of type {@code java.lang.String}. See the chapter "Error Handling"
+ * in the Servlet Specification for details.
*
* @since Servlet 3.0
*/
String ERROR_REQUEST_URI = "javax.servlet.error.request_uri";
/**
- * The name of the request attribute that should be set by the container
- * when custom error-handling servlet or JSP page is invoked. The value of
- * the attribute is of type {@code java.lang.String}. See the chapter
- * "Error Handling" in the Servlet Specification for details.
+ * The name of the request attribute that should be set by the container when custom error-handling servlet or JSP
+ * page is invoked. The value of the attribute is of type {@code java.lang.String}. See the chapter "Error Handling"
+ * in the Servlet Specification for details.
*
* @since Servlet 3.0
*/
String ERROR_SERVLET_NAME = "javax.servlet.error.servlet_name";
/**
- * The name of the request attribute that should be set by the container
- * when custom error-handling servlet or JSP page is invoked. The value of
- * the attribute is of type {@code java.lang.Integer}. See the chapter
- * "Error Handling" in the Servlet Specification for details.
+ * The name of the request attribute that should be set by the container when custom error-handling servlet or JSP
+ * page is invoked. The value of the attribute is of type {@code java.lang.Integer}. See the chapter "Error
+ * Handling" in the Servlet Specification for details.
*
* @since Servlet 3.0
*/
String ERROR_STATUS_CODE = "javax.servlet.error.status_code";
/**
- * Forwards a request from a servlet to another resource (servlet, JSP file,
- * or HTML file) on the server. This method allows one servlet to do
- * preliminary processing of a request and another resource to generate the
+ * Forwards a request from a servlet to another resource (servlet, JSP file, or HTML file) on the server. This
+ * method allows one servlet to do preliminary processing of a request and another resource to generate the
* response.
- *
* <p>
- * For a <code>RequestDispatcher</code> obtained via
- * <code>getRequestDispatcher()</code>, the <code>ServletRequest</code>
- * object has its path elements and parameters adjusted to match the path of
- * the target resource.
- *
+ * For a <code>RequestDispatcher</code> obtained via <code>getRequestDispatcher()</code>, the
+ * <code>ServletRequest</code> object has its path elements and parameters adjusted to match the path of the target
+ * resource.
* <p>
- * <code>forward</code> should be called before the response has been
- * committed to the client (before response body output has been flushed).
- * If the response already has been committed, this method throws an
- * <code>IllegalStateException</code>. Uncommitted output in the response
- * buffer is automatically cleared before the forward.
- *
+ * <code>forward</code> should be called before the response has been committed to the client (before response body
+ * output has been flushed). If the response already has been committed, this method throws an
+ * <code>IllegalStateException</code>. Uncommitted output in the response buffer is automatically cleared before the
+ * forward.
* <p>
- * The request and response parameters must be either the same objects as
- * were passed to the calling servlet's service method or be subclasses of
- * the {@link ServletRequestWrapper} or {@link ServletResponseWrapper}
- * classes that wrap them.
- *
- *
- * @param request
- * a {@link ServletRequest} object that represents the request
- * the client makes of the servlet
+ * The request and response parameters must be either the same objects as were passed to the calling servlet's
+ * service method or be subclasses of the {@link ServletRequestWrapper} or {@link ServletResponseWrapper} classes
+ * that wrap them.
*
- * @param response
- * a {@link ServletResponse} object that represents the response
- * the servlet returns to the client
+ * @param request a {@link ServletRequest} object that represents the request the client makes of the servlet
+ * @param response a {@link ServletResponse} object that represents the response the servlet returns to the client
*
- * @exception ServletException
- * if the target resource throws this exception
- *
- * @exception IOException
- * if the target resource throws this exception
- *
- * @exception IllegalStateException
- * if the response was already committed
+ * @exception ServletException if the target resource throws this exception
+ * @exception IOException if the target resource throws this exception
+ * @exception IllegalStateException if the response was already committed
*/
- void forward(ServletRequest request, ServletResponse response)
- throws ServletException, IOException;
+ void forward(ServletRequest request, ServletResponse response) throws ServletException, IOException;
/**
- * Includes the content of a resource (servlet, JSP page, HTML file) in the
- * response. In essence, this method enables programmatic server-side
- * includes.
- *
+ * Includes the content of a resource (servlet, JSP page, HTML file) in the response. In essence, this method
+ * enables programmatic server-side includes.
* <p>
- * The {@link ServletResponse} object has its path elements and parameters
- * remain unchanged from the caller's. The included servlet cannot change
- * the response status code or set headers; any attempt to make a change is
- * ignored.
- *
+ * The {@link ServletResponse} object has its path elements and parameters remain unchanged from the caller's. The
+ * included servlet cannot change the response status code or set headers; any attempt to make a change is ignored.
* <p>
- * The request and response parameters must be either the same objects as
- * were passed to the calling servlet's service method or be subclasses of
- * the {@link ServletRequestWrapper} or {@link ServletResponseWrapper}
- * classes that wrap them.
- *
- * @param request
- * a {@link ServletRequest} object that contains the client's
- * request
- *
- * @param response
- * a {@link ServletResponse} object that contains the servlet's
- * response
+ * The request and response parameters must be either the same objects as were passed to the calling servlet's
+ * service method or be subclasses of the {@link ServletRequestWrapper} or {@link ServletResponseWrapper} classes
+ * that wrap them.
*
- * @exception ServletException
- * if the included resource throws this exception
+ * @param request a {@link ServletRequest} object that contains the client's request
+ * @param response a {@link ServletResponse} object that contains the servlet's response
*
- * @exception IOException
- * if the included resource throws this exception
+ * @exception ServletException if the included resource throws this exception
+ * @exception IOException if the included resource throws this exception
*/
- void include(ServletRequest request, ServletResponse response)
- throws ServletException, IOException;
+ void include(ServletRequest request, ServletResponse response) throws ServletException, IOException;
}
diff --git a/java/javax/servlet/Servlet.java b/java/javax/servlet/Servlet.java
index 6193741cc4..f326681147 100644
--- a/java/javax/servlet/Servlet.java
+++ b/java/javax/servlet/Servlet.java
@@ -20,35 +20,25 @@ import java.io.IOException;
/**
* Defines methods that all servlets must implement.
- *
* <p>
- * A servlet is a small Java program that runs within a Web server. Servlets
- * receive and respond to requests from Web clients, usually across HTTP, the
- * HyperText Transfer Protocol.
- *
+ * A servlet is a small Java program that runs within a Web server. Servlets receive and respond to requests from Web
+ * clients, usually across HTTP, the HyperText Transfer Protocol.
* <p>
- * To implement this interface, you can write a generic servlet that extends
- * <code>javax.servlet.GenericServlet</code> or an HTTP servlet that extends
- * <code>javax.servlet.http.HttpServlet</code>.
- *
+ * To implement this interface, you can write a generic servlet that extends <code>javax.servlet.GenericServlet</code>
+ * or an HTTP servlet that extends <code>javax.servlet.http.HttpServlet</code>.
* <p>
- * This interface defines methods to initialize a servlet, to service requests,
- * and to remove a servlet from the server. These are known as life-cycle
- * methods and are called in the following sequence:
+ * This interface defines methods to initialize a servlet, to service requests, and to remove a servlet from the server.
+ * These are known as life-cycle methods and are called in the following sequence:
* <ol>
- * <li>The servlet is constructed, then initialized with the <code>init</code>
- * method.
+ * <li>The servlet is constructed, then initialized with the <code>init</code> method.
* <li>Any calls from clients to the <code>service</code> method are handled.
- * <li>The servlet is taken out of service, then destroyed with the
- * <code>destroy</code> method, then garbage collected and finalized.
+ * <li>The servlet is taken out of service, then destroyed with the <code>destroy</code> method, then garbage collected
+ * and finalized.
* </ol>
- *
* <p>
- * In addition to the life-cycle methods, this interface provides the
- * <code>getServletConfig</code> method, which the servlet can use to get any
- * startup information, and the <code>getServletInfo</code> method, which allows
- * the servlet to return basic information about itself, such as author,
- * version, and copyright.
+ * In addition to the life-cycle methods, this interface provides the <code>getServletConfig</code> method, which the
+ * servlet can use to get any startup information, and the <code>getServletInfo</code> method, which allows the servlet
+ * to return basic information about itself, such as author, version, and copyright.
*
* @see GenericServlet
* @see javax.servlet.http.HttpServlet
@@ -56,30 +46,21 @@ import java.io.IOException;
public interface Servlet {
/**
- * Called by the servlet container to indicate to a servlet that the servlet
- * is being placed into service.
- *
+ * Called by the servlet container to indicate to a servlet that the servlet is being placed into service.
* <p>
- * The servlet container calls the <code>init</code> method exactly once
- * after instantiating the servlet. The <code>init</code> method must
- * complete successfully before the servlet can receive any requests.
- *
+ * The servlet container calls the <code>init</code> method exactly once after instantiating the servlet. The
+ * <code>init</code> method must complete successfully before the servlet can receive any requests.
* <p>
- * The servlet container cannot place the servlet into service if the
- * <code>init</code> method
+ * The servlet container cannot place the servlet into service if the <code>init</code> method
* <ol>
* <li>Throws a <code>ServletException</code>
* <li>Does not return within a time period defined by the Web server
* </ol>
*
+ * @param config a <code>ServletConfig</code> object containing the servlet's configuration and initialization
+ * parameters
*
- * @param config
- * a <code>ServletConfig</code> object containing the servlet's
- * configuration and initialization parameters
- *
- * @exception ServletException
- * if an exception has occurred that interferes with the
- * servlet's normal operation
+ * @exception ServletException if an exception has occurred that interferes with the servlet's normal operation
*
* @see UnavailableException
* @see #getServletConfig
@@ -87,90 +68,57 @@ public interface Servlet {
void init(ServletConfig config) throws ServletException;
/**
- * Returns a {@link ServletConfig} object, which contains initialization and
- * startup parameters for this servlet. The <code>ServletConfig</code>
- * object returned is the one passed to the <code>init</code> method.
- *
+ * Returns a {@link ServletConfig} object, which contains initialization and startup parameters for this servlet.
+ * The <code>ServletConfig</code> object returned is the one passed to the <code>init</code> method.
* <p>
- * Implementations of this interface are responsible for storing the
- * <code>ServletConfig</code> object so that this method can return it. The
- * {@link GenericServlet} class, which implements this interface, already
- * does this.
+ * Implementations of this interface are responsible for storing the <code>ServletConfig</code> object so that this
+ * method can return it. The {@link GenericServlet} class, which implements this interface, already does this.
*
- * @return the <code>ServletConfig</code> object that initializes this
- * servlet
+ * @return the <code>ServletConfig</code> object that initializes this servlet
*
* @see #init
*/
ServletConfig getServletConfig();
/**
- * Called by the servlet container to allow the servlet to respond to a
- * request.
- *
+ * Called by the servlet container to allow the servlet to respond to a request.
* <p>
- * This method is only called after the servlet's <code>init()</code> method
- * has completed successfully.
- *
+ * This method is only called after the servlet's <code>init()</code> method has completed successfully.
* <p>
- * The status code of the response always should be set for a servlet that
- * throws or sends an error.
- *
- *
+ * The status code of the response always should be set for a servlet that throws or sends an error.
* <p>
- * Servlets typically run inside multithreaded servlet containers that can
- * handle multiple requests concurrently. Developers must be aware to
- * synchronize access to any shared resources such as files, network
- * connections, and as well as the servlet's class and instance variables.
- * More information on multithreaded programming in Java is available in <a
- * href
- * ="http://java.sun.com/Series/Tutorial/java/threads/multithreaded.html">
- * the Java tutorial on multi-threaded programming</a>.
- *
+ * Servlets typically run inside multithreaded servlet containers that can handle multiple requests concurrently.
+ * Developers must be aware to synchronize access to any shared resources such as files, network connections, and as
+ * well as the servlet's class and instance variables. More information on multithreaded programming in Java is
+ * available in <a href ="http://java.sun.com/Series/Tutorial/java/threads/multithreaded.html"> the Java tutorial on
+ * multi-threaded programming</a>.
*
- * @param req
- * the <code>ServletRequest</code> object that contains the
- * client's request
+ * @param req the <code>ServletRequest</code> object that contains the client's request
+ * @param res the <code>ServletResponse</code> object that contains the servlet's response
*
- * @param res
- * the <code>ServletResponse</code> object that contains the
- * servlet's response
- *
- * @exception ServletException
- * if an exception occurs that interferes with the servlet's
- * normal operation
- *
- * @exception IOException
- * if an input or output exception occurs
+ * @exception ServletException if an exception occurs that interferes with the servlet's normal operation
+ * @exception IOException if an input or output exception occurs
*/
- void service(ServletRequest req, ServletResponse res)
- throws ServletException, IOException;
+ void service(ServletRequest req, ServletResponse res) throws ServletException, IOException;
/**
- * Returns information about the servlet, such as author, version, and
- * copyright.
- *
+ * Returns information about the servlet, such as author, version, and copyright.
* <p>
- * The string that this method returns should be plain text and not markup
- * of any kind (such as HTML, XML, etc.).
+ * The string that this method returns should be plain text and not markup of any kind (such as HTML, XML, etc.).
*
* @return a <code>String</code> containing servlet information
*/
String getServletInfo();
/**
- * Called by the servlet container to indicate to a servlet that the servlet
- * is being taken out of service. This method is only called once all
- * threads within the servlet's <code>service</code> method have exited or
- * after a timeout period has passed. After the servlet container calls this
- * method, it will not call the <code>service</code> method again on this
- * servlet.
- *
+ * Called by the servlet container to indicate to a servlet that the servlet is being taken out of service. This
+ * method is only called once all threads within the servlet's <code>service</code> method have exited or after a
+ * timeout period has passed. After the servlet container calls this method, it will not call the
+ * <code>service</code> method again on this servlet.
* <p>
- * This method gives the servlet an opportunity to clean up any resources
- * that are being held (for example, memory, file handles, threads) and make
- * sure that any persistent state is synchronized with the servlet's current
- * state in memory.
+ * This method gives the servlet an opportunity to clean up any resources that are being held (for example, memory,
+ * file handles, threads) and make sure that any persistent state is synchronized with the servlet's current state
+ * in memory.
*/
void destroy();
}
diff --git a/java/javax/servlet/ServletConfig.java b/java/javax/servlet/ServletConfig.java
index dc607d641e..8364b7a8c6 100644
--- a/java/javax/servlet/ServletConfig.java
+++ b/java/javax/servlet/ServletConfig.java
@@ -19,51 +19,45 @@ package javax.servlet;
import java.util.Enumeration;
/**
- * A servlet configuration object used by a servlet container to pass
- * information to a servlet during initialization.
+ * A servlet configuration object used by a servlet container to pass information to a servlet during initialization.
*/
public interface ServletConfig {
/**
- * Returns the name of this servlet instance. The name may be provided via
- * server administration, assigned in the web application deployment
- * descriptor, or for an unregistered (and thus unnamed) servlet instance it
- * will be the servlet's class name.
+ * Returns the name of this servlet instance. The name may be provided via server administration, assigned in the
+ * web application deployment descriptor, or for an unregistered (and thus unnamed) servlet instance it will be the
+ * servlet's class name.
*
* @return the name of the servlet instance
*/
String getServletName();
/**
- * Returns a reference to the {@link ServletContext} in which the caller is
- * executing.
+ * Returns a reference to the {@link ServletContext} in which the caller is executing.
+ *
+ * @return a {@link ServletContext} object, used by the caller to interact with its servlet container
*
- * @return a {@link ServletContext} object, used by the caller to interact
- * with its servlet container
* @see ServletContext
*/
ServletContext getServletContext();
/**
- * Returns a <code>String</code> containing the value of the named
- * initialization parameter, or <code>null</code> if the parameter does not
- * exist.
+ * Returns a <code>String</code> containing the value of the named initialization parameter, or <code>null</code> if
+ * the parameter does not exist.
+ *
+ * @param name a <code>String</code> specifying the name of the initialization parameter
*
- * @param name
- * a <code>String</code> specifying the name of the
- * initialization parameter
- * @return a <code>String</code> containing the value of the initialization
- * parameter
+ * @return a <code>String</code> containing the value of the initialization parameter
*/
String getInitParameter(String name);
/**
- * Returns the names of the servlet's initialization parameters as an
- * <code>Enumeration</code> of <code>String</code> objects, or an empty
- * <code>Enumeration</code> if the servlet has no initialization parameters.
+ * Returns the names of the servlet's initialization parameters as an <code>Enumeration</code> of
+ * <code>String</code> objects, or an empty <code>Enumeration</code> if the servlet has no initialization
+ * parameters.
*
- * @return an <code>Enumeration</code> of <code>String</code> objects
- * containing the names of the servlet's initialization parameters
+ * @return an <code>Enumeration</code> of <code>String</code> objects containing the names of the servlet's
+ * initialization parameters
*/
Enumeration<String> getInitParameterNames();
}
diff --git a/java/javax/servlet/ServletContainerInitializer.java b/java/javax/servlet/ServletContainerInitializer.java
index 4b9a7929c0..9c00998f42 100644
--- a/java/javax/servlet/ServletContainerInitializer.java
+++ b/java/javax/servlet/ServletContainerInitializer.java
@@ -19,33 +19,27 @@ package javax.servlet;
import java.util.Set;
/**
- * ServletContainerInitializers (SCIs) are registered via an entry in the
- * file META-INF/services/javax.servlet.ServletContainerInitializer that must be
- * included in the JAR file that contains the SCI implementation.
+ * ServletContainerInitializers (SCIs) are registered via an entry in the file
+ * META-INF/services/javax.servlet.ServletContainerInitializer that must be included in the JAR file that contains the
+ * SCI implementation.
* <p>
- * SCI processing is performed regardless of the setting of metadata-complete.
- * SCI processing can be controlled per JAR file via fragment ordering. If
- * absolute ordering is defined, then only the JARs included in the ordering
- * will be processed for SCIs. To disable SCI processing completely, an empty
- * absolute ordering may be defined.
+ * SCI processing is performed regardless of the setting of metadata-complete. SCI processing can be controlled per JAR
+ * file via fragment ordering. If absolute ordering is defined, then only the JARs included in the ordering will be
+ * processed for SCIs. To disable SCI processing completely, an empty absolute ordering may be defined.
* <p>
- * SCIs register an interest in annotations (class, method or field) and/or
- * types via the {@link javax.servlet.annotation.HandlesTypes} annotation which
- * is added to the class.
+ * SCIs register an interest in annotations (class, method or field) and/or types via the
+ * {@link javax.servlet.annotation.HandlesTypes} annotation which is added to the class.
*
* @since Servlet 3.0
*/
public interface ServletContainerInitializer {
/**
- * Receives notification during startup of a web application of the classes
- * within the web application that matched the criteria defined via the
- * {@link javax.servlet.annotation.HandlesTypes} annotation.
+ * Receives notification during startup of a web application of the classes within the web application that matched
+ * the criteria defined via the {@link javax.servlet.annotation.HandlesTypes} annotation.
*
- * @param c The (possibly null) set of classes that met the specified
- * criteria
- * @param ctx The ServletContext of the web application in which the
- * classes were discovered
+ * @param c The (possibly null) set of classes that met the specified criteria
+ * @param ctx The ServletContext of the web application in which the classes were discovered
*
* @throws ServletException If an error occurs
*/
diff --git a/java/javax/servlet/ServletContext.java b/java/javax/servlet/ServletContext.java
index 27f62542aa..d6589e8775 100644
--- a/java/javax/servlet/ServletContext.java
+++ b/java/javax/servlet/ServletContext.java
@@ -27,24 +27,19 @@ import java.util.Set;
import javax.servlet.descriptor.JspConfigDescriptor;
/**
- * Defines a set of methods that a servlet uses to communicate with its servlet
- * container, for example, to get the MIME type of a file, dispatch requests, or
- * write to a log file.
+ * Defines a set of methods that a servlet uses to communicate with its servlet container, for example, to get the MIME
+ * type of a file, dispatch requests, or write to a log file.
* <p>
- * There is one context per "web application" per Java Virtual Machine. (A
- * "web application" is a collection of servlets and content installed under a
- * specific subset of the server's URL namespace such as <code>/catalog</code>
- * and possibly installed via a <code>.war</code> file.)
+ * There is one context per "web application" per Java Virtual Machine. (A "web application" is a collection of servlets
+ * and content installed under a specific subset of the server's URL namespace such as <code>/catalog</code> and
+ * possibly installed via a <code>.war</code> file.)
* <p>
- * In the case of a web application marked "distributed" in its deployment
- * descriptor, there will be one context instance for each virtual machine. In
- * this situation, the context cannot be used as a location to share global
- * information (because the information won't be truly global). Use an external
- * resource like a database instead.
+ * In the case of a web application marked "distributed" in its deployment descriptor, there will be one context
+ * instance for each virtual machine. In this situation, the context cannot be used as a location to share global
+ * information (because the information won't be truly global). Use an external resource like a database instead.
* <p>
- * The <code>ServletContext</code> object is contained within the
- * {@link ServletConfig} object, which the Web server provides the servlet when
- * the servlet is initialized.
+ * The <code>ServletContext</code> object is contained within the {@link ServletConfig} object, which the Web server
+ * provides the servlet when the servlet is initialized.
*
* @see Servlet#getServletConfig
* @see ServletConfig#getServletContext
@@ -52,14 +47,12 @@ import javax.servlet.descriptor.JspConfigDescriptor;
public interface ServletContext {
/**
- * The name of the ServletContext attribute that holds the temporary file
- * location for the web application.
+ * The name of the ServletContext attribute that holds the temporary file location for the web application.
*/
String TEMPDIR = "javax.servlet.context.tempdir";
/**
- * The name of the ServletContext attribute that holds the ordered list of
- * web fragments for this web application.
+ * The name of the ServletContext attribute that holds the ordered list of web fragments for this web application.
*
* @since Servlet 3.0
*/
@@ -75,101 +68,90 @@ public interface ServletContext {
String getContextPath();
/**
- * Returns a <code>ServletContext</code> object that corresponds to a
- * specified URL on the server.
+ * Returns a <code>ServletContext</code> object that corresponds to a specified URL on the server.
* <p>
- * This method allows servlets to gain access to the context for various
- * parts of the server, and as needed obtain {@link RequestDispatcher}
- * objects from the context. The given path must be begin with "/", is
- * interpreted relative to the server's document root and is matched against
- * the context roots of other web applications hosted on this container.
+ * This method allows servlets to gain access to the context for various parts of the server, and as needed obtain
+ * {@link RequestDispatcher} objects from the context. The given path must be begin with "/", is interpreted
+ * relative to the server's document root and is matched against the context roots of other web applications hosted
+ * on this container.
* <p>
- * In a security conscious environment, the servlet container may return
- * <code>null</code> for a given URL.
- *
- * @param uripath
- * a <code>String</code> specifying the context path of another
- * web application in the container.
- * @return the <code>ServletContext</code> object that corresponds to the
- * named URL, or null if either none exists or the container wishes
- * to restrict this access.
+ * In a security conscious environment, the servlet container may return <code>null</code> for a given URL.
+ *
+ * @param uripath a <code>String</code> specifying the context path of another web application in the container.
+ *
+ * @return the <code>ServletContext</code> object that corresponds to the named URL, or null if either none exists
+ * or the container wishes to restrict this access.
+ *
* @see RequestDispatcher
*/
ServletContext getContext(String uripath);
/**
- * Returns the major version of the Java Servlet API that this servlet
- * container supports. All implementations that comply with Version 4.0 must
- * have this method return the integer 4.
+ * Returns the major version of the Java Servlet API that this servlet container supports. All implementations that
+ * comply with Version 4.0 must have this method return the integer 4.
*
* @return 4
*/
int getMajorVersion();
/**
- * Returns the minor version of the Servlet API that this servlet container
- * supports. All implementations that comply with Version 4.0 must have this
- * method return the integer 0.
+ * Returns the minor version of the Servlet API that this servlet container supports. All implementations that
+ * comply with Version 4.0 must have this method return the integer 0.
*
* @return 0
*/
int getMinorVersion();
/**
- * Obtain the major version of the servlet specification for which this web
- * application is implemented.
+ * Obtain the major version of the servlet specification for which this web application is implemented.
*
* @return The major version declared in web.xml
*
- * @throws UnsupportedOperationException If called from a
- * {@link ServletContextListener#contextInitialized(ServletContextEvent)}
- * method of a {@link ServletContextListener} that was not defined in a
- * web.xml file, a web-fragment.xml file nor annotated with
- * {@link javax.servlet.annotation.WebListener}. For example, a
- * {@link ServletContextListener} defined in a TLD would not be able to
- * use this method.
+ * @throws UnsupportedOperationException If called from a
+ * {@link ServletContextListener#contextInitialized(ServletContextEvent)}
+ * method of a {@link ServletContextListener} that was not defined in a
+ * web.xml file, a web-fragment.xml file nor annotated with
+ * {@link javax.servlet.annotation.WebListener}. For example, a
+ * {@link ServletContextListener} defined in a TLD would not be able to
+ * use this method.
*
* @since Servlet 3.0
*/
int getEffectiveMajorVersion();
/**
- * Obtain the minor version of the servlet specification for which this web
- * application is implemented.
+ * Obtain the minor version of the servlet specification for which this web application is implemented.
*
* @return The minor version declared in web.xml
*
- * @throws UnsupportedOperationException If called from a
- * {@link ServletContextListener#contextInitialized(ServletContextEvent)}
- * method of a {@link ServletContextListener} that was not defined in a
- * web.xml file, a web-fragment.xml file nor annotated with
- * {@link javax.servlet.annotation.WebListener}. For example, a
- * {@link ServletContextListener} defined in a TLD would not be able to
- * use this method.
+ * @throws UnsupportedOperationException If called from a
+ * {@link ServletContextListener#contextInitialized(ServletContextEvent)}
+ * method of a {@link ServletContextListener} that was not defined in a
+ * web.xml file, a web-fragment.xml file nor annotated with
+ * {@link javax.servlet.annotation.WebListener}. For example, a
+ * {@link ServletContextListener} defined in a TLD would not be able to
+ * use this method.
*
* @since Servlet 3.0
*/
int getEffectiveMinorVersion();
/**
- * Returns the MIME type of the specified file, or <code>null</code> if the
- * MIME type is not known. The MIME type is determined by the configuration
- * of the servlet container, and may be specified in a web application
- * deployment descriptor. Common MIME types are <code>"text/html"</code> and
- * <code>"image/gif"</code>.
- *
- * @param file
- * a <code>String</code> specifying the name of a file
+ * Returns the MIME type of the specified file, or <code>null</code> if the MIME type is not known. The MIME type is
+ * determined by the configuration of the servlet container, and may be specified in a web application deployment
+ * descriptor. Common MIME types are <code>"text/html"</code> and <code>"image/gif"</code>.
+ *
+ * @param file a <code>String</code> specifying the name of a file
+ *
* @return a <code>String</code> specifying the file's MIME type
*/
String getMimeType(String file);
/**
- * Returns a directory-like listing of all the paths to resources within the
- * web application whose longest sub-path matches the supplied path
- * argument. Paths indicating subdirectory paths end with a '/'. The
- * returned paths are all relative to the root of the web application and
- * have a leading '/'. For example, for a web application containing<br>
+ * Returns a directory-like listing of all the paths to resources within the web application whose longest sub-path
+ * matches the supplied path argument. Paths indicating subdirectory paths end with a '/'. The returned paths are
+ * all relative to the root of the web application and have a leading '/'. For example, for a web application
+ * containing<br>
* <br>
* /welcome.html<br>
* /catalog/index.html<br>
@@ -180,127 +162,103 @@ public interface ServletContext {
* /WEB-INF/web.xml<br>
* /WEB-INF/classes/com.acme.OrderServlet.class,<br>
* <br>
- * getResourcePaths("/") returns {"/welcome.html", "/catalog/",
- * "/customer/", "/WEB-INF/"}<br>
- * getResourcePaths("/catalog/") returns {"/catalog/index.html",
- * "/catalog/products.html", "/catalog/offers/"}.<br>
- *
- * @param path
- * the partial path used to match the resources, which must start
- * with a /
- * @return a Set containing the directory listing, or null if there are no
- * resources in the web application whose path begins with the
- * supplied path.
+ * getResourcePaths("/") returns {"/welcome.html", "/catalog/", "/customer/", "/WEB-INF/"}<br>
+ * getResourcePaths("/catalog/") returns {"/catalog/index.html", "/catalog/products.html", "/catalog/offers/"}.<br>
+ *
+ * @param path the partial path used to match the resources, which must start with a /
+ *
+ * @return a Set containing the directory listing, or null if there are no resources in the web application whose
+ * path begins with the supplied path.
+ *
* @since Servlet 2.3
*/
Set<String> getResourcePaths(String path);
/**
- * Returns a URL to the resource that is mapped to a specified path. The
- * path must begin with a "/" and is interpreted as relative to the current
- * context root.
+ * Returns a URL to the resource that is mapped to a specified path. The path must begin with a "/" and is
+ * interpreted as relative to the current context root.
* <p>
- * This method allows the servlet container to make a resource available to
- * servlets from any source. Resources can be located on a local or remote
- * file system, in a database, or in a <code>.war</code> file.
+ * This method allows the servlet container to make a resource available to servlets from any source. Resources can
+ * be located on a local or remote file system, in a database, or in a <code>.war</code> file.
* <p>
- * The servlet container must implement the URL handlers and
- * <code>URLConnection</code> objects that are necessary to access the
- * resource.
+ * The servlet container must implement the URL handlers and <code>URLConnection</code> objects that are necessary
+ * to access the resource.
* <p>
- * This method returns <code>null</code> if no resource is mapped to the
- * pathname.
+ * This method returns <code>null</code> if no resource is mapped to the pathname.
* <p>
- * Some containers may allow writing to the URL returned by this method
- * using the methods of the URL class.
+ * Some containers may allow writing to the URL returned by this method using the methods of the URL class.
* <p>
- * The resource content is returned directly, so be aware that requesting a
- * <code>.jsp</code> page returns the JSP source code. Use a
- * <code>RequestDispatcher</code> instead to include results of an
- * execution.
+ * The resource content is returned directly, so be aware that requesting a <code>.jsp</code> page returns the JSP
+ * source code. Use a <code>RequestDispatcher</code> instead to include results of an execution.
* <p>
- * This method has a different purpose than
- * <code>java.lang.Class.getResource</code>, which looks up resources based
+ * This method has a different purpose than <code>java.lang.Class.getResource</code>, which looks up resources based
* on a class loader. This method does not use class loaders.
*
- * @param path
- * a <code>String</code> specifying the path to the resource
- * @return the resource located at the named path, or <code>null</code> if
- * there is no resource at that path
- * @exception MalformedURLException
- * if the pathname is not given in the correct form
+ * @param path a <code>String</code> specifying the path to the resource
+ *
+ * @return the resource located at the named path, or <code>null</code> if there is no resource at that path
+ *
+ * @exception MalformedURLException if the pathname is not given in the correct form
*/
URL getResource(String path) throws MalformedURLException;
/**
- * Returns the resource located at the named path as an
- * <code>InputStream</code> object.
+ * Returns the resource located at the named path as an <code>InputStream</code> object.
* <p>
- * The data in the <code>InputStream</code> can be of any type or length.
- * The path must be specified according to the rules given in
- * <code>getResource</code>. This method returns <code>null</code> if no
- * resource exists at the specified path.
+ * The data in the <code>InputStream</code> can be of any type or length. The path must be specified according to
+ * the rules given in <code>getResource</code>. This method returns <code>null</code> if no resource exists at the
+ * specified path.
* <p>
- * Meta-information such as content length and content type that is
- * available via <code>getResource</code> method is lost when using this
- * method.
+ * Meta-information such as content length and content type that is available via <code>getResource</code> method is
+ * lost when using this method.
* <p>
- * The servlet container must implement the URL handlers and
- * <code>URLConnection</code> objects necessary to access the resource.
+ * The servlet container must implement the URL handlers and <code>URLConnection</code> objects necessary to access
+ * the resource.
* <p>
- * This method is different from
- * <code>java.lang.Class.getResourceAsStream</code>, which uses a class
- * loader. This method allows servlet containers to make a resource
- * available to a servlet from any location, without using a class loader.
- *
- * @param path
- * a <code>String</code> specifying the path to the resource
- * @return the <code>InputStream</code> returned to the servlet, or
- * <code>null</code> if no resource exists at the specified path
+ * This method is different from <code>java.lang.Class.getResourceAsStream</code>, which uses a class loader. This
+ * method allows servlet containers to make a resource available to a servlet from any location, without using a
+ * class loader.
+ *
+ * @param path a <code>String</code> specifying the path to the resource
+ *
+ * @return the <code>InputStream</code> returned to the servlet, or <code>null</code> if no resource exists at the
+ * specified path
*/
InputStream getResourceAsStream(String path);
/**
- * Returns a {@link RequestDispatcher} object that acts as a wrapper for the
- * resource located at the given path. A <code>RequestDispatcher</code>
- * object can be used to forward a request to the resource or to include the
- * resource in a response. The resource can be dynamic or static.
+ * Returns a {@link RequestDispatcher} object that acts as a wrapper for the resource located at the given path. A
+ * <code>RequestDispatcher</code> object can be used to forward a request to the resource or to include the resource
+ * in a response. The resource can be dynamic or static.
* <p>
- * The pathname must begin with a "/" and is interpreted as relative to the
- * current context root. Use <code>getContext</code> to obtain a
- * <code>RequestDispatcher</code> for resources in foreign contexts. This
- * method returns <code>null</code> if the <code>ServletContext</code>
- * cannot return a <code>RequestDispatcher</code>.
- *
- * @param path
- * a <code>String</code> specifying the pathname to the resource
- * @return a <code>RequestDispatcher</code> object that acts as a wrapper for
- * the resource at the specified path, or <code>null</code> if the
- * <code>ServletContext</code> cannot return a
- * <code>RequestDispatcher</code>
+ * The pathname must begin with a "/" and is interpreted as relative to the current context root. Use
+ * <code>getContext</code> to obtain a <code>RequestDispatcher</code> for resources in foreign contexts. This method
+ * returns <code>null</code> if the <code>ServletContext</code> cannot return a <code>RequestDispatcher</code>.
+ *
+ * @param path a <code>String</code> specifying the pathname to the resource
+ *
+ * @return a <code>RequestDispatcher</code> object that acts as a wrapper for the resource at the specified path, or
+ * <code>null</code> if the <code>ServletContext</code> cannot return a <code>RequestDispatcher</code>
+ *
* @see RequestDispatcher
* @see ServletContext#getContext
*/
RequestDispatcher getRequestDispatcher(String path);
/**
- * Returns a {@link RequestDispatcher} object that acts as a wrapper for the
- * named servlet.
+ * Returns a {@link RequestDispatcher} object that acts as a wrapper for the named servlet.
* <p>
- * Servlets (and JSP pages also) may be given names via server
- * administration or via a web application deployment descriptor. A servlet
- * instance can determine its name using
- * {@link ServletConfig#getServletName}.
+ * Servlets (and JSP pages also) may be given names via server administration or via a web application deployment
+ * descriptor. A servlet instance can determine its name using {@link ServletConfig#getServletName}.
* <p>
- * This method returns <code>null</code> if the <code>ServletContext</code>
- * cannot return a <code>RequestDispatcher</code> for any reason.
- *
- * @param name
- * a <code>String</code> specifying the name of a servlet to wrap
- * @return a <code>RequestDispatcher</code> object that acts as a wrapper for
- * the named servlet, or <code>null</code> if the
- * <code>ServletContext</code> cannot return a
- * <code>RequestDispatcher</code>
+ * This method returns <code>null</code> if the <code>ServletContext</code> cannot return a
+ * <code>RequestDispatcher</code> for any reason.
+ *
+ * @param name a <code>String</code> specifying the name of a servlet to wrap
+ *
+ * @return a <code>RequestDispatcher</code> object that acts as a wrapper for the named servlet, or
+ * <code>null</code> if the <code>ServletContext</code> cannot return a <code>RequestDispatcher</code>
+ *
* @see RequestDispatcher
* @see ServletContext#getContext
* @see ServletConfig#getServletName
@@ -308,15 +266,12 @@ public interface ServletContext {
RequestDispatcher getNamedDispatcher(String name);
/**
- * Do not use. This method was originally defined to retrieve a servlet from
- * a <code>ServletContext</code>. In this version, this method always
- * returns <code>null</code> and remains only to preserve binary
- * compatibility. This method will be permanently removed in a future
- * version of the Java Servlet API.
+ * Do not use. This method was originally defined to retrieve a servlet from a <code>ServletContext</code>. In this
+ * version, this method always returns <code>null</code> and remains only to preserve binary compatibility. This
+ * method will be permanently removed in a future version of the Java Servlet API.
* <p>
- * In lieu of this method, servlets can share information using the
- * <code>ServletContext</code> class and can perform shared business logic
- * by invoking methods on common non-servlet classes.
+ * In lieu of this method, servlets can share information using the <code>ServletContext</code> class and can
+ * perform shared business logic by invoking methods on common non-servlet classes.
*
* @param name Not used
*
@@ -326,139 +281,120 @@ public interface ServletContext {
*
* @deprecated As of Java Servlet API 2.1, with no direct replacement.
*/
- @Deprecated Servlet getServlet(String name) throws ServletException;
+ @Deprecated
+ Servlet getServlet(String name) throws ServletException;
/**
- * Do not use. This method was originally defined to return an
- * <code>Enumeration</code> of all the servlets known to this servlet
- * context. In this version, this method always returns an empty enumeration
- * and remains only to preserve binary compatibility. This method will be
- * permanently removed in a future version of the Java Servlet API.
+ * Do not use. This method was originally defined to return an <code>Enumeration</code> of all the servlets known to
+ * this servlet context. In this version, this method always returns an empty enumeration and remains only to
+ * preserve binary compatibility. This method will be permanently removed in a future version of the Java Servlet
+ * API.
*
* @return Always and empty Enumeration
*
* @deprecated As of Java Servlet API 2.0, with no replacement.
*/
- @Deprecated Enumeration<Servlet> getServlets();
+ @Deprecated
+ Enumeration<Servlet> getServlets();
/**
- * Do not use. This method was originally defined to return an
- * <code>Enumeration</code> of all the servlet names known to this context.
- * In this version, this method always returns an empty
- * <code>Enumeration</code> and remains only to preserve binary
- * compatibility. This method will be permanently removed in a future
- * version of the Java Servlet API.
+ * Do not use. This method was originally defined to return an <code>Enumeration</code> of all the servlet names
+ * known to this context. In this version, this method always returns an empty <code>Enumeration</code> and remains
+ * only to preserve binary compatibility. This method will be permanently removed in a future version of the Java
+ * Servlet API.
*
* @return Always and empty Enumeration
*
* @deprecated As of Java Servlet API 2.1, with no replacement.
*/
- @Deprecated Enumeration<String> getServletNames();
+ @Deprecated
+ Enumeration<String> getServletNames();
/**
- * Writes the specified message to a servlet log file, usually an event log.
- * The name and type of the servlet log file is specific to the servlet
- * container.
+ * Writes the specified message to a servlet log file, usually an event log. The name and type of the servlet log
+ * file is specific to the servlet container.
*
- * @param msg
- * a <code>String</code> specifying the message to be written to
- * the log file
+ * @param msg a <code>String</code> specifying the message to be written to the log file
*/
void log(String msg);
/**
* Do not use.
+ *
* @param exception The exception to log
* @param msg The message to log with the exception
- * @deprecated As of Java Servlet API 2.1, use
- * {@link #log(String message, Throwable throwable)} instead.
- * <p>
- * This method was originally defined to write an exception's
- * stack trace and an explanatory error message to the servlet
- * log file.
+ *
+ * @deprecated As of Java Servlet API 2.1, use {@link #log(String message, Throwable throwable)} instead.
+ * <p>
+ * This method was originally defined to write an exception's stack trace and an explanatory error
+ * message to the servlet log file.
*/
- @Deprecated void log(Exception exception, String msg);
+ @Deprecated
+ void log(Exception exception, String msg);
/**
- * Writes an explanatory message and a stack trace for a given
- * <code>Throwable</code> exception to the servlet log file. The name and
- * type of the servlet log file is specific to the servlet container,
- * usually an event log.
- *
- * @param message
- * a <code>String</code> that describes the error or exception
- * @param throwable
- * the <code>Throwable</code> error or exception
+ * Writes an explanatory message and a stack trace for a given <code>Throwable</code> exception to the servlet log
+ * file. The name and type of the servlet log file is specific to the servlet container, usually an event log.
+ *
+ * @param message a <code>String</code> that describes the error or exception
+ * @param throwable the <code>Throwable</code> error or exception
*/
void log(String message, Throwable throwable);
/**
- * Returns a <code>String</code> containing the real path for a given
- * virtual path. For example, the path "/index.html" returns the absolute
- * file path on the server's filesystem would be served by a request for
- * "http://host/contextPath/index.html", where contextPath is the context
- * path of this ServletContext..
+ * Returns a <code>String</code> containing the real path for a given virtual path. For example, the path
+ * "/index.html" returns the absolute file path on the server's filesystem would be served by a request for
+ * "http://host/contextPath/index.html", where contextPath is the context path of this ServletContext..
* <p>
- * The real path returned will be in a form appropriate to the computer and
- * operating system on which the servlet container is running, including the
- * proper path separators. This method returns <code>null</code> if the
- * servlet container cannot translate the virtual path to a real path for
- * any reason (such as when the content is being made available from a
- * <code>.war</code> archive).
- *
- * @param path
- * a <code>String</code> specifying a virtual path
- * @return a <code>String</code> specifying the real path, or null if the
- * translation cannot be performed
+ * The real path returned will be in a form appropriate to the computer and operating system on which the servlet
+ * container is running, including the proper path separators. This method returns <code>null</code> if the servlet
+ * container cannot translate the virtual path to a real path for any reason (such as when the content is being made
+ * available from a <code>.war</code> archive).
+ *
+ * @param path a <code>String</code> specifying a virtual path
+ *
+ * @return a <code>String</code> specifying the real path, or null if the translation cannot be performed
*/
String getRealPath(String path);
/**
- * Returns the name and version of the servlet container on which the
- * servlet is running.
+ * Returns the name and version of the servlet container on which the servlet is running.
* <p>
- * The form of the returned string is
- * <i>servername</i>/<i>versionnumber</i>. For example, the JavaServer Web
- * Development Kit may return the string
- * <code>JavaServer Web Dev Kit/1.0</code>.
+ * The form of the returned string is <i>servername</i>/<i>versionnumber</i>. For example, the JavaServer Web
+ * Development Kit may return the string <code>JavaServer Web Dev Kit/1.0</code>.
* <p>
- * The servlet container may return other optional information after the
- * primary string in parentheses, for example,
+ * The servlet container may return other optional information after the primary string in parentheses, for example,
* <code>JavaServer Web Dev Kit/1.0 (JDK 1.1.6; Windows NT 4.0 x86)</code>.
*
- * @return a <code>String</code> containing at least the servlet container
- * name and version number
+ * @return a <code>String</code> containing at least the servlet container name and version number
*/
String getServerInfo();
/**
- * Returns a <code>String</code> containing the value of the named
- * context-wide initialization parameter, or <code>null</code> if the
- * parameter does not exist.
+ * Returns a <code>String</code> containing the value of the named context-wide initialization parameter, or
+ * <code>null</code> if the parameter does not exist.
* <p>
- * This method can make available configuration information useful to an
- * entire "web application". For example, it can provide a web site
- * administrator's email address or the name of a system that holds critical
- * data.
- *
- * @param name
- * a <code>String</code> containing the name of the parameter
- * whose value is requested
- * @return a <code>String</code> containing the value of the initialization
- * parameter
- * @throws NullPointerException If the provided parameter name is
- * <code>null</code>
+ * This method can make available configuration information useful to an entire "web application". For example, it
+ * can provide a web site administrator's email address or the name of a system that holds critical data.
+ *
+ * @param name a <code>String</code> containing the name of the parameter whose value is requested
+ *
+ * @return a <code>String</code> containing the value of the initialization parameter
+ *
+ * @throws NullPointerException If the provided parameter name is <code>null</code>
+ *
* @see ServletConfig#getInitParameter
*/
String getInitParameter(String name);
/**
- * Returns the names of the context's initialization parameters as an
- * <code>Enumeration</code> of <code>String</code> objects, or an empty
- * <code>Enumeration</code> if the context has no initialization parameters.
+ * Returns the names of the context's initialization parameters as an <code>Enumeration</code> of
+ * <code>String</code> objects, or an empty <code>Enumeration</code> if the context has no initialization
+ * parameters.
+ *
+ * @return an <code>Enumeration</code> of <code>String</code> objects containing the names of the context's
+ * initialization parameters
*
- * @return an <code>Enumeration</code> of <code>String</code> objects
- * containing the names of the context's initialization parameters
* @see ServletConfig#getInitParameter
*/
@@ -466,53 +402,51 @@ public interface ServletContext {
/**
* Set the given initialisation parameter to the given value.
+ *
* @param name Name of initialisation parameter
* @param value Value for initialisation parameter
- * @return <code>true</code> if the call succeeds or <code>false</code> if
- * the call fails because an initialisation parameter with the same
- * name has already been set
- * @throws IllegalStateException If initialisation of this ServletContext
- * has already completed
- * @throws UnsupportedOperationException If called from a
- * {@link ServletContextListener#contextInitialized(ServletContextEvent)}
- * method of a {@link ServletContextListener} that was not defined in a
- * web.xml file, a web-fragment.xml file nor annotated with
- * {@link javax.servlet.annotation.WebListener}. For example, a
- * {@link ServletContextListener} defined in a TLD would not be able to
- * use this method.
- * @throws NullPointerException If the provided parameter name is
- * <code>null</code>
+ *
+ * @return <code>true</code> if the call succeeds or <code>false</code> if the call fails because an initialisation
+ * parameter with the same name has already been set
+ *
+ * @throws IllegalStateException If initialisation of this ServletContext has already completed
+ * @throws UnsupportedOperationException If called from a
+ * {@link ServletContextListener#contextInitialized(ServletContextEvent)}
+ * method of a {@link ServletContextListener} that was not defined in a
+ * web.xml file, a web-fragment.xml file nor annotated with
+ * {@link javax.servlet.annotation.WebListener}. For example, a
+ * {@link ServletContextListener} defined in a TLD would not be able to
+ * use this method.
+ * @throws NullPointerException If the provided parameter name is <code>null</code>
+ *
* @since Servlet 3.0
*/
boolean setInitParameter(String name, String value);
/**
- * Returns the servlet container attribute with the given name, or
- * <code>null</code> if there is no attribute by that name. An attribute
- * allows a servlet container to give the servlet additional information not
- * already provided by this interface. See your server documentation for
- * information about its attributes. A list of supported attributes can be
- * retrieved using <code>getAttributeNames</code>.
+ * Returns the servlet container attribute with the given name, or <code>null</code> if there is no attribute by
+ * that name. An attribute allows a servlet container to give the servlet additional information not already
+ * provided by this interface. See your server documentation for information about its attributes. A list of
+ * supported attributes can be retrieved using <code>getAttributeNames</code>.
* <p>
- * The attribute is returned as a <code>java.lang.Object</code> or some
- * subclass. Attribute names should follow the same convention as package
- * names. The Java Servlet API specification reserves names matching
- * <code>java.*</code>, <code>javax.*</code>, and <code>sun.*</code>.
- *
- * @param name
- * a <code>String</code> specifying the name of the attribute
- * @return an <code>Object</code> containing the value of the attribute, or
- * <code>null</code> if no attribute exists matching the given name
- * @throws NullPointerException If the provided attribute name is
- * <code>null</code>
+ * The attribute is returned as a <code>java.lang.Object</code> or some subclass. Attribute names should follow the
+ * same convention as package names. The Java Servlet API specification reserves names matching <code>java.*</code>,
+ * <code>javax.*</code>, and <code>sun.*</code>.
+ *
+ * @param name a <code>String</code> specifying the name of the attribute
+ *
+ * @return an <code>Object</code> containing the value of the attribute, or <code>null</code> if no attribute exists
+ * matching the given name
+ *
+ * @throws NullPointerException If the provided attribute name is <code>null</code>
+ *
* @see ServletContext#getAttributeNames
*/
Object getAttribute(String name);
/**
- * Returns an <code>Enumeration</code> containing the attribute names
- * available within this servlet context. Use the {@link #getAttribute}
- * method with an attribute name to get the value of an attribute.
+ * Returns an <code>Enumeration</code> containing the attribute names available within this servlet context. Use the
+ * {@link #getAttribute} method with an attribute name to get the value of an attribute.
*
* @return an <code>Enumeration</code> of attribute names
*
@@ -521,267 +455,264 @@ public interface ServletContext {
Enumeration<String> getAttributeNames();
/**
- * Binds an object to a given attribute name in this servlet context. If the
- * name specified is already used for an attribute, this method will replace
- * the attribute with the new to the new attribute.
+ * Binds an object to a given attribute name in this servlet context. If the name specified is already used for an
+ * attribute, this method will replace the attribute with the new to the new attribute.
* <p>
- * If listeners are configured on the <code>ServletContext</code> the
- * container notifies them accordingly.
+ * If listeners are configured on the <code>ServletContext</code> the container notifies them accordingly.
* <p>
- * If a null value is passed, the effect is the same as calling
- * <code>removeAttribute()</code>.
+ * If a null value is passed, the effect is the same as calling <code>removeAttribute()</code>.
* <p>
- * Attribute names should follow the same convention as package names. The
- * Java Servlet API specification reserves names matching
- * <code>java.*</code>, <code>javax.*</code>, and <code>sun.*</code>.
- *
- * @param name
- * a <code>String</code> specifying the name of the attribute
- * @param object
- * an <code>Object</code> representing the attribute to be bound
- * @throws NullPointerException If the provided attribute name is
- * <code>null</code>
+ * Attribute names should follow the same convention as package names. The Java Servlet API specification reserves
+ * names matching <code>java.*</code>, <code>javax.*</code>, and <code>sun.*</code>.
+ *
+ * @param name a <code>String</code> specifying the name of the attribute
+ * @param object an <code>Object</code> representing the attribute to be bound
+ *
+ * @throws NullPointerException If the provided attribute name is <code>null</code>
*/
void setAttribute(String name, Object object);
/**
- * Removes the attribute with the given name from the servlet context. After
- * removal, subsequent calls to {@link #getAttribute} to retrieve the
- * attribute's value will return <code>null</code>.
+ * Removes the attribute with the given name from the servlet context. After removal, subsequent calls to
+ * {@link #getAttribute} to retrieve the attribute's value will return <code>null</code>.
* <p>
- * If listeners are configured on the <code>ServletContext</code> the
- * container notifies them accordingly.
+ * If listeners are configured on the <code>ServletContext</code> the container notifies them accordingly.
*
- * @param name
- * a <code>String</code> specifying the name of the attribute to
- * be removed
+ * @param name a <code>String</code> specifying the name of the attribute to be removed
*/
void removeAttribute(String name);
/**
- * Returns the name of this web application corresponding to this
- * ServletContext as specified in the deployment descriptor for this web
- * application by the display-name element.
+ * Returns the name of this web application corresponding to this ServletContext as specified in the deployment
+ * descriptor for this web application by the display-name element.
+ *
+ * @return The name of the web application or null if no name has been declared in the deployment descriptor.
*
- * @return The name of the web application or null if no name has been
- * declared in the deployment descriptor.
* @since Servlet 2.3
*/
String getServletContextName();
/**
* Register a servlet implementation for use in this ServletContext.
+ *
* @param servletName The name of the servlet to register
* @param className The implementation class for the servlet
+ *
* @return The registration object that enables further configuration
- * @throws IllegalStateException
- * If the context has already been initialised
- * @throws UnsupportedOperationException If called from a
- * {@link ServletContextListener#contextInitialized(ServletContextEvent)}
- * method of a {@link ServletContextListener} that was not defined in a
- * web.xml file, a web-fragment.xml file nor annotated with
- * {@link javax.servlet.annotation.WebListener}. For example, a
- * {@link ServletContextListener} defined in a TLD would not be able to
- * use this method.
+ *
+ * @throws IllegalStateException If the context has already been initialised
+ * @throws UnsupportedOperationException If called from a
+ * {@link ServletContextListener#contextInitialized(ServletContextEvent)}
+ * method of a {@link ServletContextListener} that was not defined in a
+ * web.xml file, a web-fragment.xml file nor annotated with
+ * {@link javax.servlet.annotation.WebListener}. For example, a
+ * {@link ServletContextListener} defined in a TLD would not be able to
+ * use this method.
+ *
* @since Servlet 3.0
*/
ServletRegistration.Dynamic addServlet(String servletName, String className);
/**
* Register a servlet instance for use in this ServletContext.
+ *
* @param servletName The name of the servlet to register
* @param servlet The Servlet instance to register
+ *
* @return The registration object that enables further configuration
- * @throws IllegalStateException
- * If the context has already been initialised
- * @throws UnsupportedOperationException If called from a
- * {@link ServletContextListener#contextInitialized(ServletContextEvent)}
- * method of a {@link ServletContextListener} that was not defined in a
- * web.xml file, a web-fragment.xml file nor annotated with
- * {@link javax.servlet.annotation.WebListener}. For example, a
- * {@link ServletContextListener} defined in a TLD would not be able to
- * use this method.
+ *
+ * @throws IllegalStateException If the context has already been initialised
+ * @throws UnsupportedOperationException If called from a
+ * {@link ServletContextListener#contextInitialized(ServletContextEvent)}
+ * method of a {@link ServletContextListener} that was not defined in a
+ * web.xml file, a web-fragment.xml file nor annotated with
+ * {@link javax.servlet.annotation.WebListener}. For example, a
+ * {@link ServletContextListener} defined in a TLD would not be able to
+ * use this method.
+ *
* @since Servlet 3.0
*/
ServletRegistration.Dynamic addServlet(String servletName, Servlet servlet);
/**
* Add servlet to the context.
- * @param servletName Name of servlet to add
- * @param servletClass Class of servlet to add
- * @return <code>null</code> if the servlet has already been fully defined,
- * else a {@link javax.servlet.ServletRegistration.Dynamic} object
- * that can be used to further configure the servlet
- * @throws IllegalStateException
- * If the context has already been initialised
- * @throws UnsupportedOperationException If called from a
- * {@link ServletContextListener#contextInitialized(ServletContextEvent)}
- * method of a {@link ServletContextListener} that was not defined in a
- * web.xml file, a web-fragment.xml file nor annotated with
- * {@link javax.servlet.annotation.WebListener}. For example, a
- * {@link ServletContextListener} defined in a TLD would not be able to
- * use this method.
+ *
+ * @param servletName Name of servlet to add
+ * @param servletClass Class of servlet to add
+ *
+ * @return <code>null</code> if the servlet has already been fully defined, else a
+ * {@link javax.servlet.ServletRegistration.Dynamic} object that can be used to further configure the
+ * servlet
+ *
+ * @throws IllegalStateException If the context has already been initialised
+ * @throws UnsupportedOperationException If called from a
+ * {@link ServletContextListener#contextInitialized(ServletContextEvent)}
+ * method of a {@link ServletContextListener} that was not defined in a
+ * web.xml file, a web-fragment.xml file nor annotated with
+ * {@link javax.servlet.annotation.WebListener}. For example, a
+ * {@link ServletContextListener} defined in a TLD would not be able to
+ * use this method.
+ *
* @since Servlet 3.0
*/
- ServletRegistration.Dynamic addServlet(String servletName,
- Class<? extends Servlet> servletClass);
+ ServletRegistration.Dynamic addServlet(String servletName, Class<? extends Servlet> servletClass);
/**
* Add a JSP to the context.
*
- * @param jspName The servlet name under which this JSP file should be
- * registered
- * @param jspFile The path, relative to the web application root, for the
- * JSP file to be used for this servlet
+ * @param jspName The servlet name under which this JSP file should be registered
+ * @param jspFile The path, relative to the web application root, for the JSP file to be used for this servlet
*
- * @return a {@link javax.servlet.ServletRegistration.Dynamic} object
- * that can be used to further configure the servlet
+ * @return a {@link javax.servlet.ServletRegistration.Dynamic} object that can be used to further configure the
+ * servlet
*
* @since Servlet 4.0
*/
ServletRegistration.Dynamic addJspFile(String jspName, String jspFile);
/**
- * Create an Servlet instance using the given class. The instance is just
- * created. No initialisation occurs.
+ * Create an Servlet instance using the given class. The instance is just created. No initialisation occurs.
*
* @param <T> The type for the given class
* @param c The the class for which an instance should be created
*
* @return The created Servlet instance.
*
- * @throws ServletException If the servlet instance cannot be created.
- * @throws UnsupportedOperationException If called from a
- * {@link ServletContextListener#contextInitialized(ServletContextEvent)}
- * method of a {@link ServletContextListener} that was not defined in a
- * web.xml file, a web-fragment.xml file nor annotated with
- * {@link javax.servlet.annotation.WebListener}. For example, a
- * {@link ServletContextListener} defined in a TLD would not be able to
- * use this method.
+ * @throws ServletException If the servlet instance cannot be created.
+ * @throws UnsupportedOperationException If called from a
+ * {@link ServletContextListener#contextInitialized(ServletContextEvent)}
+ * method of a {@link ServletContextListener} that was not defined in a
+ * web.xml file, a web-fragment.xml file nor annotated with
+ * {@link javax.servlet.annotation.WebListener}. For example, a
+ * {@link ServletContextListener} defined in a TLD would not be able to
+ * use this method.
*
* @since Servlet 3.0
*/
- <T extends Servlet> T createServlet(Class<T> c)
- throws ServletException;
+ <T extends Servlet> T createServlet(Class<T> c) throws ServletException;
/**
* Obtain the details of the named servlet.
*
- * @param servletName The name of the Servlet of interest
+ * @param servletName The name of the Servlet of interest
*
- * @return The registration details for the named Servlet or
- * <code>null</code> if no Servlet has been registered with the
- * given name
+ * @return The registration details for the named Servlet or <code>null</code> if no Servlet has been registered
+ * with the given name
*
- * @throws UnsupportedOperationException If called from a
- * {@link ServletContextListener#contextInitialized(ServletContextEvent)}
- * method of a {@link ServletContextListener} that was not defined in a
- * web.xml file, a web-fragment.xml file nor annotated with
- * {@link javax.servlet.annotation.WebListener}. For example, a
- * {@link ServletContextListener} defined in a TLD would not be able to
- * use this method.
+ * @throws UnsupportedOperationException If called from a
+ * {@link ServletContextListener#contextInitialized(ServletContextEvent)}
+ * method of a {@link ServletContextListener} that was not defined in a
+ * web.xml file, a web-fragment.xml file nor annotated with
+ * {@link javax.servlet.annotation.WebListener}. For example, a
+ * {@link ServletContextListener} defined in a TLD would not be able to
+ * use this method.
*
* @since Servlet 3.0
*/
ServletRegistration getServletRegistration(String servletName);
/**
- * Obtain a Map of servlet names to servlet registrations for all servlets
- * registered with this context.
+ * Obtain a Map of servlet names to servlet registrations for all servlets registered with this context.
*
- * @return A Map of servlet names to servlet registrations for all servlets
- * registered with this context
+ * @return A Map of servlet names to servlet registrations for all servlets registered with this context
*
- * @throws UnsupportedOperationException If called from a
- * {@link ServletContextListener#contextInitialized(ServletContextEvent)}
- * method of a {@link ServletContextListener} that was not defined in a
- * web.xml file, a web-fragment.xml file nor annotated with
- * {@link javax.servlet.annotation.WebListener}. For example, a
- * {@link ServletContextListener} defined in a TLD would not be able to
- * use this method.
+ * @throws UnsupportedOperationException If called from a
+ * {@link ServletContextListener#contextInitialized(ServletContextEvent)}
+ * method of a {@link ServletContextListener} that was not defined in a
+ * web.xml file, a web-fragment.xml file nor annotated with
+ * {@link javax.servlet.annotation.WebListener}. For example, a
+ * {@link ServletContextListener} defined in a TLD would not be able to
+ * use this method.
*
* @since Servlet 3.0
*/
- Map<String, ? extends ServletRegistration> getServletRegistrations();
+ Map<String,? extends ServletRegistration> getServletRegistrations();
/**
* Add filter to context.
- * @param filterName Name of filter to add
- * @param className Name of filter class
- * @return <code>null</code> if the filter has already been fully defined,
- * else a {@link javax.servlet.FilterRegistration.Dynamic} object
- * that can be used to further configure the filter
- * @throws UnsupportedOperationException If called from a
- * {@link ServletContextListener#contextInitialized(ServletContextEvent)}
- * method of a {@link ServletContextListener} that was not defined in a
- * web.xml file, a web-fragment.xml file nor annotated with
- * {@link javax.servlet.annotation.WebListener}. For example, a
- * {@link ServletContextListener} defined in a TLD would not be able to
- * use this method.
- * @throws IllegalStateException
- * If the context has already been initialised
+ *
+ * @param filterName Name of filter to add
+ * @param className Name of filter class
+ *
+ * @return <code>null</code> if the filter has already been fully defined, else a
+ * {@link javax.servlet.FilterRegistration.Dynamic} object that can be used to further configure the
+ * filter
+ *
+ * @throws UnsupportedOperationException If called from a
+ * {@link ServletContextListener#contextInitialized(ServletContextEvent)}
+ * method of a {@link ServletContextListener} that was not defined in a
+ * web.xml file, a web-fragment.xml file nor annotated with
+ * {@link javax.servlet.annotation.WebListener}. For example, a
+ * {@link ServletContextListener} defined in a TLD would not be able to
+ * use this method.
+ * @throws IllegalStateException If the context has already been initialised
+ *
* @since Servlet 3.0
*/
FilterRegistration.Dynamic addFilter(String filterName, String className);
/**
* Add filter to context.
- * @param filterName Name of filter to add
- * @param filter Filter to add
- * @return <code>null</code> if the filter has already been fully defined,
- * else a {@link javax.servlet.FilterRegistration.Dynamic} object
- * that can be used to further configure the filter
- * @throws UnsupportedOperationException If called from a
- * {@link ServletContextListener#contextInitialized(ServletContextEvent)}
- * method of a {@link ServletContextListener} that was not defined in a
- * web.xml file, a web-fragment.xml file nor annotated with
- * {@link javax.servlet.annotation.WebListener}. For example, a
- * {@link ServletContextListener} defined in a TLD would not be able to
- * use this method.
- * @throws IllegalStateException
- * If the context has already been initialised
+ *
+ * @param filterName Name of filter to add
+ * @param filter Filter to add
+ *
+ * @return <code>null</code> if the filter has already been fully defined, else a
+ * {@link javax.servlet.FilterRegistration.Dynamic} object that can be used to further configure the
+ * filter
+ *
+ * @throws UnsupportedOperationException If called from a
+ * {@link ServletContextListener#contextInitialized(ServletContextEvent)}
+ * method of a {@link ServletContextListener} that was not defined in a
+ * web.xml file, a web-fragment.xml file nor annotated with
+ * {@link javax.servlet.annotation.WebListener}. For example, a
+ * {@link ServletContextListener} defined in a TLD would not be able to
+ * use this method.
+ * @throws IllegalStateException If the context has already been initialised
+ *
* @since Servlet 3.0
*/
FilterRegistration.Dynamic addFilter(String filterName, Filter filter);
/**
* Add filter to context.
- * @param filterName Name of filter to add
- * @param filterClass Class of filter to add
- * @return <code>null</code> if the filter has already been fully defined,
- * else a {@link javax.servlet.FilterRegistration.Dynamic} object
- * that can be used to further configure the filter
- * @throws UnsupportedOperationException If called from a
- * {@link ServletContextListener#contextInitialized(ServletContextEvent)}
- * method of a {@link ServletContextListener} that was not defined in a
- * web.xml file, a web-fragment.xml file nor annotated with
- * {@link javax.servlet.annotation.WebListener}. For example, a
- * {@link ServletContextListener} defined in a TLD would not be able to
- * use this method.
- * @throws IllegalStateException
- * If the context has already been initialised
+ *
+ * @param filterName Name of filter to add
+ * @param filterClass Class of filter to add
+ *
+ * @return <code>null</code> if the filter has already been fully defined, else a
+ * {@link javax.servlet.FilterRegistration.Dynamic} object that can be used to further configure the
+ * filter
+ *
+ * @throws UnsupportedOperationException If called from a
+ * {@link ServletContextListener#contextInitialized(ServletContextEvent)}
+ * method of a {@link ServletContextListener} that was not defined in a
+ * web.xml file, a web-fragment.xml file nor annotated with
+ * {@link javax.servlet.annotation.WebListener}. For example, a
+ * {@link ServletContextListener} defined in a TLD would not be able to
+ * use this method.
+ * @throws IllegalStateException If the context has already been initialised
+ *
* @since Servlet 3.0
*/
- FilterRegistration.Dynamic addFilter(String filterName,
- Class<? extends Filter> filterClass);
+ FilterRegistration.Dynamic addFilter(String filterName, Class<? extends Filter> filterClass);
/**
- * Create a Filter instance using the given class. The instance is just
- * created. No initialisation occurs.
+ * Create a Filter instance using the given class. The instance is just created. No initialisation occurs.
*
* @param <T> The type for the given class
* @param c The the class for which an instance should be created
*
* @return The created Filter instance.
*
- * @throws ServletException If the Filter instance cannot be created
- * @throws UnsupportedOperationException If called from a
- * {@link ServletContextListener#contextInitialized(ServletContextEvent)}
- * method of a {@link ServletContextListener} that was not defined in a
- * web.xml file, a web-fragment.xml file nor annotated with
- * {@link javax.servlet.annotation.WebListener}. For example, a
- * {@link ServletContextListener} defined in a TLD would not be able to
- * use this method.
+ * @throws ServletException If the Filter instance cannot be created
+ * @throws UnsupportedOperationException If called from a
+ * {@link ServletContextListener#contextInitialized(ServletContextEvent)}
+ * method of a {@link ServletContextListener} that was not defined in a
+ * web.xml file, a web-fragment.xml file nor annotated with
+ * {@link javax.servlet.annotation.WebListener}. For example, a
+ * {@link ServletContextListener} defined in a TLD would not be able to
+ * use this method.
*
* @since Servlet 3.0
*/
@@ -789,174 +720,195 @@ public interface ServletContext {
/**
* TODO SERVLET3 - Add comments
+ *
* @param filterName TODO
+ *
* @return TODO
- * @throws UnsupportedOperationException If called from a
- * {@link ServletContextListener#contextInitialized(ServletContextEvent)}
- * method of a {@link ServletContextListener} that was not defined in a
- * web.xml file, a web-fragment.xml file nor annotated with
- * {@link javax.servlet.annotation.WebListener}. For example, a
- * {@link ServletContextListener} defined in a TLD would not be able to
- * use this method.
+ *
+ * @throws UnsupportedOperationException If called from a
+ * {@link ServletContextListener#contextInitialized(ServletContextEvent)}
+ * method of a {@link ServletContextListener} that was not defined in a
+ * web.xml file, a web-fragment.xml file nor annotated with
+ * {@link javax.servlet.annotation.WebListener}. For example, a
+ * {@link ServletContextListener} defined in a TLD would not be able to
+ * use this method.
+ *
* @since Servlet 3.0
*/
FilterRegistration getFilterRegistration(String filterName);
/**
* @return TODO
- * @throws UnsupportedOperationException If called from a
- * {@link ServletContextListener#contextInitialized(ServletContextEvent)}
- * method of a {@link ServletContextListener} that was not defined in a
- * web.xml file, a web-fragment.xml file nor annotated with
- * {@link javax.servlet.annotation.WebListener}. For example, a
- * {@link ServletContextListener} defined in a TLD would not be able to
- * use this method.
+ *
+ * @throws UnsupportedOperationException If called from a
+ * {@link ServletContextListener#contextInitialized(ServletContextEvent)}
+ * method of a {@link ServletContextListener} that was not defined in a
+ * web.xml file, a web-fragment.xml file nor annotated with
+ * {@link javax.servlet.annotation.WebListener}. For example, a
+ * {@link ServletContextListener} defined in a TLD would not be able to
+ * use this method.
+ *
* @since Servlet 3.0 TODO SERVLET3 - Add comments
*/
- Map<String, ? extends FilterRegistration> getFilterRegistrations();
+ Map<String,? extends FilterRegistration> getFilterRegistrations();
/**
* @return TODO
- * @throws UnsupportedOperationException If called from a
- * {@link ServletContextListener#contextInitialized(ServletContextEvent)}
- * method of a {@link ServletContextListener} that was not defined in a
- * web.xml file, a web-fragment.xml file nor annotated with
- * {@link javax.servlet.annotation.WebListener}. For example, a
- * {@link ServletContextListener} defined in a TLD would not be able to
- * use this method.
+ *
+ * @throws UnsupportedOperationException If called from a
+ * {@link ServletContextListener#contextInitialized(ServletContextEvent)}
+ * method of a {@link ServletContextListener} that was not defined in a
+ * web.xml file, a web-fragment.xml file nor annotated with
+ * {@link javax.servlet.annotation.WebListener}. For example, a
+ * {@link ServletContextListener} defined in a TLD would not be able to
+ * use this method.
+ *
* @since Servlet 3.0 TODO SERVLET3 - Add comments
*/
SessionCookieConfig getSessionCookieConfig();
/**
* Configures the available session tracking modes for this web application.
- * @param sessionTrackingModes The session tracking modes to use for this
- * web application
- * @throws IllegalArgumentException
- * If sessionTrackingModes specifies
- * {@link SessionTrackingMode#SSL} in combination with any other
- * {@link SessionTrackingMode}
- * @throws IllegalStateException
- * If the context has already been initialised
- * @throws UnsupportedOperationException If called from a
- * {@link ServletContextListener#contextInitialized(ServletContextEvent)}
- * method of a {@link ServletContextListener} that was not defined in a
- * web.xml file, a web-fragment.xml file nor annotated with
- * {@link javax.servlet.annotation.WebListener}. For example, a
- * {@link ServletContextListener} defined in a TLD would not be able to
- * use this method.
+ *
+ * @param sessionTrackingModes The session tracking modes to use for this web application
+ *
+ * @throws IllegalArgumentException If sessionTrackingModes specifies {@link SessionTrackingMode#SSL} in
+ * combination with any other {@link SessionTrackingMode}
+ * @throws IllegalStateException If the context has already been initialised
+ * @throws UnsupportedOperationException If called from a
+ * {@link ServletContextListener#contextInitialized(ServletContextEvent)}
+ * method of a {@link ServletContextListener} that was not defined in a
+ * web.xml file, a web-fragment.xml file nor annotated with
+ * {@link javax.servlet.annotation.WebListener}. For example, a
+ * {@link ServletContextListener} defined in a TLD would not be able to
+ * use this method.
+ *
* @since Servlet 3.0
*/
- void setSessionTrackingModes(
- Set<SessionTrackingMode> sessionTrackingModes);
+ void setSessionTrackingModes(Set<SessionTrackingMode> sessionTrackingModes);
/**
- * Obtains the default session tracking modes for this web application.
- * By default {@link SessionTrackingMode#URL} is always supported, {@link
- * SessionTrackingMode#COOKIE} is supported unless the <code>cookies</code>
- * attribute has been set to <code>false</code> for the context and {@link
- * SessionTrackingMode#SSL} is supported if at least one of the connectors
- * used by this context has the attribute <code>secure</code> set to
- * <code>true</code>.
- * @return The set of default session tracking modes for this web
- * application
- * @throws UnsupportedOperationException If called from a
- * {@link ServletContextListener#contextInitialized(ServletContextEvent)}
- * method of a {@link ServletContextListener} that was not defined in a
- * web.xml file, a web-fragment.xml file nor annotated with
- * {@link javax.servlet.annotation.WebListener}. For example, a
- * {@link ServletContextListener} defined in a TLD would not be able to
- * use this method.
+ * Obtains the default session tracking modes for this web application. By default {@link SessionTrackingMode#URL}
+ * is always supported, {@link SessionTrackingMode#COOKIE} is supported unless the <code>cookies</code> attribute
+ * has been set to <code>false</code> for the context and {@link SessionTrackingMode#SSL} is supported if at least
+ * one of the connectors used by this context has the attribute <code>secure</code> set to <code>true</code>.
+ *
+ * @return The set of default session tracking modes for this web application
+ *
+ * @throws UnsupportedOperationException If called from a
+ * {@link ServletContextListener#contextInitialized(ServletContextEvent)}
+ * method of a {@link ServletContextListener} that was not defined in a
+ * web.xml file, a web-fragment.xml file nor annotated with
+ * {@link javax.servlet.annotation.WebListener}. For example, a
+ * {@link ServletContextListener} defined in a TLD would not be able to
+ * use this method.
+ *
* @since Servlet 3.0
*/
Set<SessionTrackingMode> getDefaultSessionTrackingModes();
/**
- * Obtains the currently enabled session tracking modes for this web
- * application.
- * @return The value supplied via {@link #setSessionTrackingModes(Set)} if
- * one was previously set, else return the defaults
- * @throws UnsupportedOperationException If called from a
- * {@link ServletContextListener#contextInitialized(ServletContextEvent)}
- * method of a {@link ServletContextListener} that was not defined in a
- * web.xml file, a web-fragment.xml file nor annotated with
- * {@link javax.servlet.annotation.WebListener}. For example, a
- * {@link ServletContextListener} defined in a TLD would not be able to
- * use this method.
+ * Obtains the currently enabled session tracking modes for this web application.
+ *
+ * @return The value supplied via {@link #setSessionTrackingModes(Set)} if one was previously set, else return the
+ * defaults
+ *
+ * @throws UnsupportedOperationException If called from a
+ * {@link ServletContextListener#contextInitialized(ServletContextEvent)}
+ * method of a {@link ServletContextListener} that was not defined in a
+ * web.xml file, a web-fragment.xml file nor annotated with
+ * {@link javax.servlet.annotation.WebListener}. For example, a
+ * {@link ServletContextListener} defined in a TLD would not be able to
+ * use this method.
+ *
* @since Servlet 3.0
*/
Set<SessionTrackingMode> getEffectiveSessionTrackingModes();
/**
* TODO SERVLET3 - Add comments
+ *
* @param className TODO
- * @throws UnsupportedOperationException If called from a
- * {@link ServletContextListener#contextInitialized(ServletContextEvent)}
- * method of a {@link ServletContextListener} that was not defined in a
- * web.xml file, a web-fragment.xml file nor annotated with
- * {@link javax.servlet.annotation.WebListener}. For example, a
- * {@link ServletContextListener} defined in a TLD would not be able to
- * use this method.
+ *
+ * @throws UnsupportedOperationException If called from a
+ * {@link ServletContextListener#contextInitialized(ServletContextEvent)}
+ * method of a {@link ServletContextListener} that was not defined in a
+ * web.xml file, a web-fragment.xml file nor annotated with
+ * {@link javax.servlet.annotation.WebListener}. For example, a
+ * {@link ServletContextListener} defined in a TLD would not be able to
+ * use this method.
+ *
* @since Servlet 3.0
*/
void addListener(String className);
/**
* TODO SERVLET3 - Add comments
+ *
* @param <T> TODO
* @param t TODO
- * @throws UnsupportedOperationException If called from a
- * {@link ServletContextListener#contextInitialized(ServletContextEvent)}
- * method of a {@link ServletContextListener} that was not defined in a
- * web.xml file, a web-fragment.xml file nor annotated with
- * {@link javax.servlet.annotation.WebListener}. For example, a
- * {@link ServletContextListener} defined in a TLD would not be able to
- * use this method.
+ *
+ * @throws UnsupportedOperationException If called from a
+ * {@link ServletContextListener#contextInitialized(ServletContextEvent)}
+ * method of a {@link ServletContextListener} that was not defined in a
+ * web.xml file, a web-fragment.xml file nor annotated with
+ * {@link javax.servlet.annotation.WebListener}. For example, a
+ * {@link ServletContextListener} defined in a TLD would not be able to
+ * use this method.
+ *
* @since Servlet 3.0
*/
<T extends EventListener> void addListener(T t);
/**
* TODO SERVLET3 - Add comments
+ *
* @param listenerClass TODO
- * @throws UnsupportedOperationException If called from a
- * {@link ServletContextListener#contextInitialized(ServletContextEvent)}
- * method of a {@link ServletContextListener} that was not defined in a
- * web.xml file, a web-fragment.xml file nor annotated with
- * {@link javax.servlet.annotation.WebListener}. For example, a
- * {@link ServletContextListener} defined in a TLD would not be able to
- * use this method.
+ *
+ * @throws UnsupportedOperationException If called from a
+ * {@link ServletContextListener#contextInitialized(ServletContextEvent)}
+ * method of a {@link ServletContextListener} that was not defined in a
+ * web.xml file, a web-fragment.xml file nor annotated with
+ * {@link javax.servlet.annotation.WebListener}. For example, a
+ * {@link ServletContextListener} defined in a TLD would not be able to
+ * use this method.
+ *
* @since Servlet 3.0
*/
void addListener(Class<? extends EventListener> listenerClass);
/**
* TODO SERVLET3 - Add comments
+ *
* @param <T> TODO
- * @param c TODO
+ * @param c TODO
+ *
* @return TODO
- * @throws ServletException TODO
- * @throws UnsupportedOperationException If called from a
- * {@link ServletContextListener#contextInitialized(ServletContextEvent)}
- * method of a {@link ServletContextListener} that was not defined in a
- * web.xml file, a web-fragment.xml file nor annotated with
- * {@link javax.servlet.annotation.WebListener}. For example, a
- * {@link ServletContextListener} defined in a TLD would not be able to
- * use this method.
+ *
+ * @throws ServletException TODO
+ * @throws UnsupportedOperationException If called from a
+ * {@link ServletContextListener#contextInitialized(ServletContextEvent)}
+ * method of a {@link ServletContextListener} that was not defined in a
+ * web.xml file, a web-fragment.xml file nor annotated with
+ * {@link javax.servlet.annotation.WebListener}. For example, a
+ * {@link ServletContextListener} defined in a TLD would not be able to
+ * use this method.
+ *
* @since Servlet 3.0
*/
- <T extends EventListener> T createListener(Class<T> c)
- throws ServletException;
+ <T extends EventListener> T createListener(Class<T> c) throws ServletException;
/**
* @return TODO
- * @throws UnsupportedOperationException If called from a
- * {@link ServletContextListener#contextInitialized(ServletContextEvent)}
- * method of a {@link ServletContextListener} that was not defined in a
- * web.xml file, a web-fragment.xml file nor annotated with
- * {@link javax.servlet.annotation.WebListener}. For example, a
- * {@link ServletContextListener} defined in a TLD would not be able to
- * use this method.
+ *
+ * @throws UnsupportedOperationException If called from a
+ * {@link ServletContextListener#contextInitialized(ServletContextEvent)}
+ * method of a {@link ServletContextListener} that was not defined in a
+ * web.xml file, a web-fragment.xml file nor annotated with
+ * {@link javax.servlet.annotation.WebListener}. For example, a
+ * {@link ServletContextListener} defined in a TLD would not be able to
+ * use this method.
+ *
* @since Servlet 3.0 TODO SERVLET3 - Add comments
*/
JspConfigDescriptor getJspConfigDescriptor();
@@ -966,43 +918,44 @@ public interface ServletContext {
*
* @return The associated web application class loader
*
- * @throws UnsupportedOperationException If called from a
- * {@link ServletContextListener#contextInitialized(ServletContextEvent)}
- * method of a {@link ServletContextListener} that was not defined in a
- * web.xml file, a web-fragment.xml file nor annotated with
- * {@link javax.servlet.annotation.WebListener}. For example, a
- * {@link ServletContextListener} defined in a TLD would not be able to
- * use this method.
- * @throws SecurityException if access to the class loader is prevented by a
- * SecurityManager
+ * @throws UnsupportedOperationException If called from a
+ * {@link ServletContextListener#contextInitialized(ServletContextEvent)}
+ * method of a {@link ServletContextListener} that was not defined in a
+ * web.xml file, a web-fragment.xml file nor annotated with
+ * {@link javax.servlet.annotation.WebListener}. For example, a
+ * {@link ServletContextListener} defined in a TLD would not be able to
+ * use this method.
+ * @throws SecurityException if access to the class loader is prevented by a SecurityManager
+ *
* @since Servlet 3.0
*/
ClassLoader getClassLoader();
/**
* Add to the declared roles for this ServletContext.
+ *
* @param roleNames The roles to add
- * @throws UnsupportedOperationException If called from a
- * {@link ServletContextListener#contextInitialized(ServletContextEvent)}
- * method of a {@link ServletContextListener} that was not defined in a
- * web.xml file, a web-fragment.xml file nor annotated with
- * {@link javax.servlet.annotation.WebListener}. For example, a
- * {@link ServletContextListener} defined in a TLD would not be able to
- * use this method.
- * @throws IllegalArgumentException If the list of roleNames is null or
- * empty
- * @throws IllegalStateException If the ServletContext has already been
- * initialised
+ *
+ * @throws UnsupportedOperationException If called from a
+ * {@link ServletContextListener#contextInitialized(ServletContextEvent)}
+ * method of a {@link ServletContextListener} that was not defined in a
+ * web.xml file, a web-fragment.xml file nor annotated with
+ * {@link javax.servlet.annotation.WebListener}. For example, a
+ * {@link ServletContextListener} defined in a TLD would not be able to
+ * use this method.
+ * @throws IllegalArgumentException If the list of roleNames is null or empty
+ * @throws IllegalStateException If the ServletContext has already been initialised
+ *
* @since Servlet 3.0
*/
void declareRoles(String... roleNames);
/**
- * Get the primary name of the virtual host on which this context is
- * deployed. The name may or may not be a valid host name.
+ * Get the primary name of the virtual host on which this context is deployed. The name may or may not be a valid
+ * host name.
+ *
+ * @return The primary name of the virtual host on which this context is deployed
*
- * @return The primary name of the virtual host on which this context is
- * deployed
* @since Servlet 3.1
*/
String getVirtualServerName();
@@ -1012,33 +965,31 @@ public interface ServletContext {
*
* @return The current default session timeout in minutes
*
- * @throws UnsupportedOperationException If called from a
- * {@link ServletContextListener#contextInitialized(ServletContextEvent)}
- * method of a {@link ServletContextListener} that was not defined in a
- * web.xml file, a web-fragment.xml file nor annotated with
- * {@link javax.servlet.annotation.WebListener}. For example, a
- * {@link ServletContextListener} defined in a TLD would not be able to
- * use this method.
+ * @throws UnsupportedOperationException If called from a
+ * {@link ServletContextListener#contextInitialized(ServletContextEvent)}
+ * method of a {@link ServletContextListener} that was not defined in a
+ * web.xml file, a web-fragment.xml file nor annotated with
+ * {@link javax.servlet.annotation.WebListener}. For example, a
+ * {@link ServletContextListener} defined in a TLD would not be able to
+ * use this method.
*
* @since Servlet 4.0
*/
int getSessionTimeout();
/**
- * Set the default session timeout. This method may only be called before
- * the ServletContext is initialised.
+ * Set the default session timeout. This method may only be called before the ServletContext is initialised.
*
* @param sessionTimeout The new default session timeout in minutes.
*
- * @throws UnsupportedOperationException If called from a
- * {@link ServletContextListener#contextInitialized(ServletContextEvent)}
- * method of a {@link ServletContextListener} that was not defined in a
- * web.xml file, a web-fragment.xml file nor annotated with
- * {@link javax.servlet.annotation.WebListener}. For example, a
- * {@link ServletContextListener} defined in a TLD would not be able to
- * use this method.
- * @throws IllegalStateException If the ServletContext has already been
- * initialised
+ * @throws UnsupportedOperationException If called from a
+ * {@link ServletContextListener#contextInitialized(ServletContextEvent)}
+ * method of a {@link ServletContextListener} that was not defined in a
+ * web.xml file, a web-fragment.xml file nor annotated with
+ * {@link javax.servlet.annotation.WebListener}. For example, a
+ * {@link ServletContextListener} defined in a TLD would not be able to
+ * use this method.
+ * @throws IllegalStateException If the ServletContext has already been initialised
*
* @since Servlet 4.0
*/
@@ -1047,37 +998,34 @@ public interface ServletContext {
/**
* Get the default character encoding for reading request bodies.
*
- * @return The character encoding name or {@code null} if no default has
- * been specified
+ * @return The character encoding name or {@code null} if no default has been specified
*
- * @throws UnsupportedOperationException If called from a
- * {@link ServletContextListener#contextInitialized(ServletContextEvent)}
- * method of a {@link ServletContextListener} that was not defined in a
- * web.xml file, a web-fragment.xml file nor annotated with
- * {@link javax.servlet.annotation.WebListener}. For example, a
- * {@link ServletContextListener} defined in a TLD would not be able to
- * use this method.
+ * @throws UnsupportedOperationException If called from a
+ * {@link ServletContextListener#contextInitialized(ServletContextEvent)}
+ * method of a {@link ServletContextListener} that was not defined in a
+ * web.xml file, a web-fragment.xml file nor annotated with
+ * {@link javax.servlet.annotation.WebListener}. For example, a
+ * {@link ServletContextListener} defined in a TLD would not be able to
+ * use this method.
*
* @since Servlet 4.0
*/
String getRequestCharacterEncoding();
/**
- * Set the default character encoding to use for reading request bodies.
- * Calling this method will over-ride any value set in the deployment
- * descriptor.
+ * Set the default character encoding to use for reading request bodies. Calling this method will over-ride any
+ * value set in the deployment descriptor.
*
* @param encoding The name of the character encoding to use
*
- * @throws UnsupportedOperationException If called from a
- * {@link ServletContextListener#contextInitialized(ServletContextEvent)}
- * method of a {@link ServletContextListener} that was not defined in a
- * web.xml file, a web-fragment.xml file nor annotated with
- * {@link javax.servlet.annotation.WebListener}. For example, a
- * {@link ServletContextListener} defined in a TLD would not be able to
- * use this method.
- * @throws IllegalStateException If the ServletContext has already been
- * initialised
+ * @throws UnsupportedOperationException If called from a
+ * {@link ServletContextListener#contextInitialized(ServletContextEvent)}
+ * method of a {@link ServletContextListener} that was not defined in a
+ * web.xml file, a web-fragment.xml file nor annotated with
+ * {@link javax.servlet.annotation.WebListener}. For example, a
+ * {@link ServletContextListener} defined in a TLD would not be able to
+ * use this method.
+ * @throws IllegalStateException If the ServletContext has already been initialised
*
* @since Servlet 4.0
*/
@@ -1086,37 +1034,34 @@ public interface ServletContext {
/**
* Get the default character encoding for writing response bodies.
*
- * @return The character encoding name or {@code null} if no default has
- * been specified
+ * @return The character encoding name or {@code null} if no default has been specified
*
- * @throws UnsupportedOperationException If called from a
- * {@link ServletContextListener#contextInitialized(ServletContextEvent)}
- * method of a {@link ServletContextListener} that was not defined in a
- * web.xml file, a web-fragment.xml file nor annotated with
- * {@link javax.servlet.annotation.WebListener}. For example, a
- * {@link ServletContextListener} defined in a TLD would not be able to
- * use this method.
+ * @throws UnsupportedOperationException If called from a
+ * {@link ServletContextListener#contextInitialized(ServletContextEvent)}
+ * method of a {@link ServletContextListener} that was not defined in a
+ * web.xml file, a web-fragment.xml file nor annotated with
+ * {@link javax.servlet.annotation.WebListener}. For example, a
+ * {@link ServletContextListener} defined in a TLD would not be able to
+ * use this method.
*
* @since Servlet 4.0
*/
String getResponseCharacterEncoding();
/**
- * Set the default character encoding to use for writing response bodies.
- * Calling this method will over-ride any value set in the deployment
- * descriptor.
+ * Set the default character encoding to use for writing response bodies. Calling this method will over-ride any
+ * value set in the deployment descriptor.
*
* @param encoding The name of the character encoding to use
*
- * @throws UnsupportedOperationException If called from a
- * {@link ServletContextListener#contextInitialized(ServletContextEvent)}
- * method of a {@link ServletContextListener} that was not defined in a
- * web.xml file, a web-fragment.xml file nor annotated with
- * {@link javax.servlet.annotation.WebListener}. For example, a
- * {@link ServletContextListener} defined in a TLD would not be able to
- * use this method.
- * @throws IllegalStateException If the ServletContext has already been
- * initialised
+ * @throws UnsupportedOperationException If called from a
+ * {@link ServletContextListener#contextInitialized(ServletContextEvent)}
+ * method of a {@link ServletContextListener} that was not defined in a
+ * web.xml file, a web-fragment.xml file nor annotated with
+ * {@link javax.servlet.annotation.WebListener}. For example, a
+ * {@link ServletContextListener} defined in a TLD would not be able to
+ * use this method.
+ * @throws IllegalStateException If the ServletContext has already been initialised
*
* @since Servlet 4.0
*/
diff --git a/java/javax/servlet/ServletContextAttributeEvent.java b/java/javax/servlet/ServletContextAttributeEvent.java
index cb2cd787f7..c10411f315 100644
--- a/java/javax/servlet/ServletContextAttributeEvent.java
+++ b/java/javax/servlet/ServletContextAttributeEvent.java
@@ -17,8 +17,8 @@
package javax.servlet;
/**
- * This is the event class for notifications about changes to the attributes of
- * the servlet context of a web application.
+ * This is the event class for notifications about changes to the attributes of the servlet context of a web
+ * application.
*
* @see ServletContextAttributeListener
*
@@ -38,15 +38,13 @@ public class ServletContextAttributeEvent extends ServletContextEvent {
private final Object value;
/**
- * Construct a ServletContextAttributeEvent from the given context for the
- * given attribute name and attribute value.
+ * Construct a ServletContextAttributeEvent from the given context for the given attribute name and attribute value.
*
* @param source The ServletContext associated with this attribute event
* @param name The name of the servlet context attribute
* @param value The value of the servlet context attribute
*/
- public ServletContextAttributeEvent(ServletContext source, String name,
- Object value) {
+ public ServletContextAttributeEvent(ServletContext source, String name, Object value) {
super(source);
this.name = name;
this.value = value;
@@ -62,13 +60,11 @@ public class ServletContextAttributeEvent extends ServletContextEvent {
}
/**
- * Returns the value of the attribute that has been added, removed, or
- * replaced.
+ * Returns the value of the attribute that has been added, removed, or replaced.
*
- * @return If the attribute was added, this is the value of the attribute.
- * If the attribute was removed, this is the value of the removed
- * attribute. If the attribute was replaced, this is the old value
- * of the attribute.
+ * @return If the attribute was added, this is the value of the attribute. If the attribute was removed, this is the
+ * value of the removed attribute. If the attribute was replaced, this is the old value of the
+ * attribute.
*/
public Object getValue() {
return this.value;
diff --git a/java/javax/servlet/ServletContextAttributeListener.java b/java/javax/servlet/ServletContextAttributeListener.java
index 2946c82427..b9d9fed467 100644
--- a/java/javax/servlet/ServletContextAttributeListener.java
+++ b/java/javax/servlet/ServletContextAttributeListener.java
@@ -19,10 +19,9 @@ package javax.servlet;
import java.util.EventListener;
/**
- * Implementations of this interface receive notifications of changes to the
- * attribute list on the servlet context of a web application. To receive
- * notification events, the implementation class must be configured in the
- * deployment descriptor for the web application.
+ * Implementations of this interface receive notifications of changes to the attribute list on the servlet context of a
+ * web application. To receive notification events, the implementation class must be configured in the deployment
+ * descriptor for the web application.
*
* @see ServletContextAttributeEvent
*
@@ -31,27 +30,27 @@ import java.util.EventListener;
public interface ServletContextAttributeListener extends EventListener {
/**
- * Notification that a new attribute was added to the servlet context.
- * Called after the attribute is added.
- * The default implementation is a NO-OP.
+ * Notification that a new attribute was added to the servlet context. Called after the attribute is added. The
+ * default implementation is a NO-OP.
+ *
* @param scae Information about the new attribute
*/
default void attributeAdded(ServletContextAttributeEvent scae) {
}
/**
- * Notification that an existing attribute has been removed from the servlet
- * context. Called after the attribute is removed.
- * The default implementation is a NO-OP.
+ * Notification that an existing attribute has been removed from the servlet context. Called after the attribute is
+ * removed. The default implementation is a NO-OP.
+ *
* @param scae Information about the removed attribute
*/
default void attributeRemoved(ServletContextAttributeEvent scae) {
}
/**
- * Notification that an attribute on the servlet context has been replaced.
- * Called after the attribute is replaced.
+ * Notification that an attribute on the servlet context has been replaced. Called after the attribute is replaced.
* The default implementation is a NO-OP.
+ *
* @param scae Information about the replaced attribute
*/
default void attributeReplaced(ServletContextAttributeEvent scae) {
diff --git a/java/javax/servlet/ServletContextEvent.java b/java/javax/servlet/ServletContextEvent.java
index ac0a53cccf..f5afec9840 100644
--- a/java/javax/servlet/ServletContextEvent.java
+++ b/java/javax/servlet/ServletContextEvent.java
@@ -17,8 +17,7 @@
package javax.servlet;
/**
- * This is the event class for notifications about changes to the servlet
- * context of a web application.
+ * This is the event class for notifications about changes to the servlet context of a web application.
*
* @see ServletContextListener
*
@@ -31,8 +30,7 @@ public class ServletContextEvent extends java.util.EventObject {
/**
* Construct a ServletContextEvent from the given context.
*
- * @param source
- * - the ServletContext that is sending the event.
+ * @param source - the ServletContext that is sending the event.
*/
public ServletContextEvent(ServletContext source) {
super(source);
diff --git a/java/javax/servlet/ServletContextListener.java b/java/javax/servlet/ServletContextListener.java
index 82d3575a85..2725419abd 100644
--- a/java/javax/servlet/ServletContextListener.java
+++ b/java/javax/servlet/ServletContextListener.java
@@ -19,10 +19,9 @@ package javax.servlet;
import java.util.EventListener;
/**
- * Implementations of this interface receive notifications about changes to the
- * servlet context of the web application they are part of. To receive
- * notification events, the implementation class must be configured in the
- * deployment descriptor for the web application.
+ * Implementations of this interface receive notifications about changes to the servlet context of the web application
+ * they are part of. To receive notification events, the implementation class must be configured in the deployment
+ * descriptor for the web application.
*
* @see ServletContextEvent
*
@@ -31,20 +30,19 @@ import java.util.EventListener;
public interface ServletContextListener extends EventListener {
/**
- ** Notification that the web application initialization process is starting.
- * All ServletContextListeners are notified of context initialization before
- * any filter or servlet in the web application is initialized.
- * The default implementation is a NO-OP.
+ ** Notification that the web application initialization process is starting. All ServletContextListeners are
+ * notified of context initialization before any filter or servlet in the web application is initialized. The
+ * default implementation is a NO-OP.
+ *
* @param sce Information about the ServletContext that was initialized
*/
default void contextInitialized(ServletContextEvent sce) {
}
/**
- ** Notification that the servlet context is about to be shut down. All
- * servlets and filters have been destroyed before any
- * ServletContextListeners are notified of context destruction.
- * The default implementation is a NO-OP.
+ ** Notification that the servlet context is about to be shut down. All servlets and filters have been destroyed
+ * before any ServletContextListeners are notified of context destruction. The default implementation is a NO-OP.
+ *
* @param sce Information about the ServletContext that was destroyed
*/
default void contextDestroyed(ServletContextEvent sce) {
diff --git a/java/javax/servlet/ServletException.java b/java/javax/servlet/ServletException.java
index 96e3e5cb9f..dad75ae5be 100644
--- a/java/javax/servlet/ServletException.java
+++ b/java/javax/servlet/ServletException.java
@@ -17,8 +17,7 @@
package javax.servlet;
/**
- * Defines a general exception a servlet can throw when it encounters
- * difficulty.
+ * Defines a general exception a servlet can throw when it encounters difficulty.
*/
public class ServletException extends Exception {
@@ -32,49 +31,38 @@ public class ServletException extends Exception {
}
/**
- * Constructs a new servlet exception with the specified message. The
- * message can be written to the server log and/or displayed for the user.
+ * Constructs a new servlet exception with the specified message. The message can be written to the server log
+ * and/or displayed for the user.
*
- * @param message
- * a <code>String</code> specifying the text of the exception
- * message
+ * @param message a <code>String</code> specifying the text of the exception message
*/
public ServletException(String message) {
super(message);
}
/**
- * Constructs a new servlet exception when the servlet needs to throw an
- * exception and include a message about the "root cause" exception that
- * interfered with its normal operation, including a description message.
+ * Constructs a new servlet exception when the servlet needs to throw an exception and include a message about the
+ * "root cause" exception that interfered with its normal operation, including a description message.
*
- * @param message
- * a <code>String</code> containing the text of the exception
- * message
- * @param rootCause
- * the <code>Throwable</code> exception that interfered with the
- * servlet's normal operation, making this servlet exception
- * necessary
+ * @param message a <code>String</code> containing the text of the exception message
+ * @param rootCause the <code>Throwable</code> exception that interfered with the servlet's normal operation, making
+ * this servlet exception necessary
*/
public ServletException(String message, Throwable rootCause) {
super(message, rootCause);
}
/**
- * Constructs a new servlet exception when the servlet needs to throw an
- * exception and include a message about the "root cause" exception that
- * interfered with its normal operation. The exception's message is based on
- * the localized message of the underlying exception.
+ * Constructs a new servlet exception when the servlet needs to throw an exception and include a message about the
+ * "root cause" exception that interfered with its normal operation. The exception's message is based on the
+ * localized message of the underlying exception.
* <p>
- * This method calls the <code>getLocalizedMessage</code> method on the
- * <code>Throwable</code> exception to get a localized exception message.
- * When subclassing <code>ServletException</code>, this method can be
- * overridden to create an exception message designed for a specific locale.
+ * This method calls the <code>getLocalizedMessage</code> method on the <code>Throwable</code> exception to get a
+ * localized exception message. When subclassing <code>ServletException</code>, this method can be overridden to
+ * create an exception message designed for a specific locale.
*
- * @param rootCause
- * the <code>Throwable</code> exception that interfered with the
- * servlet's normal operation, making the servlet exception
- * necessary
+ * @param rootCause the <code>Throwable</code> exception that interfered with the servlet's normal operation, making
+ * the servlet exception necessary
*/
public ServletException(Throwable rootCause) {
super(rootCause);
diff --git a/java/javax/servlet/ServletInputStream.java b/java/javax/servlet/ServletInputStream.java
index 4e5139e5cd..2e2850c088 100644
--- a/java/javax/servlet/ServletInputStream.java
+++ b/java/javax/servlet/ServletInputStream.java
@@ -20,17 +20,14 @@ import java.io.IOException;
import java.io.InputStream;
/**
- * Provides an input stream for reading binary data from a client request,
- * including an efficient <code>readLine</code> method for reading data one line
- * at a time. With some protocols, such as HTTP POST and PUT, a
- * <code>ServletInputStream</code> object can be used to read data sent from the
- * client.
+ * Provides an input stream for reading binary data from a client request, including an efficient <code>readLine</code>
+ * method for reading data one line at a time. With some protocols, such as HTTP POST and PUT, a
+ * <code>ServletInputStream</code> object can be used to read data sent from the client.
* <p>
- * A <code>ServletInputStream</code> object is normally retrieved via the
- * {@link ServletRequest#getInputStream} method.
+ * A <code>ServletInputStream</code> object is normally retrieved via the {@link ServletRequest#getInputStream} method.
* <p>
- * This is an abstract class that a servlet container implements. Subclasses of
- * this class must implement the <code>java.io.InputStream.read()</code> method.
+ * This is an abstract class that a servlet container implements. Subclasses of this class must implement the
+ * <code>java.io.InputStream.read()</code> method.
*
* @see ServletRequest
*/
@@ -44,24 +41,18 @@ public abstract class ServletInputStream extends InputStream {
}
/**
- * Reads the input stream, one line at a time. Starting at an offset, reads
- * bytes into an array, until it reads a certain number of bytes or reaches
- * a newline character, which it reads into the array as well.
+ * Reads the input stream, one line at a time. Starting at an offset, reads bytes into an array, until it reads a
+ * certain number of bytes or reaches a newline character, which it reads into the array as well.
* <p>
- * This method returns -1 if it reaches the end of the input stream before
- * reading the maximum number of bytes.
+ * This method returns -1 if it reaches the end of the input stream before reading the maximum number of bytes.
*
- * @param b
- * an array of bytes into which data is read
- * @param off
- * an integer specifying the character at which this method
- * begins reading
- * @param len
- * an integer specifying the maximum number of bytes to read
- * @return an integer specifying the actual number of bytes read, or -1 if
- * the end of the stream is reached
- * @exception IOException
- * if an input or output exception has occurred
+ * @param b an array of bytes into which data is read
+ * @param off an integer specifying the character at which this method begins reading
+ * @param len an integer specifying the maximum number of bytes to read
+ *
+ * @return an integer specifying the actual number of bytes read, or -1 if the end of the stream is reached
+ *
+ * @exception IOException if an input or output exception has occurred
*/
public int readLine(byte[] b, int off, int len) throws IOException {
@@ -83,37 +74,31 @@ public abstract class ServletInputStream extends InputStream {
/**
* Has the end of this InputStream been reached?
*
- * @return <code>true</code> if all the data has been read from the stream,
- * else <code>false</code>
+ * @return <code>true</code> if all the data has been read from the stream, else <code>false</code>
*
* @since Servlet 3.1
*/
public abstract boolean isFinished();
/**
- * Can data be read from this InputStream without blocking?
- * Returns If this method is called and returns false, the container will
- * invoke {@link ReadListener#onDataAvailable()} when data is available.
+ * Can data be read from this InputStream without blocking? Returns If this method is called and returns false, the
+ * container will invoke {@link ReadListener#onDataAvailable()} when data is available.
*
- * @return <code>true</code> if data can be read without blocking, else
- * <code>false</code>
+ * @return <code>true</code> if data can be read without blocking, else <code>false</code>
*
* @since Servlet 3.1
*/
public abstract boolean isReady();
/**
- * Sets the {@link ReadListener} for this {@link ServletInputStream} and
- * thereby switches to non-blocking IO. It is only valid to switch to
- * non-blocking IO within async processing or HTTP upgrade processing.
+ * Sets the {@link ReadListener} for this {@link ServletInputStream} and thereby switches to non-blocking IO. It is
+ * only valid to switch to non-blocking IO within async processing or HTTP upgrade processing.
*
- * @param listener The non-blocking IO read listener
+ * @param listener The non-blocking IO read listener
*
- * @throws IllegalStateException If this method is called if neither
- * async nor HTTP upgrade is in progress or
- * if the {@link ReadListener} has already
- * been set
- * @throws NullPointerException If listener is null
+ * @throws IllegalStateException If this method is called if neither async nor HTTP upgrade is in progress or if the
+ * {@link ReadListener} has already been set
+ * @throws NullPointerException If listener is null
*
* @since Servlet 3.1
*/
diff --git a/java/javax/servlet/ServletOutputStream.java b/java/javax/servlet/ServletOutputStream.java
index 7cc1d38469..61c3c0f2c3 100644
--- a/java/javax/servlet/ServletOutputStream.java
+++ b/java/javax/servlet/ServletOutputStream.java
@@ -23,13 +23,11 @@ import java.text.MessageFormat;
import java.util.ResourceBundle;
/**
- * Provides an output stream for sending binary data to the client. A
- * <code>ServletOutputStream</code> object is normally retrieved via the
- * {@link ServletResponse#getOutputStream} method.
+ * Provides an output stream for sending binary data to the client. A <code>ServletOutputStream</code> object is
+ * normally retrieved via the {@link ServletResponse#getOutputStream} method.
* <p>
- * This is an abstract class that the servlet container implements. Subclasses
- * of this class must implement the <code>java.io.OutputStream.write(int)</code>
- * method.
+ * This is an abstract class that the servlet container implements. Subclasses of this class must implement the
+ * <code>java.io.OutputStream.write(int)</code> method.
*
* @see ServletResponse
*/
@@ -46,13 +44,11 @@ public abstract class ServletOutputStream extends OutputStream {
}
/**
- * Writes a <code>String</code> to the client, without a carriage
- * return-line feed (CRLF) character at the end.
+ * Writes a <code>String</code> to the client, without a carriage return-line feed (CRLF) character at the end.
*
- * @param s
- * the <code>String</code> to send to the client
- * @exception IOException
- * if an input or output exception occurred
+ * @param s the <code>String</code> to send to the client
+ *
+ * @exception IOException if an input or output exception occurred
*/
public void print(String s) throws IOException {
if (s == null) {
@@ -83,13 +79,11 @@ public abstract class ServletOutputStream extends OutputStream {
}
/**
- * Writes a <code>boolean</code> value to the client, with no carriage
- * return-line feed (CRLF) character at the end.
+ * Writes a <code>boolean</code> value to the client, with no carriage return-line feed (CRLF) character at the end.
+ *
+ * @param b the <code>boolean</code> value to send to the client
*
- * @param b
- * the <code>boolean</code> value to send to the client
- * @exception IOException
- * if an input or output exception occurred
+ * @exception IOException if an input or output exception occurred
*/
public void print(boolean b) throws IOException {
String msg;
@@ -102,65 +96,55 @@ public abstract class ServletOutputStream extends OutputStream {
}
/**
- * Writes a character to the client, with no carriage return-line feed
- * (CRLF) at the end.
+ * Writes a character to the client, with no carriage return-line feed (CRLF) at the end.
*
- * @param c
- * the character to send to the client
- * @exception IOException
- * if an input or output exception occurred
+ * @param c the character to send to the client
+ *
+ * @exception IOException if an input or output exception occurred
*/
public void print(char c) throws IOException {
print(String.valueOf(c));
}
/**
- * Writes an int to the client, with no carriage return-line feed (CRLF) at
- * the end.
+ * Writes an int to the client, with no carriage return-line feed (CRLF) at the end.
+ *
+ * @param i the int to send to the client
*
- * @param i
- * the int to send to the client
- * @exception IOException
- * if an input or output exception occurred
+ * @exception IOException if an input or output exception occurred
*/
public void print(int i) throws IOException {
print(String.valueOf(i));
}
/**
- * Writes a <code>long</code> value to the client, with no carriage
- * return-line feed (CRLF) at the end.
+ * Writes a <code>long</code> value to the client, with no carriage return-line feed (CRLF) at the end.
*
- * @param l
- * the <code>long</code> value to send to the client
- * @exception IOException
- * if an input or output exception occurred
+ * @param l the <code>long</code> value to send to the client
+ *
+ * @exception IOException if an input or output exception occurred
*/
public void print(long l) throws IOException {
print(String.valueOf(l));
}
/**
- * Writes a <code>float</code> value to the client, with no carriage
- * return-line feed (CRLF) at the end.
+ * Writes a <code>float</code> value to the client, with no carriage return-line feed (CRLF) at the end.
+ *
+ * @param f the <code>float</code> value to send to the client
*
- * @param f
- * the <code>float</code> value to send to the client
- * @exception IOException
- * if an input or output exception occurred
+ * @exception IOException if an input or output exception occurred
*/
public void print(float f) throws IOException {
print(String.valueOf(f));
}
/**
- * Writes a <code>double</code> value to the client, with no carriage
- * return-line feed (CRLF) at the end.
+ * Writes a <code>double</code> value to the client, with no carriage return-line feed (CRLF) at the end.
+ *
+ * @param d the <code>double</code> value to send to the client
*
- * @param d
- * the <code>double</code> value to send to the client
- * @exception IOException
- * if an input or output exception occurred
+ * @exception IOException if an input or output exception occurred
*/
public void print(double d) throws IOException {
print(String.valueOf(d));
@@ -169,21 +153,18 @@ public abstract class ServletOutputStream extends OutputStream {
/**
* Writes a carriage return-line feed (CRLF) to the client.
*
- * @exception IOException
- * if an input or output exception occurred
+ * @exception IOException if an input or output exception occurred
*/
public void println() throws IOException {
print("\r\n");
}
/**
- * Writes a <code>String</code> to the client, followed by a carriage
- * return-line feed (CRLF).
+ * Writes a <code>String</code> to the client, followed by a carriage return-line feed (CRLF).
*
- * @param s
- * the <code>String</code> to write to the client
- * @exception IOException
- * if an input or output exception occurred
+ * @param s the <code>String</code> to write to the client
+ *
+ * @exception IOException if an input or output exception occurred
*/
public void println(String s) throws IOException {
StringBuilder sb = new StringBuilder();
@@ -193,13 +174,11 @@ public abstract class ServletOutputStream extends OutputStream {
}
/**
- * Writes a <code>boolean</code> value to the client, followed by a carriage
- * return-line feed (CRLF).
+ * Writes a <code>boolean</code> value to the client, followed by a carriage return-line feed (CRLF).
+ *
+ * @param b the <code>boolean</code> value to write to the client
*
- * @param b
- * the <code>boolean</code> value to write to the client
- * @exception IOException
- * if an input or output exception occurred
+ * @exception IOException if an input or output exception occurred
*/
public void println(boolean b) throws IOException {
StringBuilder sb = new StringBuilder();
@@ -213,76 +192,64 @@ public abstract class ServletOutputStream extends OutputStream {
}
/**
- * Writes a character to the client, followed by a carriage return-line feed
- * (CRLF).
+ * Writes a character to the client, followed by a carriage return-line feed (CRLF).
*
- * @param c
- * the character to write to the client
- * @exception IOException
- * if an input or output exception occurred
+ * @param c the character to write to the client
+ *
+ * @exception IOException if an input or output exception occurred
*/
public void println(char c) throws IOException {
println(String.valueOf(c));
}
/**
- * Writes an int to the client, followed by a carriage return-line feed
- * (CRLF) character.
+ * Writes an int to the client, followed by a carriage return-line feed (CRLF) character.
+ *
+ * @param i the int to write to the client
*
- * @param i
- * the int to write to the client
- * @exception IOException
- * if an input or output exception occurred
+ * @exception IOException if an input or output exception occurred
*/
public void println(int i) throws IOException {
println(String.valueOf(i));
}
/**
- * Writes a <code>long</code> value to the client, followed by a carriage
- * return-line feed (CRLF).
+ * Writes a <code>long</code> value to the client, followed by a carriage return-line feed (CRLF).
*
- * @param l
- * the <code>long</code> value to write to the client
- * @exception IOException
- * if an input or output exception occurred
+ * @param l the <code>long</code> value to write to the client
+ *
+ * @exception IOException if an input or output exception occurred
*/
public void println(long l) throws IOException {
println(String.valueOf(l));
}
/**
- * Writes a <code>float</code> value to the client, followed by a carriage
- * return-line feed (CRLF).
+ * Writes a <code>float</code> value to the client, followed by a carriage return-line feed (CRLF).
+ *
+ * @param f the <code>float</code> value to write to the client
*
- * @param f
- * the <code>float</code> value to write to the client
- * @exception IOException
- * if an input or output exception occurred
+ * @exception IOException if an input or output exception occurred
*/
public void println(float f) throws IOException {
println(String.valueOf(f));
}
/**
- * Writes a <code>double</code> value to the client, followed by a carriage
- * return-line feed (CRLF).
+ * Writes a <code>double</code> value to the client, followed by a carriage return-line feed (CRLF).
+ *
+ * @param d the <code>double</code> value to write to the client
*
- * @param d
- * the <code>double</code> value to write to the client
- * @exception IOException
- * if an input or output exception occurred
+ * @exception IOException if an input or output exception occurred
*/
public void println(double d) throws IOException {
println(String.valueOf(d));
}
/**
- * Checks if a non-blocking write will succeed. If this returns
- * <code>false</code>, it will cause a callback to
- * {@link WriteListener#onWritePossible()} when the buffer has emptied. If
- * this method returns <code>false</code> no further data must be written
- * until the container calls {@link WriteListener#onWritePossible()}.
+ * Checks if a non-blocking write will succeed. If this returns <code>false</code>, it will cause a callback to
+ * {@link WriteListener#onWritePossible()} when the buffer has emptied. If this method returns <code>false</code> no
+ * further data must be written until the container calls {@link WriteListener#onWritePossible()}.
*
* @return <code>true</code> if data can be written, else <code>false</code>
*
@@ -291,17 +258,14 @@ public abstract class ServletOutputStream extends OutputStream {
public abstract boolean isReady();
/**
- * Sets the {@link WriteListener} for this {@link ServletOutputStream} and
- * thereby switches to non-blocking IO. It is only valid to switch to
- * non-blocking IO within async processing or HTTP upgrade processing.
+ * Sets the {@link WriteListener} for this {@link ServletOutputStream} and thereby switches to non-blocking IO. It
+ * is only valid to switch to non-blocking IO within async processing or HTTP upgrade processing.
*
- * @param listener The non-blocking IO write listener
+ * @param listener The non-blocking IO write listener
*
- * @throws IllegalStateException If this method is called if neither
- * async nor HTTP upgrade is in progress or
- * if the {@link WriteListener} has already
- * been set
- * @throws NullPointerException If listener is null
+ * @throws IllegalStateException If this method is called if neither async nor HTTP upgrade is in progress or if the
+ * {@link WriteListener} has already been set
+ * @throws NullPointerException If listener is null
*
* @since Servlet 3.1
*/
diff --git a/java/javax/servlet/ServletRegistration.java b/java/javax/servlet/ServletRegistration.java
index f8422c58e9..dc8a3a1c84 100644
--- a/java/javax/servlet/ServletRegistration.java
+++ b/java/javax/servlet/ServletRegistration.java
@@ -27,58 +27,48 @@ import java.util.Set;
public interface ServletRegistration extends Registration {
/**
- * Adds a servlet mapping with the given URL patterns for the Servlet
- * represented by this ServletRegistration. If any of the specified URL
- * patterns are already mapped to a different Servlet, no updates will
- * be performed.
- *
- * If this method is called multiple times, each successive call adds to
- * the effects of the former. The returned set is not backed by the
- * ServletRegistration object, so changes in the returned set are not
- * reflected in the ServletRegistration object, and vice-versa.
+ * Adds a servlet mapping with the given URL patterns for the Servlet represented by this ServletRegistration. If
+ * any of the specified URL patterns are already mapped to a different Servlet, no updates will be performed. If
+ * this method is called multiple times, each successive call adds to the effects of the former. The returned set is
+ * not backed by the ServletRegistration object, so changes in the returned set are not reflected in the
+ * ServletRegistration object, and vice-versa.
*
* @param urlPatterns The URL patterns that this Servlet should be mapped to
- * @return the (possibly empty) Set of URL patterns that are already mapped
- * to a different Servlet
+ *
+ * @return the (possibly empty) Set of URL patterns that are already mapped to a different Servlet
+ *
* @throws IllegalArgumentException if urlPattern is null or empty
- * @throws IllegalStateException if the associated ServletContext has
- * already been initialised
+ * @throws IllegalStateException if the associated ServletContext has already been initialised
*/
Set<String> addMapping(String... urlPatterns);
/**
- * Gets the currently available mappings of the Servlet represented by this
- * ServletRegistration.
- *
- * If permitted, any changes to the returned Collection must not affect this
- * ServletRegistration.
+ * Gets the currently available mappings of the Servlet represented by this ServletRegistration. If permitted, any
+ * changes to the returned Collection must not affect this ServletRegistration.
*
- * @return a (possibly empty) Collection of the currently available mappings
- * of the Servlet represented by this ServletRegistration
+ * @return a (possibly empty) Collection of the currently available mappings of the Servlet represented by this
+ * ServletRegistration
*/
Collection<String> getMappings();
/**
- * Obtain the name of the user / group under which the Servlet has been
- * configured to run.
+ * Obtain the name of the user / group under which the Servlet has been configured to run.
*
- * @return the name of the user / group or {@code null} if none has been
- * specified
+ * @return the name of the user / group or {@code null} if none has been specified
*/
String getRunAsRole();
/**
- * Interface through which a Servlet registered via one of the addServlet
- * methods on ServletContext may be further configured.
+ * Interface through which a Servlet registered via one of the addServlet methods on ServletContext may be further
+ * configured.
*/
interface Dynamic extends ServletRegistration, Registration.Dynamic {
/**
* Set the loadOnStartup order for the Servlet
*
- * @param loadOnStartup The position in the order the Servlet should be
- * started (higher numbers are started after lower
- * numbers)
+ * @param loadOnStartup The position in the order the Servlet should be started (higher numbers are started
+ * after lower numbers)
*/
void setLoadOnStartup(int loadOnStartup);
@@ -87,24 +77,20 @@ public interface ServletRegistration extends Registration {
*
* @param constraint new security constraints for this Servlet
*
- * @return urls currently mapped to this registration that are already
- * present in web.xml
+ * @return urls currently mapped to this registration that are already present in web.xml
*/
Set<String> setServletSecurity(ServletSecurityElement constraint);
/**
- * Set the multi-part configuration for the associated Servlet. To clear
- * the multi-part configuration specify <code>null</code> as the new
- * value.
+ * Set the multi-part configuration for the associated Servlet. To clear the multi-part configuration specify
+ * <code>null</code> as the new value.
*
- * @param multipartConfig The configuration to associate with the
- * Servlet
+ * @param multipartConfig The configuration to associate with the Servlet
*/
void setMultipartConfig(MultipartConfigElement multipartConfig);
/**
- * Set the name of the user / group under which the Servlet should be
- * configured to run.
+ * Set the name of the user / group under which the Servlet should be configured to run.
*
* @param roleName name of the user / group or {@code null} if none
*/
diff --git a/java/javax/servlet/ServletRequest.java b/java/javax/servlet/ServletRequest.java
index 9422c295e9..1d1ee6fd94 100644
--- a/java/javax/servlet/ServletRequest.java
+++ b/java/javax/servlet/ServletRequest.java
@@ -23,381 +23,309 @@ import java.util.Locale;
import java.util.Map;
/**
- * Defines an object to provide client request information to a servlet. The
- * servlet container creates a <code>ServletRequest</code> object and passes it
- * as an argument to the servlet's <code>service</code> method.
+ * Defines an object to provide client request information to a servlet. The servlet container creates a
+ * <code>ServletRequest</code> object and passes it as an argument to the servlet's <code>service</code> method.
* <p>
- * A <code>ServletRequest</code> object provides data including parameter name
- * and values, attributes, and an input stream. Interfaces that extend
- * <code>ServletRequest</code> can provide additional protocol-specific data
- * (for example, HTTP data is provided by
- * {@link javax.servlet.http.HttpServletRequest}.
+ * A <code>ServletRequest</code> object provides data including parameter name and values, attributes, and an input
+ * stream. Interfaces that extend <code>ServletRequest</code> can provide additional protocol-specific data (for
+ * example, HTTP data is provided by {@link javax.servlet.http.HttpServletRequest}.
*
* @see javax.servlet.http.HttpServletRequest
*/
public interface ServletRequest {
/**
- * Returns the value of the named attribute as an <code>Object</code>, or
- * <code>null</code> if no attribute of the given name exists.
+ * Returns the value of the named attribute as an <code>Object</code>, or <code>null</code> if no attribute of the
+ * given name exists.
* <p>
- * Attributes can be set two ways. The servlet container may set attributes
- * to make available custom information about a request. For example, for
- * requests made using HTTPS, the attribute
- * <code>javax.servlet.request.X509Certificate</code> can be used to
- * retrieve information on the certificate of the client. Attributes can
- * also be set programmatically using {@link ServletRequest#setAttribute}.
- * This allows information to be embedded into a request before a
- * {@link RequestDispatcher} call.
+ * Attributes can be set two ways. The servlet container may set attributes to make available custom information
+ * about a request. For example, for requests made using HTTPS, the attribute
+ * <code>javax.servlet.request.X509Certificate</code> can be used to retrieve information on the certificate of the
+ * client. Attributes can also be set programmatically using {@link ServletRequest#setAttribute}. This allows
+ * information to be embedded into a request before a {@link RequestDispatcher} call.
* <p>
- * Attribute names should follow the same conventions as package names.
- * Names beginning with <code>java.*</code> and <code>javax.*</code> are
- * reserved for use by the Servlet specification. Names beginning with
- * <code>sun.*</code>, <code>com.sun.*</code>, <code>oracle.*</code> and
- * <code>com.oracle.*</code>) are reserved for use by Oracle Corporation.
+ * Attribute names should follow the same conventions as package names. Names beginning with <code>java.*</code> and
+ * <code>javax.*</code> are reserved for use by the Servlet specification. Names beginning with <code>sun.*</code>,
+ * <code>com.sun.*</code>, <code>oracle.*</code> and <code>com.oracle.*</code>) are reserved for use by Oracle
+ * Corporation.
*
- * @param name
- * a <code>String</code> specifying the name of the attribute
- * @return an <code>Object</code> containing the value of the attribute, or
- * <code>null</code> if the attribute does not exist
+ * @param name a <code>String</code> specifying the name of the attribute
+ *
+ * @return an <code>Object</code> containing the value of the attribute, or <code>null</code> if the attribute does
+ * not exist
*/
Object getAttribute(String name);
/**
- * Returns an <code>Enumeration</code> containing the names of the
- * attributes available to this request. This method returns an empty
- * <code>Enumeration</code> if the request has no attributes available to
- * it.
+ * Returns an <code>Enumeration</code> containing the names of the attributes available to this request. This method
+ * returns an empty <code>Enumeration</code> if the request has no attributes available to it.
*
- * @return an <code>Enumeration</code> of strings containing the names of the
- * request's attributes
+ * @return an <code>Enumeration</code> of strings containing the names of the request's attributes
*/
Enumeration<String> getAttributeNames();
/**
- * Returns the name of the character encoding used in the body of this
- * request. This method returns <code>null</code> if the no character
- * encoding has been specified. The following priority order is used to
+ * Returns the name of the character encoding used in the body of this request. This method returns
+ * <code>null</code> if the no character encoding has been specified. The following priority order is used to
* determine the specified encoding:
* <ol>
* <li>per request</li>
* <li>web application default via the deployment descriptor or
- * {@link ServletContext#setRequestCharacterEncoding(String)}</li>
+ * {@link ServletContext#setRequestCharacterEncoding(String)}</li>
* <li>container default via container specific configuration</li>
* </ol>
*
- * @return a <code>String</code> containing the name of the character
- * encoding, or <code>null</code> if the request does not specify a
- * character encoding
+ * @return a <code>String</code> containing the name of the character encoding, or <code>null</code> if the request
+ * does not specify a character encoding
*/
String getCharacterEncoding();
/**
- * Overrides the name of the character encoding used in the body of this
- * request. This method must be called prior to reading request parameters
- * or reading input using getReader().
+ * Overrides the name of the character encoding used in the body of this request. This method must be called prior
+ * to reading request parameters or reading input using getReader().
+ *
+ * @param env a <code>String</code> containing the name of the character encoding.
*
- * @param env
- * a <code>String</code> containing the name of the character
- * encoding.
- * @throws java.io.UnsupportedEncodingException
- * if this is not a valid encoding
+ * @throws java.io.UnsupportedEncodingException if this is not a valid encoding
*/
- void setCharacterEncoding(String env)
- throws java.io.UnsupportedEncodingException;
+ void setCharacterEncoding(String env) throws java.io.UnsupportedEncodingException;
/**
- * Returns the length, in bytes, of the request body and made available by
- * the input stream, or -1 if the length is not known. For HTTP servlets,
- * same as the value of the CGI variable CONTENT_LENGTH.
+ * Returns the length, in bytes, of the request body and made available by the input stream, or -1 if the length is
+ * not known. For HTTP servlets, same as the value of the CGI variable CONTENT_LENGTH.
*
- * @return an integer containing the length of the request body or -1 if the
- * length is not known or is greater than {@link Integer#MAX_VALUE}
+ * @return an integer containing the length of the request body or -1 if the length is not known or is greater than
+ * {@link Integer#MAX_VALUE}
*/
int getContentLength();
/**
- * Returns the length, in bytes, of the request body and made available by
- * the input stream, or -1 if the length is not known. For HTTP servlets,
- * same as the value of the CGI variable CONTENT_LENGTH.
+ * Returns the length, in bytes, of the request body and made available by the input stream, or -1 if the length is
+ * not known. For HTTP servlets, same as the value of the CGI variable CONTENT_LENGTH.
+ *
+ * @return a long integer containing the length of the request body or -1 if the length is not known
*
- * @return a long integer containing the length of the request body or -1 if
- * the length is not known
* @since Servlet 3.1
*/
long getContentLengthLong();
/**
- * Returns the MIME type of the body of the request, or <code>null</code> if
- * the type is not known. For HTTP servlets, same as the value of the CGI
- * variable CONTENT_TYPE.
+ * Returns the MIME type of the body of the request, or <code>null</code> if the type is not known. For HTTP
+ * servlets, same as the value of the CGI variable CONTENT_TYPE.
*
- * @return a <code>String</code> containing the name of the MIME type of the
- * request, or null if the type is not known
+ * @return a <code>String</code> containing the name of the MIME type of the request, or null if the type is not
+ * known
*/
String getContentType();
/**
- * Retrieves the body of the request as binary data using a
- * {@link ServletInputStream}. Either this method or {@link #getReader} may
- * be called to read the body, not both.
+ * Retrieves the body of the request as binary data using a {@link ServletInputStream}. Either this method or
+ * {@link #getReader} may be called to read the body, not both.
+ *
+ * @return a {@link ServletInputStream} object containing the body of the request
*
- * @return a {@link ServletInputStream} object containing the body of the
- * request
- * @exception IllegalStateException
- * if the {@link #getReader} method has already been called
- * for this request
- * @exception IOException
- * if an input or output exception occurred
+ * @exception IllegalStateException if the {@link #getReader} method has already been called for this request
+ * @exception IOException if an input or output exception occurred
*/
ServletInputStream getInputStream() throws IOException;
/**
- * Returns the value of a request parameter as a <code>String</code>, or
- * <code>null</code> if the parameter does not exist. Request parameters are
- * extra information sent with the request. For HTTP servlets, parameters
- * are contained in the query string or posted form data.
+ * Returns the value of a request parameter as a <code>String</code>, or <code>null</code> if the parameter does not
+ * exist. Request parameters are extra information sent with the request. For HTTP servlets, parameters are
+ * contained in the query string or posted form data.
* <p>
- * You should only use this method when you are sure the parameter has only
- * one value. If the parameter might have more than one value, use
- * {@link #getParameterValues}.
+ * You should only use this method when you are sure the parameter has only one value. If the parameter might have
+ * more than one value, use {@link #getParameterValues}.
* <p>
- * If you use this method with a multivalued parameter, the value returned
- * is equal to the first value in the array returned by
- * <code>getParameterValues</code>.
+ * If you use this method with a multivalued parameter, the value returned is equal to the first value in the array
+ * returned by <code>getParameterValues</code>.
* <p>
- * If the parameter data was sent in the request body, such as occurs with
- * an HTTP POST request, then reading the body directly via
- * {@link #getInputStream} or {@link #getReader} can interfere with the
- * execution of this method.
- *
- * @param name
- * a <code>String</code> specifying the name of the parameter
- * @return a <code>String</code> representing the single value of the
- * parameter
+ * If the parameter data was sent in the request body, such as occurs with an HTTP POST request, then reading the
+ * body directly via {@link #getInputStream} or {@link #getReader} can interfere with the execution of this method.
+ *
+ * @param name a <code>String</code> specifying the name of the parameter
+ *
+ * @return a <code>String</code> representing the single value of the parameter
+ *
* @see #getParameterValues
*/
String getParameter(String name);
/**
- * Returns an <code>Enumeration</code> of <code>String</code> objects
- * containing the names of the parameters contained in this request. If the
- * request has no parameters, the method returns an empty
+ * Returns an <code>Enumeration</code> of <code>String</code> objects containing the names of the parameters
+ * contained in this request. If the request has no parameters, the method returns an empty
* <code>Enumeration</code>.
*
- * @return an <code>Enumeration</code> of <code>String</code> objects, each
- * <code>String</code> containing the name of a request parameter;
- * or an empty <code>Enumeration</code> if the request has no
- * parameters
+ * @return an <code>Enumeration</code> of <code>String</code> objects, each <code>String</code> containing the name
+ * of a request parameter; or an empty <code>Enumeration</code> if the request has no parameters
*/
Enumeration<String> getParameterNames();
/**
- * Returns an array of <code>String</code> objects containing all of the
- * values the given request parameter has, or <code>null</code> if the
- * parameter does not exist.
+ * Returns an array of <code>String</code> objects containing all of the values the given request parameter has, or
+ * <code>null</code> if the parameter does not exist.
* <p>
* If the parameter has a single value, the array has a length of 1.
*
- * @param name
- * a <code>String</code> containing the name of the parameter
- * whose value is requested
- * @return an array of <code>String</code> objects containing the parameter's
- * values
+ * @param name a <code>String</code> containing the name of the parameter whose value is requested
+ *
+ * @return an array of <code>String</code> objects containing the parameter's values
+ *
* @see #getParameter
*/
String[] getParameterValues(String name);
/**
- * Returns a java.util.Map of the parameters of this request. Request
- * parameters are extra information sent with the request. For HTTP
- * servlets, parameters are contained in the query string or posted form
- * data.
+ * Returns a java.util.Map of the parameters of this request. Request parameters are extra information sent with the
+ * request. For HTTP servlets, parameters are contained in the query string or posted form data.
*
- * @return an immutable java.util.Map containing parameter names as keys and
- * parameter values as map values. The keys in the parameter map are
- * of type String. The values in the parameter map are of type
- * String array.
+ * @return an immutable java.util.Map containing parameter names as keys and parameter values as map values. The
+ * keys in the parameter map are of type String. The values in the parameter map are of type String
+ * array.
*/
- Map<String, String[]> getParameterMap();
+ Map<String,String[]> getParameterMap();
/**
* Returns the name and version of the protocol the request uses in the form
- * <i>protocol/majorVersion.minorVersion</i>, for example, HTTP/1.1. For
- * HTTP servlets, the value returned is the same as the value of the CGI
- * variable <code>SERVER_PROTOCOL</code>.
+ * <i>protocol/majorVersion.minorVersion</i>, for example, HTTP/1.1. For HTTP servlets, the value returned is the
+ * same as the value of the CGI variable <code>SERVER_PROTOCOL</code>.
*
- * @return a <code>String</code> containing the protocol name and version
- * number
+ * @return a <code>String</code> containing the protocol name and version number
*/
String getProtocol();
/**
- * Returns the name of the scheme used to make this request, for example,
- * <code>http</code>, <code>https</code>, or <code>ftp</code>. Different
- * schemes have different rules for constructing URLs, as noted in RFC 1738.
+ * Returns the name of the scheme used to make this request, for example, <code>http</code>, <code>https</code>, or
+ * <code>ftp</code>. Different schemes have different rules for constructing URLs, as noted in RFC 1738.
*
- * @return a <code>String</code> containing the name of the scheme used to
- * make this request
+ * @return a <code>String</code> containing the name of the scheme used to make this request
*/
String getScheme();
/**
- * Returns the host name of the server to which the request was sent. It is
- * the value of the part before ":" in the <code>Host</code> header value,
- * if any, or the resolved server name, or the server IP address.
+ * Returns the host name of the server to which the request was sent. It is the value of the part before ":" in the
+ * <code>Host</code> header value, if any, or the resolved server name, or the server IP address.
*
* @return a <code>String</code> containing the name of the server
*/
String getServerName();
/**
- * Returns the port number to which the request was sent. It is the value of
- * the part after ":" in the <code>Host</code> header value, if any, or the
- * server port where the client connection was accepted on.
+ * Returns the port number to which the request was sent. It is the value of the part after ":" in the
+ * <code>Host</code> header value, if any, or the server port where the client connection was accepted on.
*
* @return an integer specifying the port number
*/
int getServerPort();
/**
- * Retrieves the body of the request as character data using a
- * <code>BufferedReader</code>. The reader translates the character data
- * according to the character encoding used on the body. Either this method
- * or {@link #getInputStream} may be called to read the body, not both.
+ * Retrieves the body of the request as character data using a <code>BufferedReader</code>. The reader translates
+ * the character data according to the character encoding used on the body. Either this method or
+ * {@link #getInputStream} may be called to read the body, not both.
*
* @return a <code>BufferedReader</code> containing the body of the request
- * @exception java.io.UnsupportedEncodingException
- * if the character set encoding used is not supported and
- * the text cannot be decoded
- * @exception IllegalStateException
- * if {@link #getInputStream} method has been called on this
- * request
- * @exception IOException
- * if an input or output exception occurred
+ *
+ * @exception java.io.UnsupportedEncodingException if the character set encoding used is not supported and the text
+ * cannot be decoded
+ * @exception IllegalStateException if {@link #getInputStream} method has been called on this request
+ * @exception IOException if an input or output exception occurred
+ *
* @see #getInputStream
*/
BufferedReader getReader() throws IOException;
/**
- * Returns the Internet Protocol (IP) address of the client or last proxy
- * that sent the request. For HTTP servlets, same as the value of the CGI
- * variable <code>REMOTE_ADDR</code>.
+ * Returns the Internet Protocol (IP) address of the client or last proxy that sent the request. For HTTP servlets,
+ * same as the value of the CGI variable <code>REMOTE_ADDR</code>.
*
- * @return a <code>String</code> containing the IP address of the client
- * that sent the request
+ * @return a <code>String</code> containing the IP address of the client that sent the request
*/
String getRemoteAddr();
/**
- * Returns the fully qualified name of the client or the last proxy that
- * sent the request. If the engine cannot or chooses not to resolve the
- * hostname (to improve performance), this method returns the dotted-string
- * form of the IP address. For HTTP servlets, same as the value of the CGI
- * variable <code>REMOTE_HOST</code>.
+ * Returns the fully qualified name of the client or the last proxy that sent the request. If the engine cannot or
+ * chooses not to resolve the hostname (to improve performance), this method returns the dotted-string form of the
+ * IP address. For HTTP servlets, same as the value of the CGI variable <code>REMOTE_HOST</code>.
*
- * @return a <code>String</code> containing the fully qualified name of the
- * client
+ * @return a <code>String</code> containing the fully qualified name of the client
*/
String getRemoteHost();
/**
- * Stores an attribute in this request. Attributes are reset between
- * requests. This method is most often used in conjunction with
- * {@link RequestDispatcher}.
+ * Stores an attribute in this request. Attributes are reset between requests. This method is most often used in
+ * conjunction with {@link RequestDispatcher}.
* <p>
- * Attribute names should follow the same conventions as package names.
- * Names beginning with <code>java.*</code> and <code>javax.*</code> are
- * reserved for use by the Servlet specification. Names beginning with
- * <code>sun.*</code>, <code>com.sun.*</code>, <code>oracle.*</code> and
- * <code>com.oracle.*</code>) are reserved for use by Oracle Corporation.
- * <br>
- * If the object passed in is null, the effect is the same as calling
- * {@link #removeAttribute}. <br>
- * It is warned that when the request is dispatched from the servlet resides
- * in a different web application by <code>RequestDispatcher</code>, the
- * object set by this method may not be correctly retrieved in the caller
+ * Attribute names should follow the same conventions as package names. Names beginning with <code>java.*</code> and
+ * <code>javax.*</code> are reserved for use by the Servlet specification. Names beginning with <code>sun.*</code>,
+ * <code>com.sun.*</code>, <code>oracle.*</code> and <code>com.oracle.*</code>) are reserved for use by Oracle
+ * Corporation. <br>
+ * If the object passed in is null, the effect is the same as calling {@link #removeAttribute}. <br>
+ * It is warned that when the request is dispatched from the servlet resides in a different web application by
+ * <code>RequestDispatcher</code>, the object set by this method may not be correctly retrieved in the caller
* servlet.
*
- * @param name
- * a <code>String</code> specifying the name of the attribute
- * @param o
- * the <code>Object</code> to be stored
+ * @param name a <code>String</code> specifying the name of the attribute
+ * @param o the <code>Object</code> to be stored
*/
void setAttribute(String name, Object o);
/**
- * Removes an attribute from this request. This method is not generally
- * needed as attributes only persist as long as the request is being
- * handled.
+ * Removes an attribute from this request. This method is not generally needed as attributes only persist as long as
+ * the request is being handled.
* <p>
- * Attribute names should follow the same conventions as package names.
- * Names beginning with <code>java.*</code> and <code>javax.*</code> are
- * reserved for use by the Servlet specification. Names beginning with
- * <code>sun.*</code>, <code>com.sun.*</code>, <code>oracle.*</code> and
- * <code>com.oracle.*</code>) are reserved for use by Oracle Corporation.
+ * Attribute names should follow the same conventions as package names. Names beginning with <code>java.*</code> and
+ * <code>javax.*</code> are reserved for use by the Servlet specification. Names beginning with <code>sun.*</code>,
+ * <code>com.sun.*</code>, <code>oracle.*</code> and <code>com.oracle.*</code>) are reserved for use by Oracle
+ * Corporation.
*
- * @param name
- * a <code>String</code> specifying the name of the attribute to
- * remove
+ * @param name a <code>String</code> specifying the name of the attribute to remove
*/
void removeAttribute(String name);
/**
- * Returns the preferred <code>Locale</code> that the client will accept
- * content in, based on the Accept-Language header. If the client request
- * doesn't provide an Accept-Language header, this method returns the
- * default locale for the server.
+ * Returns the preferred <code>Locale</code> that the client will accept content in, based on the Accept-Language
+ * header. If the client request doesn't provide an Accept-Language header, this method returns the default locale
+ * for the server.
*
* @return the preferred <code>Locale</code> for the client
*/
Locale getLocale();
/**
- * Returns an <code>Enumeration</code> of <code>Locale</code> objects
- * indicating, in decreasing order starting with the preferred locale, the
- * locales that are acceptable to the client based on the Accept-Language
- * header. If the client request doesn't provide an Accept-Language header,
- * this method returns an <code>Enumeration</code> containing one
- * <code>Locale</code>, the default locale for the server.
+ * Returns an <code>Enumeration</code> of <code>Locale</code> objects indicating, in decreasing order starting with
+ * the preferred locale, the locales that are acceptable to the client based on the Accept-Language header. If the
+ * client request doesn't provide an Accept-Language header, this method returns an <code>Enumeration</code>
+ * containing one <code>Locale</code>, the default locale for the server.
*
- * @return an <code>Enumeration</code> of preferred <code>Locale</code>
- * objects for the client
+ * @return an <code>Enumeration</code> of preferred <code>Locale</code> objects for the client
*/
Enumeration<Locale> getLocales();
/**
- * Returns a boolean indicating whether this request was made using a secure
- * channel, such as HTTPS.
+ * Returns a boolean indicating whether this request was made using a secure channel, such as HTTPS.
*
- * @return a boolean indicating if the request was made using a secure
- * channel
+ * @return a boolean indicating if the request was made using a secure channel
*/
boolean isSecure();
/**
- * Returns a {@link RequestDispatcher} object that acts as a wrapper for the
- * resource located at the given path. A <code>RequestDispatcher</code>
- * object can be used to forward a request to the resource or to include the
- * resource in a response. The resource can be dynamic or static.
+ * Returns a {@link RequestDispatcher} object that acts as a wrapper for the resource located at the given path. A
+ * <code>RequestDispatcher</code> object can be used to forward a request to the resource or to include the resource
+ * in a response. The resource can be dynamic or static.
* <p>
- * The pathname specified may be relative, although it cannot extend outside
- * the current servlet context. If the path begins with a "/" it is
- * interpreted as relative to the current context root. This method returns
- * <code>null</code> if the servlet container cannot return a
- * <code>RequestDispatcher</code>.
+ * The pathname specified may be relative, although it cannot extend outside the current servlet context. If the
+ * path begins with a "/" it is interpreted as relative to the current context root. This method returns
+ * <code>null</code> if the servlet container cannot return a <code>RequestDispatcher</code>.
* <p>
- * The difference between this method and
- * {@link ServletContext#getRequestDispatcher} is that this method can take
- * a relative path.
- *
- * @param path
- * a <code>String</code> specifying the pathname to the resource.
- * If it is relative, it must be relative against the current
- * servlet.
- * @return a <code>RequestDispatcher</code> object that acts as a wrapper for
- * the resource at the specified path, or <code>null</code> if the
- * servlet container cannot return a <code>RequestDispatcher</code>
+ * The difference between this method and {@link ServletContext#getRequestDispatcher} is that this method can take a
+ * relative path.
+ *
+ * @param path a <code>String</code> specifying the pathname to the resource. If it is relative, it must be relative
+ * against the current servlet.
+ *
+ * @return a <code>RequestDispatcher</code> object that acts as a wrapper for the resource at the specified path, or
+ * <code>null</code> if the servlet container cannot return a <code>RequestDispatcher</code>
+ *
* @see RequestDispatcher
* @see ServletContext#getRequestDispatcher
*/
@@ -405,15 +333,16 @@ public interface ServletRequest {
/**
* @param path The virtual path to be converted to a real path
+ *
* @return {@link ServletContext#getRealPath(String)}
- * @deprecated As of Version 2.1 of the Java Servlet API, use
- * {@link ServletContext#getRealPath} instead.
+ *
+ * @deprecated As of Version 2.1 of the Java Servlet API, use {@link ServletContext#getRealPath} instead.
*/
- @Deprecated String getRealPath(String path);
+ @Deprecated
+ String getRealPath(String path);
/**
- * Returns the Internet Protocol (IP) source port of the client or last
- * proxy that sent the request.
+ * Returns the Internet Protocol (IP) source port of the client or last proxy that sent the request.
*
* @return an integer specifying the port number
*
@@ -422,28 +351,25 @@ public interface ServletRequest {
int getRemotePort();
/**
- * Returns the host name of the Internet Protocol (IP) interface on which
- * the request was received.
+ * Returns the host name of the Internet Protocol (IP) interface on which the request was received.
+ *
+ * @return a <code>String</code> containing the host name of the IP on which the request was received.
*
- * @return a <code>String</code> containing the host name of the IP on which
- * the request was received.
* @since Servlet 2.4
*/
String getLocalName();
/**
- * Returns the Internet Protocol (IP) address of the interface on which the
- * request was received.
+ * Returns the Internet Protocol (IP) address of the interface on which the request was received.
+ *
+ * @return a <code>String</code> containing the IP address on which the request was received.
*
- * @return a <code>String</code> containing the IP address on which the
- * request was received.
* @since Servlet 2.4
*/
String getLocalAddr();
/**
- * Returns the Internet Protocol (IP) port number of the interface on which
- * the request was received.
+ * Returns the Internet Protocol (IP) port number of the interface on which the request was received.
*
* @return an integer specifying the port number
*
@@ -453,37 +379,43 @@ public interface ServletRequest {
/**
* @return TODO
+ *
* @since Servlet 3.0 TODO SERVLET3 - Add comments
*/
ServletContext getServletContext();
/**
* @return TODO
+ *
* @throws IllegalStateException If async is not supported for this request
+ *
* @since Servlet 3.0 TODO SERVLET3 - Add comments
*/
AsyncContext startAsync() throws IllegalStateException;
/**
- * @param servletRequest The ServletRequest with which to initialise the
- * asynchronous context
- * @param servletResponse The ServletResponse with which to initialise the
- * asynchronous context
+ * @param servletRequest The ServletRequest with which to initialise the asynchronous context
+ * @param servletResponse The ServletResponse with which to initialise the asynchronous context
+ *
* @return TODO
+ *
* @throws IllegalStateException If async is not supported for this request
+ *
* @since Servlet 3.0 TODO SERVLET3 - Add comments
*/
- AsyncContext startAsync(ServletRequest servletRequest,
- ServletResponse servletResponse) throws IllegalStateException;
+ AsyncContext startAsync(ServletRequest servletRequest, ServletResponse servletResponse)
+ throws IllegalStateException;
/**
* @return TODO
+ *
* @since Servlet 3.0 TODO SERVLET3 - Add comments
*/
boolean isAsyncStarted();
/**
* @return TODO
+ *
* @since Servlet 3.0 TODO SERVLET3 - Add comments
*/
boolean isAsyncSupported();
@@ -493,8 +425,8 @@ public interface ServletRequest {
*
* @return The current AsyncContext
*
- * @throws IllegalStateException if the request is not in asynchronous mode
- * (i.e. @link #isAsyncStarted() is {@code false})
+ * @throws IllegalStateException if the request is not in asynchronous mode (i.e. @link #isAsyncStarted() is
+ * {@code false})
*
* @since Servlet 3.0
*/
@@ -502,6 +434,7 @@ public interface ServletRequest {
/**
* @return TODO
+ *
* @since Servlet 3.0 TODO SERVLET3 - Add comments
*/
DispatcherType getDispatcherType();
diff --git a/java/javax/servlet/ServletRequestAttributeEvent.java b/java/javax/servlet/ServletRequestAttributeEvent.java
index 30dfb93bee..cd9d68b80f 100644
--- a/java/javax/servlet/ServletRequestAttributeEvent.java
+++ b/java/javax/servlet/ServletRequestAttributeEvent.java
@@ -17,10 +17,10 @@
package javax.servlet;
/**
- * This is the event class for notifications of changes to the attributes of the
- * servlet request in an application.
+ * This is the event class for notifications of changes to the attributes of the servlet request in an application.
*
* @see ServletRequestAttributeListener
+ *
* @since Servlet 2.4
*/
public class ServletRequestAttributeEvent extends ServletRequestEvent {
@@ -37,21 +37,15 @@ public class ServletRequestAttributeEvent extends ServletRequestEvent {
private final Object value;
/**
- * Construct a ServletRequestAttributeEvent giving the servlet context of
- * this web application, the ServletRequest whose attributes are changing
- * and the name and value of the attribute.
+ * Construct a ServletRequestAttributeEvent giving the servlet context of this web application, the ServletRequest
+ * whose attributes are changing and the name and value of the attribute.
*
- * @param sc
- * the ServletContext that is sending the event.
- * @param request
- * the ServletRequest that is sending the event.
- * @param name
- * the name of the request attribute.
- * @param value
- * the value of the request attribute.
+ * @param sc the ServletContext that is sending the event.
+ * @param request the ServletRequest that is sending the event.
+ * @param name the name of the request attribute.
+ * @param value the value of the request attribute.
*/
- public ServletRequestAttributeEvent(ServletContext sc,
- ServletRequest request, String name, Object value) {
+ public ServletRequestAttributeEvent(ServletContext sc, ServletRequest request, String name, Object value) {
super(sc, request);
this.name = name;
this.value = value;
@@ -67,10 +61,9 @@ public class ServletRequestAttributeEvent extends ServletRequestEvent {
}
/**
- * Returns the value of the attribute that has been added, removed or
- * replaced. If the attribute was added, this is the value of the attribute.
- * If the attribute was removed, this is the value of the removed attribute.
- * If the attribute was replaced, this is the old value of the attribute.
+ * Returns the value of the attribute that has been added, removed or replaced. If the attribute was added, this is
+ * the value of the attribute. If the attribute was removed, this is the value of the removed attribute. If the
+ * attribute was replaced, this is the old value of the attribute.
*
* @return the value of the changed request attribute
*/
diff --git a/java/javax/servlet/ServletRequestAttributeListener.java b/java/javax/servlet/ServletRequestAttributeListener.java
index e406c32dff..043008b93b 100644
--- a/java/javax/servlet/ServletRequestAttributeListener.java
+++ b/java/javax/servlet/ServletRequestAttributeListener.java
@@ -19,40 +19,37 @@ package javax.servlet;
import java.util.EventListener;
/**
- * A ServletRequestAttributeListener can be implemented by the
- * developer interested in being notified of request attribute
- * changes. Notifications will be generated while the request
- * is within the scope of the web application in which the listener
- * is registered. A request is defined as coming into scope when
- * it is about to enter the first servlet or filter in each web
- * application, as going out of scope when it exits the last servlet
- * or the first filter in the chain.
+ * A ServletRequestAttributeListener can be implemented by the developer interested in being notified of request
+ * attribute changes. Notifications will be generated while the request is within the scope of the web application in
+ * which the listener is registered. A request is defined as coming into scope when it is about to enter the first
+ * servlet or filter in each web application, as going out of scope when it exits the last servlet or the first filter
+ * in the chain.
*
* @since Servlet 2.4
*/
public interface ServletRequestAttributeListener extends EventListener {
/**
- * Notification that a new attribute was added to the
- * servlet request. Called after the attribute is added.
- * The default implementation is a NO-OP.
+ * Notification that a new attribute was added to the servlet request. Called after the attribute is added. The
+ * default implementation is a NO-OP.
+ *
* @param srae Information about the new request attribute
*/
default void attributeAdded(ServletRequestAttributeEvent srae) {
}
/**
- * Notification that an existing attribute has been removed from the
- * servlet request. Called after the attribute is removed.
- * The default implementation is a NO-OP.
+ * Notification that an existing attribute has been removed from the servlet request. Called after the attribute is
+ * removed. The default implementation is a NO-OP.
+ *
* @param srae Information about the removed request attribute
*/
default void attributeRemoved(ServletRequestAttributeEvent srae) {
}
/**
- * Notification that an attribute was replaced on the
- * servlet request. Called after the attribute is replaced.
- * The default implementation is a NO-OP.
+ * Notification that an attribute was replaced on the servlet request. Called after the attribute is replaced. The
+ * default implementation is a NO-OP.
+ *
* @param srae Information about the replaced request attribute
*/
default void attributeReplaced(ServletRequestAttributeEvent srae) {
diff --git a/java/javax/servlet/ServletRequestEvent.java b/java/javax/servlet/ServletRequestEvent.java
index 6d95e921a2..7aafc69c30 100644
--- a/java/javax/servlet/ServletRequestEvent.java
+++ b/java/javax/servlet/ServletRequestEvent.java
@@ -17,10 +17,11 @@
package javax.servlet;
/**
- * Events of this kind indicate lifecycle events for a ServletRequest. The
- * source of the event is the ServletContext of this web application.
+ * Events of this kind indicate lifecycle events for a ServletRequest. The source of the event is the ServletContext of
+ * this web application.
*
* @see ServletRequestListener
+ *
* @since Servlet 2.4
*/
public class ServletRequestEvent extends java.util.EventObject {
@@ -29,13 +30,10 @@ public class ServletRequestEvent extends java.util.EventObject {
private final transient ServletRequest request;
/**
- * Construct a ServletRequestEvent for the given ServletContext and
- * ServletRequest.
+ * Construct a ServletRequestEvent for the given ServletContext and ServletRequest.
*
- * @param sc
- * the ServletContext of the web application.
- * @param request
- * the ServletRequest that is sending the event.
+ * @param sc the ServletContext of the web application.
+ * @param request the ServletRequest that is sending the event.
*/
public ServletRequestEvent(ServletContext sc, ServletRequest request) {
super(sc);
@@ -44,6 +42,7 @@ public class ServletRequestEvent extends java.util.EventObject {
/**
* Get the associated ServletRequest.
+ *
* @return the ServletRequest that is changing.
*/
public ServletRequest getServletRequest() {
@@ -52,6 +51,7 @@ public class ServletRequestEvent extends java.util.EventObject {
/**
* Get the associated ServletContext.
+ *
* @return the ServletContext that is changing.
*/
public ServletContext getServletContext() {
diff --git a/java/javax/servlet/ServletRequestListener.java b/java/javax/servlet/ServletRequestListener.java
index d7bca4386e..43c0999743 100644
--- a/java/javax/servlet/ServletRequestListener.java
+++ b/java/javax/servlet/ServletRequestListener.java
@@ -19,30 +19,28 @@ package javax.servlet;
import java.util.EventListener;
/**
- * A ServletRequestListener can be implemented by the developer
- * interested in being notified of requests coming in and out of
- * scope in a web component. A request is defined as coming into
- * scope when it is about to enter the first servlet or filter
- * in each web application, as going out of scope when it exits
- * the last servlet or the first filter in the chain.
+ * A ServletRequestListener can be implemented by the developer interested in being notified of requests coming in and
+ * out of scope in a web component. A request is defined as coming into scope when it is about to enter the first
+ * servlet or filter in each web application, as going out of scope when it exits the last servlet or the first filter
+ * in the chain.
*
* @since Servlet 2.4
*/
public interface ServletRequestListener extends EventListener {
/**
- * The request is about to go out of scope of the web application.
- * The default implementation is a NO-OP.
+ * The request is about to go out of scope of the web application. The default implementation is a NO-OP.
+ *
* @param sre Information about the request
*/
- default void requestDestroyed (ServletRequestEvent sre) {
+ default void requestDestroyed(ServletRequestEvent sre) {
}
/**
- * The request is about to come into scope of the web application.
- * The default implementation is a NO-OP.
+ * The request is about to come into scope of the web application. The default implementation is a NO-OP.
+ *
* @param sre Information about the request
*/
- default void requestInitialized (ServletRequestEvent sre) {
+ default void requestInitialized(ServletRequestEvent sre) {
}
}
diff --git a/java/javax/servlet/ServletRequestWrapper.java b/java/javax/servlet/ServletRequestWrapper.java
index c0a0351646..cbb60a4062 100644
--- a/java/javax/servlet/ServletRequestWrapper.java
+++ b/java/javax/servlet/ServletRequestWrapper.java
@@ -24,9 +24,8 @@ import java.util.Map;
import java.util.ResourceBundle;
/**
- * Provides a convenient implementation of the ServletRequest interface that can
- * be subclassed by developers wishing to adapt the request to a Servlet. This
- * class implements the Wrapper or Decorator pattern. Methods default to calling
+ * Provides a convenient implementation of the ServletRequest interface that can be subclassed by developers wishing to
+ * adapt the request to a Servlet. This class implements the Wrapper or Decorator pattern. Methods default to calling
* through to the wrapped request object.
*
* @see javax.servlet.ServletRequest
@@ -55,6 +54,7 @@ public class ServletRequestWrapper implements ServletRequest {
/**
* Get the wrapped request.
+ *
* @return the wrapped request object
*/
public ServletRequest getRequest() {
@@ -76,8 +76,7 @@ public class ServletRequestWrapper implements ServletRequest {
}
/**
- * The default behavior of this method is to call getAttribute(String name)
- * on the wrapped request object.
+ * The default behavior of this method is to call getAttribute(String name) on the wrapped request object.
*/
@Override
public Object getAttribute(String name) {
@@ -85,8 +84,7 @@ public class ServletRequestWrapper implements ServletRequest {
}
/**
- * The default behavior of this method is to return getAttributeNames() on
- * the wrapped request object.
+ * The default behavior of this method is to return getAttributeNames() on the wrapped request object.
*/
@Override
public Enumeration<String> getAttributeNames() {
@@ -94,8 +92,7 @@ public class ServletRequestWrapper implements ServletRequest {
}
/**
- * The default behavior of this method is to return getCharacterEncoding()
- * on the wrapped request object.
+ * The default behavior of this method is to return getCharacterEncoding() on the wrapped request object.
*/
@Override
public String getCharacterEncoding() {
@@ -103,18 +100,15 @@ public class ServletRequestWrapper implements ServletRequest {
}
/**
- * The default behavior of this method is to set the character encoding on
- * the wrapped request object.
+ * The default behavior of this method is to set the character encoding on the wrapped request object.
*/
@Override
- public void setCharacterEncoding(String enc)
- throws java.io.UnsupportedEncodingException {
+ public void setCharacterEncoding(String enc) throws java.io.UnsupportedEncodingException {
this.request.setCharacterEncoding(enc);
}
/**
- * The default behavior of this method is to return getContentLength() on
- * the wrapped request object.
+ * The default behavior of this method is to return getContentLength() on the wrapped request object.
*/
@Override
public int getContentLength() {
@@ -122,8 +116,7 @@ public class ServletRequestWrapper implements ServletRequest {
}
/**
- * The default behavior of this method is to return getContentLengthLong()
- * on the wrapped request object.
+ * The default behavior of this method is to return getContentLengthLong() on the wrapped request object.
*
* @since Servlet 3.1
*/
@@ -133,8 +126,7 @@ public class ServletRequestWrapper implements ServletRequest {
}
/**
- * The default behavior of this method is to return getContentType() on the
- * wrapped request object.
+ * The default behavior of this method is to return getContentType() on the wrapped request object.
*/
@Override
public String getContentType() {
@@ -142,8 +134,7 @@ public class ServletRequestWrapper implements ServletRequest {
}
/**
- * The default behavior of this method is to return getInputStream() on the
- * wrapped request object.
+ * The default behavior of this method is to return getInputStream() on the wrapped request object.
*/
@Override
public ServletInputStream getInputStream() throws IOException {
@@ -151,8 +142,7 @@ public class ServletRequestWrapper implements ServletRequest {
}
/**
- * The default behavior of this method is to return getParameter(String
- * name) on the wrapped request object.
+ * The default behavior of this method is to return getParameter(String name) on the wrapped request object.
*/
@Override
public String getParameter(String name) {
@@ -160,17 +150,15 @@ public class ServletRequestWrapper implements ServletRequest {
}
/**
- * The default behavior of this method is to return getParameterMap() on the
- * wrapped request object.
+ * The default behavior of this method is to return getParameterMap() on the wrapped request object.
*/
@Override
- public Map<String, String[]> getParameterMap() {
+ public Map<String,String[]> getParameterMap() {
return this.request.getParameterMap();
}
/**
- * The default behavior of this method is to return getParameterNames() on
- * the wrapped request object.
+ * The default behavior of this method is to return getParameterNames() on the wrapped request object.
*/
@Override
public Enumeration<String> getParameterNames() {
@@ -178,8 +166,7 @@ public class ServletRequestWrapper implements ServletRequest {
}
/**
- * The default behavior of this method is to return
- * getParameterValues(String name) on the wrapped request object.
+ * The default behavior of this method is to return getParameterValues(String name) on the wrapped request object.
*/
@Override
public String[] getParameterValues(String name) {
@@ -187,8 +174,7 @@ public class ServletRequestWrapper implements ServletRequest {
}
/**
- * The default behavior of this method is to return getProtocol() on the
- * wrapped request object.
+ * The default behavior of this method is to return getProtocol() on the wrapped request object.
*/
@Override
public String getProtocol() {
@@ -196,8 +182,7 @@ public class ServletRequestWrapper implements ServletRequest {
}
/**
- * The default behavior of this method is to return getScheme() on the
- * wrapped request object.
+ * The default behavior of this method is to return getScheme() on the wrapped request object.
*/
@Override
public String getScheme() {
@@ -205,8 +190,7 @@ public class ServletRequestWrapper implements ServletRequest {
}
/**
- * The default behavior of this method is to return getServerName() on the
- * wrapped request object.
+ * The default behavior of this method is to return getServerName() on the wrapped request object.
*/
@Override
public String getServerName() {
@@ -214,8 +198,7 @@ public class ServletRequestWrapper implements ServletRequest {
}
/**
- * The default behavior of this method is to return getServerPort() on the
- * wrapped request object.
+ * The default behavior of this method is to return getServerPort() on the wrapped request object.
*/
@Override
public int getServerPort() {
@@ -223,8 +206,7 @@ public class ServletRequestWrapper implements ServletRequest {
}
/**
- * The default behavior of this method is to return getReader() on the
- * wrapped request object.
+ * The default behavior of this method is to return getReader() on the wrapped request object.
*/
@Override
public BufferedReader getReader() throws IOException {
@@ -232,8 +214,7 @@ public class ServletRequestWrapper implements ServletRequest {
}
/**
- * The default behavior of this method is to return getRemoteAddr() on the
- * wrapped request object.
+ * The default behavior of this method is to return getRemoteAddr() on the wrapped request object.
*/
@Override
public String getRemoteAddr() {
@@ -241,8 +222,7 @@ public class ServletRequestWrapper implements ServletRequest {
}
/**
- * The default behavior of this method is to return getRemoteHost() on the
- * wrapped request object.
+ * The default behavior of this method is to return getRemoteHost() on the wrapped request object.
*/
@Override
public String getRemoteHost() {
@@ -250,8 +230,8 @@ public class ServletRequestWrapper implements ServletRequest {
}
/**
- * The default behavior of this method is to return setAttribute(String
- * name, Object o) on the wrapped request object.
+ * The default behavior of this method is to return setAttribute(String name, Object o) on the wrapped request
+ * object.
*/
@Override
public void setAttribute(String name, Object o) {
@@ -259,8 +239,7 @@ public class ServletRequestWrapper implements ServletRequest {
}
/**
- * The default behavior of this method is to call removeAttribute(String
- * name) on the wrapped request object.
+ * The default behavior of this method is to call removeAttribute(String name) on the wrapped request object.
*/
@Override
public void removeAttribute(String name) {
@@ -268,8 +247,7 @@ public class ServletRequestWrapper implements ServletRequest {
}
/**
- * The default behavior of this method is to return getLocale() on the
- * wrapped request object.
+ * The default behavior of this method is to return getLocale() on the wrapped request object.
*/
@Override
public Locale getLocale() {
@@ -277,8 +255,7 @@ public class ServletRequestWrapper implements ServletRequest {
}
/**
- * The default behavior of this method is to return getLocales() on the
- * wrapped request object.
+ * The default behavior of this method is to return getLocales() on the wrapped request object.
*/
@Override
public Enumeration<Locale> getLocales() {
@@ -286,8 +263,7 @@ public class ServletRequestWrapper implements ServletRequest {
}
/**
- * The default behavior of this method is to return isSecure() on the
- * wrapped request object.
+ * The default behavior of this method is to return isSecure() on the wrapped request object.
*/
@Override
public boolean isSecure() {
@@ -295,8 +271,7 @@ public class ServletRequestWrapper implements ServletRequest {
}
/**
- * The default behavior of this method is to return
- * getRequestDispatcher(String path) on the wrapped request object.
+ * The default behavior of this method is to return getRequestDispatcher(String path) on the wrapped request object.
*/
@Override
public RequestDispatcher getRequestDispatcher(String path) {
@@ -304,8 +279,7 @@ public class ServletRequestWrapper implements ServletRequest {
}
/**
- * The default behavior of this method is to return getRealPath(String path)
- * on the wrapped request object.
+ * The default behavior of this method is to return getRealPath(String path) on the wrapped request object.
*
* @deprecated As of Version 3.0 of the Java Servlet API
*/
@@ -316,8 +290,7 @@ public class ServletRequestWrapper implements ServletRequest {
}
/**
- * The default behavior of this method is to return getRemotePort() on the
- * wrapped request object.
+ * The default behavior of this method is to return getRemotePort() on the wrapped request object.
*
* @since Servlet 2.4
*/
@@ -327,8 +300,7 @@ public class ServletRequestWrapper implements ServletRequest {
}
/**
- * The default behavior of this method is to return getLocalName() on the
- * wrapped request object.
+ * The default behavior of this method is to return getLocalName() on the wrapped request object.
*
* @since Servlet 2.4
*/
@@ -338,8 +310,7 @@ public class ServletRequestWrapper implements ServletRequest {
}
/**
- * The default behavior of this method is to return getLocalAddr() on the
- * wrapped request object.
+ * The default behavior of this method is to return getLocalAddr() on the wrapped request object.
*
* @since Servlet 2.4
*/
@@ -349,8 +320,7 @@ public class ServletRequestWrapper implements ServletRequest {
}
/**
- * The default behavior of this method is to return getLocalPort() on the
- * wrapped request object.
+ * The default behavior of this method is to return getLocalPort() on the wrapped request object.
*
* @since Servlet 2.4
*/
@@ -360,8 +330,7 @@ public class ServletRequestWrapper implements ServletRequest {
}
/**
- * The default behavior of this method is to return getServletContext() on
- * the wrapped request object.
+ * The default behavior of this method is to return getServletContext() on the wrapped request object.
*
* @since Servlet 3.0
*/
@@ -371,12 +340,11 @@ public class ServletRequestWrapper implements ServletRequest {
}
/**
- * The default behavior of this method is to return startAsync() on the
- * wrapped request object.
+ * The default behavior of this method is to return startAsync() on the wrapped request object.
+ *
+ * @throws IllegalStateException If asynchronous processing is not supported for this request or if the request is
+ * already in asynchronous mode
*
- * @throws IllegalStateException If asynchronous processing is not supported
- * for this request or if the request is already in asynchronous
- * mode
* @since Servlet 3.0
*/
@Override
@@ -385,27 +353,24 @@ public class ServletRequestWrapper implements ServletRequest {
}
/**
- * The default behavior of this method is to return startAsync(Runnable) on
- * the wrapped request object.
+ * The default behavior of this method is to return startAsync(Runnable) on the wrapped request object.
+ *
+ * @param servletRequest The ServletRequest with which to initialise the asynchronous context
+ * @param servletResponse The ServletResponse with which to initialise the asynchronous context
+ *
+ * @throws IllegalStateException If asynchronous processing is not supported for this request or if the request is
+ * already in asynchronous mode
*
- * @param servletRequest The ServletRequest with which to initialise the
- * asynchronous context
- * @param servletResponse The ServletResponse with which to initialise the
- * asynchronous context
- * @throws IllegalStateException If asynchronous processing is not supported
- * for this request or if the request is already in asynchronous
- * mode
* @since Servlet 3.0
*/
@Override
- public AsyncContext startAsync(ServletRequest servletRequest,
- ServletResponse servletResponse) throws IllegalStateException {
+ public AsyncContext startAsync(ServletRequest servletRequest, ServletResponse servletResponse)
+ throws IllegalStateException {
return request.startAsync(servletRequest, servletResponse);
}
/**
- * The default behavior of this method is to return isAsyncStarted() on the
- * wrapped request object.
+ * The default behavior of this method is to return isAsyncStarted() on the wrapped request object.
*
* @since Servlet 3.0
*/
@@ -415,8 +380,7 @@ public class ServletRequestWrapper implements ServletRequest {
}
/**
- * The default behavior of this method is to return isAsyncSupported() on
- * the wrapped request object.
+ * The default behavior of this method is to return isAsyncSupported() on the wrapped request object.
*
* @since Servlet 3.0
*/
@@ -426,8 +390,7 @@ public class ServletRequestWrapper implements ServletRequest {
}
/**
- * The default behavior of this method is to return getAsyncContext() on the
- * wrapped request object.
+ * The default behavior of this method is to return getAsyncContext() on the wrapped request object.
*
* @since Servlet 3.0
*/
@@ -438,10 +401,12 @@ public class ServletRequestWrapper implements ServletRequest {
/**
* TODO SERVLET3 - Add comments
+ *
* @param wrapped The request to compare to the wrapped request
- * @return <code>true</code> if the request wrapped by this wrapper (or
- * series of wrappers) is the same as the supplied request,
- * otherwise <code>false</code>
+ *
+ * @return <code>true</code> if the request wrapped by this wrapper (or series of wrappers) is the same as the
+ * supplied request, otherwise <code>false</code>
+ *
* @since Servlet 3.0
*/
public boolean isWrapperFor(ServletRequest wrapped) {
@@ -456,11 +421,12 @@ public class ServletRequestWrapper implements ServletRequest {
/**
* TODO SERVLET3 - Add comments
- * @param wrappedType The class to compare to the class of the wrapped
- * request
- * @return <code>true</code> if the request wrapped by this wrapper (or
- * series of wrappers) is the same type as the supplied type,
- * otherwise <code>false</code>
+ *
+ * @param wrappedType The class to compare to the class of the wrapped request
+ *
+ * @return <code>true</code> if the request wrapped by this wrapper (or series of wrappers) is the same type as the
+ * supplied type, otherwise <code>false</code>
+ *
* @since Servlet 3.0
*/
public boolean isWrapperFor(Class<?> wrappedType) {
@@ -474,8 +440,7 @@ public class ServletRequestWrapper implements ServletRequest {
}
/**
- * The default behavior of this method is to call getDispatcherType() on the
- * wrapped request object.
+ * The default behavior of this method is to call getDispatcherType() on the wrapped request object.
*
* @since Servlet 3.0
*/
diff --git a/java/javax/servlet/ServletResponse.java b/java/javax/servlet/ServletResponse.java
index 972bf33e4b..58c60a802c 100644
--- a/java/javax/servlet/ServletResponse.java
+++ b/java/javax/servlet/ServletResponse.java
@@ -21,206 +21,171 @@ import java.io.PrintWriter;
import java.util.Locale;
/**
- * Defines an object to assist a servlet in sending a response to the client.
- * The servlet container creates a <code>ServletResponse</code> object and
- * passes it as an argument to the servlet's <code>service</code> method.
+ * Defines an object to assist a servlet in sending a response to the client. The servlet container creates a
+ * <code>ServletResponse</code> object and passes it as an argument to the servlet's <code>service</code> method.
* <p>
- * To send binary data in a MIME body response, use the
- * {@link ServletOutputStream} returned by {@link #getOutputStream}. To send
- * character data, use the <code>PrintWriter</code> object returned by
- * {@link #getWriter}. To mix binary and text data, for example, to create a
- * multipart response, use a <code>ServletOutputStream</code> and manage the
- * character sections manually.
+ * To send binary data in a MIME body response, use the {@link ServletOutputStream} returned by
+ * {@link #getOutputStream}. To send character data, use the <code>PrintWriter</code> object returned by
+ * {@link #getWriter}. To mix binary and text data, for example, to create a multipart response, use a
+ * <code>ServletOutputStream</code> and manage the character sections manually.
* <p>
- * The charset for the MIME body response can be specified explicitly or
- * implicitly. The priority order for specifying the response body is:
+ * The charset for the MIME body response can be specified explicitly or implicitly. The priority order for specifying
+ * the response body is:
* <ol>
- * <li>explicitly per request using {@link #setCharacterEncoding} and
- * {@link #setContentType}</li>
+ * <li>explicitly per request using {@link #setCharacterEncoding} and {@link #setContentType}</li>
* <li>implicitly per request using {@link #setLocale}</li>
* <li>per web application via the deployment descriptor or
- * {@link ServletContext#setRequestCharacterEncoding(String)}</li>
+ * {@link ServletContext#setRequestCharacterEncoding(String)}</li>
* <li>container default via vendor specific configuration</li>
* <li>ISO-8859-1</li>
* </ol>
- * The <code>setCharacterEncoding</code>, <code>setContentType</code>, or
- * <code>setLocale</code> method must be called before <code>getWriter</code>
- * and before committing the response for the character encoding to be used.
+ * The <code>setCharacterEncoding</code>, <code>setContentType</code>, or <code>setLocale</code> method must be called
+ * before <code>getWriter</code> and before committing the response for the character encoding to be used.
* <p>
- * See the Internet RFCs such as <a href="http://www.ietf.org/rfc/rfc2045.txt">
- * RFC 2045</a> for more information on MIME. Protocols such as SMTP and HTTP
- * define profiles of MIME, and those standards are still evolving.
+ * See the Internet RFCs such as <a href="http://www.ietf.org/rfc/rfc2045.txt"> RFC 2045</a> for more information on
+ * MIME. Protocols such as SMTP and HTTP define profiles of MIME, and those standards are still evolving.
*
* @see ServletOutputStream
*/
public interface ServletResponse {
/**
- * Returns the name of the character encoding (MIME charset) used for the
- * body sent in this response.
- * The charset for the MIME body response can be specified explicitly or
- * implicitly. The priority order for specifying the response body is:
+ * Returns the name of the character encoding (MIME charset) used for the body sent in this response. The charset
+ * for the MIME body response can be specified explicitly or implicitly. The priority order for specifying the
+ * response body is:
* <ol>
- * <li>explicitly per request using {@link #setCharacterEncoding} and
- * {@link #setContentType}</li>
+ * <li>explicitly per request using {@link #setCharacterEncoding} and {@link #setContentType}</li>
* <li>implicitly per request using {@link #setLocale}</li>
* <li>per web application via the deployment descriptor or
- * {@link ServletContext#setRequestCharacterEncoding(String)}</li>
+ * {@link ServletContext#setRequestCharacterEncoding(String)}</li>
* <li>container default via vendor specific configuration</li>
* <li>ISO-8859-1</li>
* </ol>
- * Calls made to {@link #setCharacterEncoding}, {@link #setContentType} or
- * {@link #setLocale} after <code>getWriter</code> has been called or after
- * the response has been committed have no effect on the character encoding.
- * If no character encoding has been specified, <code>ISO-8859-1</code> is
- * returned.
+ * Calls made to {@link #setCharacterEncoding}, {@link #setContentType} or {@link #setLocale} after
+ * <code>getWriter</code> has been called or after the response has been committed have no effect on the character
+ * encoding. If no character encoding has been specified, <code>ISO-8859-1</code> is returned.
* <p>
- * See RFC 2047 (http://www.ietf.org/rfc/rfc2047.txt) for more information
- * about character encoding and MIME.
+ * See RFC 2047 (http://www.ietf.org/rfc/rfc2047.txt) for more information about character encoding and MIME.
*
- * @return a <code>String</code> specifying the name of the character
- * encoding, for example, <code>UTF-8</code>
+ * @return a <code>String</code> specifying the name of the character encoding, for example, <code>UTF-8</code>
*/
String getCharacterEncoding();
/**
- * Returns the content type used for the MIME body sent in this response.
- * The content type proper must have been specified using
- * {@link #setContentType} before the response is committed. If no content
- * type has been specified, this method returns null. If a content type has
- * been specified and a character encoding has been explicitly or implicitly
- * specified as described in {@link #getCharacterEncoding}, the charset
- * parameter is included in the string returned. If no character encoding
- * has been specified, the charset parameter is omitted.
- *
- * @return a <code>String</code> specifying the content type, for example,
- * <code>text/html; charset=UTF-8</code>, or null
+ * Returns the content type used for the MIME body sent in this response. The content type proper must have been
+ * specified using {@link #setContentType} before the response is committed. If no content type has been specified,
+ * this method returns null. If a content type has been specified and a character encoding has been explicitly or
+ * implicitly specified as described in {@link #getCharacterEncoding}, the charset parameter is included in the
+ * string returned. If no character encoding has been specified, the charset parameter is omitted.
+ *
+ * @return a <code>String</code> specifying the content type, for example, <code>text/html; charset=UTF-8</code>, or
+ * null
+ *
* @since Servlet 2.4
*/
String getContentType();
/**
- * Returns a {@link ServletOutputStream} suitable for writing binary data in
- * the response. The servlet container does not encode the binary data.
+ * Returns a {@link ServletOutputStream} suitable for writing binary data in the response. The servlet container
+ * does not encode the binary data.
* <p>
- * Calling flush() on the ServletOutputStream commits the response. Either
- * this method or {@link #getWriter} may be called to write the body, not
- * both.
+ * Calling flush() on the ServletOutputStream commits the response. Either this method or {@link #getWriter} may be
+ * called to write the body, not both.
*
* @return a {@link ServletOutputStream} for writing binary data
- * @exception IllegalStateException
- * if the <code>getWriter</code> method has been called on
- * this response
- * @exception IOException
- * if an input or output exception occurred
+ *
+ * @exception IllegalStateException if the <code>getWriter</code> method has been called on this response
+ * @exception IOException if an input or output exception occurred
+ *
* @see #getWriter
*/
ServletOutputStream getOutputStream() throws IOException;
/**
- * Returns a <code>PrintWriter</code> object that can send character text to
- * the client. The <code>PrintWriter</code> uses the character encoding
- * returned by {@link #getCharacterEncoding}. If the response's character
- * encoding has not been specified as described in
- * <code>getCharacterEncoding</code> (i.e., the method just returns the
- * default value <code>ISO-8859-1</code>), <code>getWriter</code> updates it
- * to <code>ISO-8859-1</code>.
+ * Returns a <code>PrintWriter</code> object that can send character text to the client. The
+ * <code>PrintWriter</code> uses the character encoding returned by {@link #getCharacterEncoding}. If the response's
+ * character encoding has not been specified as described in <code>getCharacterEncoding</code> (i.e., the method
+ * just returns the default value <code>ISO-8859-1</code>), <code>getWriter</code> updates it to
+ * <code>ISO-8859-1</code>.
* <p>
* Calling flush() on the <code>PrintWriter</code> commits the response.
* <p>
- * Either this method or {@link #getOutputStream} may be called to write the
- * body, not both.
- *
- * @return a <code>PrintWriter</code> object that can return character data
- * to the client
- * @exception java.io.UnsupportedEncodingException
- * if the character encoding returned by
- * <code>getCharacterEncoding</code> cannot be used
- * @exception IllegalStateException
- * if the <code>getOutputStream</code> method has already
- * been called for this response object
- * @exception IOException
- * if an input or output exception occurred
+ * Either this method or {@link #getOutputStream} may be called to write the body, not both.
+ *
+ * @return a <code>PrintWriter</code> object that can return character data to the client
+ *
+ * @exception java.io.UnsupportedEncodingException if the character encoding returned by
+ * <code>getCharacterEncoding</code> cannot be used
+ * @exception IllegalStateException if the <code>getOutputStream</code> method has already been
+ * called for this response object
+ * @exception IOException if an input or output exception occurred
+ *
* @see #getOutputStream
* @see #setCharacterEncoding
*/
PrintWriter getWriter() throws IOException;
/**
- * Sets the character encoding (MIME charset) of the response being sent to
- * the client, for example, to UTF-8. If the character encoding has already
- * been set by container default, ServletContext default,
- * {@link #setContentType} or {@link #setLocale}, this method overrides it.
- * Calling {@link #setContentType} with the <code>String</code> of
- * <code>text/html</code> and calling this method with the
- * <code>String</code> of <code>UTF-8</code> is equivalent with calling
- * <code>setContentType</code> with the <code>String</code> of
- * <code>text/html; charset=UTF-8</code>.
+ * Sets the character encoding (MIME charset) of the response being sent to the client, for example, to UTF-8. If
+ * the character encoding has already been set by container default, ServletContext default, {@link #setContentType}
+ * or {@link #setLocale}, this method overrides it. Calling {@link #setContentType} with the <code>String</code> of
+ * <code>text/html</code> and calling this method with the <code>String</code> of <code>UTF-8</code> is equivalent
+ * with calling <code>setContentType</code> with the <code>String</code> of <code>text/html; charset=UTF-8</code>.
* <p>
- * This method can be called repeatedly to change the character encoding.
- * This method has no effect if it is called after <code>getWriter</code>
- * has been called or after the response has been committed.
+ * This method can be called repeatedly to change the character encoding. This method has no effect if it is called
+ * after <code>getWriter</code> has been called or after the response has been committed.
* <p>
- * Containers must communicate the character encoding used for the servlet
- * response's writer to the client if the protocol provides a way for doing
- * so. In the case of HTTP, the character encoding is communicated as part
- * of the <code>Content-Type</code> header for text media types. Note that
- * the character encoding cannot be communicated via HTTP headers if the
- * servlet does not specify a content type; however, it is still used to
- * encode text written via the servlet response's writer.
- *
- * @param charset
- * a String specifying only the character set defined by IANA
- * Character Sets
- * (http://www.iana.org/assignments/character-sets)
+ * Containers must communicate the character encoding used for the servlet response's writer to the client if the
+ * protocol provides a way for doing so. In the case of HTTP, the character encoding is communicated as part of the
+ * <code>Content-Type</code> header for text media types. Note that the character encoding cannot be communicated
+ * via HTTP headers if the servlet does not specify a content type; however, it is still used to encode text written
+ * via the servlet response's writer.
+ *
+ * @param charset a String specifying only the character set defined by IANA Character Sets
+ * (http://www.iana.org/assignments/character-sets)
+ *
* @see #setContentType #setLocale
+ *
* @since Servlet 2.4
*/
void setCharacterEncoding(String charset);
/**
- * Sets the length of the content body in the response In HTTP servlets,
- * this method sets the HTTP Content-Length header.
+ * Sets the length of the content body in the response In HTTP servlets, this method sets the HTTP Content-Length
+ * header.
*
- * @param len
- * an integer specifying the length of the content being returned
- * to the client; sets the Content-Length header
+ * @param len an integer specifying the length of the content being returned to the client; sets the Content-Length
+ * header
*/
void setContentLength(int len);
/**
- * Sets the length of the content body in the response In HTTP servlets,
- * this method sets the HTTP Content-Length header.
+ * Sets the length of the content body in the response In HTTP servlets, this method sets the HTTP Content-Length
+ * header.
*
- * @param length
- * an integer specifying the length of the content being returned
- * to the client; sets the Content-Length header
+ * @param length an integer specifying the length of the content being returned to the client; sets the
+ * Content-Length header
*
* @since Servlet 3.1
*/
void setContentLengthLong(long length);
/**
- * Sets the content type of the response being sent to the client, if the
- * response has not been committed yet. The given content type may include a
- * character encoding specification, for example,
- * <code>text/html;charset=UTF-8</code>. The response's character encoding
- * is only set from the given content type if this method is called before
- * <code>getWriter</code> is called.
+ * Sets the content type of the response being sent to the client, if the response has not been committed yet. The
+ * given content type may include a character encoding specification, for example,
+ * <code>text/html;charset=UTF-8</code>. The response's character encoding is only set from the given content type
+ * if this method is called before <code>getWriter</code> is called.
* <p>
- * This method may be called repeatedly to change content type and character
- * encoding. This method has no effect if called after the response has been
- * committed. It does not set the response's character encoding if it is
- * called after <code>getWriter</code> has been called or after the response
- * has been committed.
+ * This method may be called repeatedly to change content type and character encoding. This method has no effect if
+ * called after the response has been committed. It does not set the response's character encoding if it is called
+ * after <code>getWriter</code> has been called or after the response has been committed.
* <p>
- * Containers must communicate the content type and the character encoding
- * used for the servlet response's writer to the client if the protocol
- * provides a way for doing so. In the case of HTTP, the
- * <code>Content-Type</code> header is used.
+ * Containers must communicate the content type and the character encoding used for the servlet response's writer to
+ * the client if the protocol provides a way for doing so. In the case of HTTP, the <code>Content-Type</code> header
+ * is used.
+ *
+ * @param type a <code>String</code> specifying the MIME type of the content
*
- * @param type
- * a <code>String</code> specifying the MIME type of the content
* @see #setLocale
* @see #setCharacterEncoding
* @see #getOutputStream
@@ -229,23 +194,20 @@ public interface ServletResponse {
void setContentType(String type);
/**
- * Sets the preferred buffer size for the body of the response. The servlet
- * container will use a buffer at least as large as the size requested. The
- * actual buffer size used can be found using <code>getBufferSize</code>.
+ * Sets the preferred buffer size for the body of the response. The servlet container will use a buffer at least as
+ * large as the size requested. The actual buffer size used can be found using <code>getBufferSize</code>.
* <p>
- * A larger buffer allows more content to be written before anything is
- * actually sent, thus providing the servlet with more time to set
- * appropriate status codes and headers. A smaller buffer decreases server
- * memory load and allows the client to start receiving data more quickly.
+ * A larger buffer allows more content to be written before anything is actually sent, thus providing the servlet
+ * with more time to set appropriate status codes and headers. A smaller buffer decreases server memory load and
+ * allows the client to start receiving data more quickly.
* <p>
- * This method must be called before any response body content is written;
- * if content has been written or the response object has been committed,
- * this method throws an <code>IllegalStateException</code>.
- *
- * @param size
- * the preferred buffer size
- * @exception IllegalStateException
- * if this method is called after content has been written
+ * This method must be called before any response body content is written; if content has been written or the
+ * response object has been committed, this method throws an <code>IllegalStateException</code>.
+ *
+ * @param size the preferred buffer size
+ *
+ * @exception IllegalStateException if this method is called after content has been written
+ *
* @see #getBufferSize
* @see #flushBuffer
* @see #isCommitted
@@ -254,10 +216,10 @@ public interface ServletResponse {
void setBufferSize(int size);
/**
- * Returns the actual buffer size used for the response. If no buffering is
- * used, this method returns 0.
+ * Returns the actual buffer size used for the response. If no buffering is used, this method returns 0.
*
* @return the actual buffer size used
+ *
* @see #setBufferSize
* @see #flushBuffer
* @see #isCommitted
@@ -266,9 +228,8 @@ public interface ServletResponse {
int getBufferSize();
/**
- * Forces any content in the buffer to be written to the client. A call to
- * this method automatically commits the response, meaning the status code
- * and headers will be written.
+ * Forces any content in the buffer to be written to the client. A call to this method automatically commits the
+ * response, meaning the status code and headers will be written.
*
* @throws IOException if an I/O occurs during the flushing of the response
*
@@ -280,9 +241,8 @@ public interface ServletResponse {
void flushBuffer() throws IOException;
/**
- * Clears the content of the underlying buffer in the response without
- * clearing headers or status code. If the response has been committed, this
- * method throws an <code>IllegalStateException</code>.
+ * Clears the content of the underlying buffer in the response without clearing headers or status code. If the
+ * response has been committed, this method throws an <code>IllegalStateException</code>.
*
* @see #setBufferSize
* @see #getBufferSize
@@ -294,10 +254,11 @@ public interface ServletResponse {
void resetBuffer();
/**
- * Returns a boolean indicating if the response has been committed. A
- * committed response has already had its status code and headers written.
+ * Returns a boolean indicating if the response has been committed. A committed response has already had its status
+ * code and headers written.
*
* @return a boolean indicating if the response has been committed
+ *
* @see #setBufferSize
* @see #getBufferSize
* @see #flushBuffer
@@ -306,12 +267,11 @@ public interface ServletResponse {
boolean isCommitted();
/**
- * Clears any data that exists in the buffer as well as the status code and
- * headers. If the response has been committed, this method throws an
- * <code>IllegalStateException</code>.
+ * Clears any data that exists in the buffer as well as the status code and headers. If the response has been
+ * committed, this method throws an <code>IllegalStateException</code>.
+ *
+ * @exception IllegalStateException if the response has already been committed
*
- * @exception IllegalStateException
- * if the response has already been committed
* @see #setBufferSize
* @see #getBufferSize
* @see #flushBuffer
@@ -320,35 +280,26 @@ public interface ServletResponse {
void reset();
/**
- * Sets the locale of the response, if the response has not been committed
- * yet. It also sets the response's character encoding appropriately for the
- * locale, if the character encoding has not been explicitly set using
- * {@link #setContentType} or {@link #setCharacterEncoding},
- * <code>getWriter</code> hasn't been called yet, and the response hasn't
- * been committed yet. If the deployment descriptor contains a
- * <code>locale-encoding-mapping-list</code> element, and that element
- * provides a mapping for the given locale, that mapping is used. Otherwise,
- * the mapping from locale to character encoding is container dependent.
+ * Sets the locale of the response, if the response has not been committed yet. It also sets the response's
+ * character encoding appropriately for the locale, if the character encoding has not been explicitly set using
+ * {@link #setContentType} or {@link #setCharacterEncoding}, <code>getWriter</code> hasn't been called yet, and the
+ * response hasn't been committed yet. If the deployment descriptor contains a
+ * <code>locale-encoding-mapping-list</code> element, and that element provides a mapping for the given locale, that
+ * mapping is used. Otherwise, the mapping from locale to character encoding is container dependent.
* <p>
- * This method may be called repeatedly to change locale and character
- * encoding. The method has no effect if called after the response has been
- * committed. It does not set the response's character encoding if it is
- * called after {@link #setContentType} has been called with a charset
- * specification, after {@link #setCharacterEncoding} has been called, after
- * <code>getWriter</code> has been called, or after the response has been
- * committed.
+ * This method may be called repeatedly to change locale and character encoding. The method has no effect if called
+ * after the response has been committed. It does not set the response's character encoding if it is called after
+ * {@link #setContentType} has been called with a charset specification, after {@link #setCharacterEncoding} has
+ * been called, after <code>getWriter</code> has been called, or after the response has been committed.
* <p>
- * Containers must communicate the locale and the character encoding used
- * for the servlet response's writer to the client if the protocol provides
- * a way for doing so. In the case of HTTP, the locale is communicated via
- * the <code>Content-Language</code> header, the character encoding as part
- * of the <code>Content-Type</code> header for text media types. Note that
- * the character encoding cannot be communicated via HTTP headers if the
- * servlet does not specify a content type; however, it is still used to
- * encode text written via the servlet response's writer.
- *
- * @param loc
- * the locale of the response
+ * Containers must communicate the locale and the character encoding used for the servlet response's writer to the
+ * client if the protocol provides a way for doing so. In the case of HTTP, the locale is communicated via the
+ * <code>Content-Language</code> header, the character encoding as part of the <code>Content-Type</code> header for
+ * text media types. Note that the character encoding cannot be communicated via HTTP headers if the servlet does
+ * not specify a content type; however, it is still used to encode text written via the servlet response's writer.
+ *
+ * @param loc the locale of the response
+ *
* @see #getLocale
* @see #setContentType
* @see #setCharacterEncoding
@@ -356,13 +307,11 @@ public interface ServletResponse {
void setLocale(Locale loc);
/**
- * Returns the locale specified for this response using the
- * {@link #setLocale} method. Calls made to <code>setLocale</code> after the
- * response is committed have no effect.
+ * Returns the locale specified for this response using the {@link #setLocale} method. Calls made to
+ * <code>setLocale</code> after the response is committed have no effect.
*
- * @return The locale specified for this response using the
- * {@link #setLocale} method. If no locale has been specified, the
- * container's default locale is returned.
+ * @return The locale specified for this response using the {@link #setLocale} method. If no locale has been
+ * specified, the container's default locale is returned.
*
* @see #setLocale
*/
diff --git a/java/javax/servlet/ServletResponseWrapper.java b/java/javax/servlet/ServletResponseWrapper.java
index da9264a26d..74d8d79088 100644
--- a/java/javax/servlet/ServletResponseWrapper.java
+++ b/java/javax/servlet/ServletResponseWrapper.java
@@ -22,12 +22,12 @@ import java.util.Locale;
import java.util.ResourceBundle;
/**
- * Provides a convenient implementation of the ServletResponse interface that
- * can be subclassed by developers wishing to adapt the response from a Servlet.
- * This class implements the Wrapper or Decorator pattern. Methods default to
- * calling through to the wrapped response object.
+ * Provides a convenient implementation of the ServletResponse interface that can be subclassed by developers wishing to
+ * adapt the response from a Servlet. This class implements the Wrapper or Decorator pattern. Methods default to calling
+ * through to the wrapped response object.
*
* @since Servlet 2.3
+ *
* @see javax.servlet.ServletResponse
*/
public class ServletResponseWrapper implements ServletResponse {
@@ -41,8 +41,7 @@ public class ServletResponseWrapper implements ServletResponse {
*
* @param response The response to wrap
*
- * @throws java.lang.IllegalArgumentException
- * if the response is null.
+ * @throws java.lang.IllegalArgumentException if the response is null.
*/
public ServletResponseWrapper(ServletResponse response) {
if (response == null) {
@@ -65,8 +64,7 @@ public class ServletResponseWrapper implements ServletResponse {
*
* @param response The new response to wrap
*
- * @throws java.lang.IllegalArgumentException
- * if the response is null.
+ * @throws java.lang.IllegalArgumentException if the response is null.
*/
public void setResponse(ServletResponse response) {
if (response == null) {
@@ -76,8 +74,8 @@ public class ServletResponseWrapper implements ServletResponse {
}
/**
- * The default behavior of this method is to call
- * setCharacterEncoding(String charset) on the wrapped response object.
+ * The default behavior of this method is to call setCharacterEncoding(String charset) on the wrapped response
+ * object.
*
* @since Servlet 2.4
*/
@@ -87,8 +85,7 @@ public class ServletResponseWrapper implements ServletResponse {
}
/**
- * The default behavior of this method is to return getCharacterEncoding()
- * on the wrapped response object.
+ * The default behavior of this method is to return getCharacterEncoding() on the wrapped response object.
*/
@Override
public String getCharacterEncoding() {
@@ -96,8 +93,7 @@ public class ServletResponseWrapper implements ServletResponse {
}
/**
- * The default behavior of this method is to return getOutputStream() on the
- * wrapped response object.
+ * The default behavior of this method is to return getOutputStream() on the wrapped response object.
*/
@Override
public ServletOutputStream getOutputStream() throws IOException {
@@ -105,8 +101,7 @@ public class ServletResponseWrapper implements ServletResponse {
}
/**
- * The default behavior of this method is to return getWriter() on the
- * wrapped response object.
+ * The default behavior of this method is to return getWriter() on the wrapped response object.
*/
@Override
public PrintWriter getWriter() throws IOException {
@@ -114,8 +109,7 @@ public class ServletResponseWrapper implements ServletResponse {
}
/**
- * The default behavior of this method is to call setContentLength(int len)
- * on the wrapped response object.
+ * The default behavior of this method is to call setContentLength(int len) on the wrapped response object.
*/
@Override
public void setContentLength(int len) {
@@ -123,8 +117,7 @@ public class ServletResponseWrapper implements ServletResponse {
}
/**
- * The default behavior of this method is to call setContentLengthLong(long len)
- * on the wrapped response object.
+ * The default behavior of this method is to call setContentLengthLong(long len) on the wrapped response object.
*
* @since Servlet 3.1
*/
@@ -134,8 +127,7 @@ public class ServletResponseWrapper implements ServletResponse {
}
/**
- * The default behavior of this method is to call setContentType(String
- * type) on the wrapped response object.
+ * The default behavior of this method is to call setContentType(String type) on the wrapped response object.
*/
@Override
public void setContentType(String type) {
@@ -143,8 +135,7 @@ public class ServletResponseWrapper implements ServletResponse {
}
/**
- * The default behavior of this method is to return getContentType() on the
- * wrapped response object.
+ * The default behavior of this method is to return getContentType() on the wrapped response object.
*
* @since Servlet 2.4
*/
@@ -154,8 +145,7 @@ public class ServletResponseWrapper implements ServletResponse {
}
/**
- * The default behavior of this method is to call setBufferSize(int size) on
- * the wrapped response object.
+ * The default behavior of this method is to call setBufferSize(int size) on the wrapped response object.
*/
@Override
public void setBufferSize(int size) {
@@ -163,8 +153,7 @@ public class ServletResponseWrapper implements ServletResponse {
}
/**
- * The default behavior of this method is to return getBufferSize() on the
- * wrapped response object.
+ * The default behavior of this method is to return getBufferSize() on the wrapped response object.
*/
@Override
public int getBufferSize() {
@@ -172,8 +161,7 @@ public class ServletResponseWrapper implements ServletResponse {
}
/**
- * The default behavior of this method is to call flushBuffer() on the
- * wrapped response object.
+ * The default behavior of this method is to call flushBuffer() on the wrapped response object.
*/
@Override
public void flushBuffer() throws IOException {
@@ -181,8 +169,7 @@ public class ServletResponseWrapper implements ServletResponse {
}
/**
- * The default behavior of this method is to return isCommitted() on the
- * wrapped response object.
+ * The default behavior of this method is to return isCommitted() on the wrapped response object.
*/
@Override
public boolean isCommitted() {
@@ -190,8 +177,7 @@ public class ServletResponseWrapper implements ServletResponse {
}
/**
- * The default behavior of this method is to call reset() on the wrapped
- * response object.
+ * The default behavior of this method is to call reset() on the wrapped response object.
*/
@Override
public void reset() {
@@ -199,8 +185,7 @@ public class ServletResponseWrapper implements ServletResponse {
}
/**
- * The default behavior of this method is to call resetBuffer() on the
- * wrapped response object.
+ * The default behavior of this method is to call resetBuffer() on the wrapped response object.
*/
@Override
public void resetBuffer() {
@@ -208,8 +193,7 @@ public class ServletResponseWrapper implements ServletResponse {
}
/**
- * The default behavior of this method is to call setLocale(Locale loc) on
- * the wrapped response object.
+ * The default behavior of this method is to call setLocale(Locale loc) on the wrapped response object.
*/
@Override
public void setLocale(Locale loc) {
@@ -217,8 +201,7 @@ public class ServletResponseWrapper implements ServletResponse {
}
/**
- * The default behavior of this method is to return getLocale() on the
- * wrapped response object.
+ * The default behavior of this method is to return getLocale() on the wrapped response object.
*/
@Override
public Locale getLocale() {
@@ -227,10 +210,12 @@ public class ServletResponseWrapper implements ServletResponse {
/**
* TODO SERVLET3 - Add comments
+ *
* @param wrapped The response to compare to the wrapped response
- * @return <code>true</code> if the response wrapped by this wrapper (or
- * series of wrappers) is the same as the supplied response,
- * otherwise <code>false</code>
+ *
+ * @return <code>true</code> if the response wrapped by this wrapper (or series of wrappers) is the same as the
+ * supplied response, otherwise <code>false</code>
+ *
* @since Servlet 3.0
*/
public boolean isWrapperFor(ServletResponse wrapped) {
@@ -245,11 +230,12 @@ public class ServletResponseWrapper implements ServletResponse {
/**
* TODO SERVLET3 - Add comments
- * @param wrappedType The class to compare to the class of the wrapped
- * response
- * @return <code>true</code> if the response wrapped by this wrapper (or
- * series of wrappers) is the same type as the supplied type,
- * otherwise <code>false</code>
+ *
+ * @param wrappedType The class to compare to the class of the wrapped response
+ *
+ * @return <code>true</code> if the response wrapped by this wrapper (or series of wrappers) is the same type as the
+ * supplied type, otherwise <code>false</code>
+ *
* @since Servlet 3.0
*/
public boolean isWrapperFor(Class<?> wrappedType) {
diff --git a/java/javax/servlet/ServletSecurityElement.java b/java/javax/servlet/ServletSecurityElement.java
index 9b4821f893..9146265fc3 100644
--- a/java/javax/servlet/ServletSecurityElement.java
+++ b/java/javax/servlet/ServletSecurityElement.java
@@ -27,9 +27,8 @@ import javax.servlet.annotation.HttpMethodConstraint;
import javax.servlet.annotation.ServletSecurity;
/**
- * The programmatic equivalent of
- * {@link javax.servlet.annotation.ServletSecurity} used to configre
- * security constraints for a Servlet.
+ * The programmatic equivalent of {@link javax.servlet.annotation.ServletSecurity} used to configre security constraints
+ * for a Servlet.
*
* @since Servlet 3.0
*/
@@ -46,63 +45,59 @@ public class ServletSecurityElement extends HttpConstraintElement {
/**
* Use specified HttpConstraintElement.
+ *
* @param httpConstraintElement The constraint
*/
public ServletSecurityElement(HttpConstraintElement httpConstraintElement) {
- this (httpConstraintElement, null);
+ this(httpConstraintElement, null);
}
/**
- * Use specific constraints for specified methods and default
- * HttpConstraintElement for all other methods.
+ * Use specific constraints for specified methods and default HttpConstraintElement for all other methods.
+ *
* @param httpMethodConstraints Method constraints
- * @throws IllegalArgumentException if a method name is specified more than
- * once
+ *
+ * @throws IllegalArgumentException if a method name is specified more than once
*/
- public ServletSecurityElement(
- Collection<HttpMethodConstraintElement> httpMethodConstraints) {
+ public ServletSecurityElement(Collection<HttpMethodConstraintElement> httpMethodConstraints) {
super();
addHttpMethodConstraints(httpMethodConstraints);
}
/**
- * Use specified HttpConstraintElement as default and specific constraints
- * for specified methods.
+ * Use specified HttpConstraintElement as default and specific constraints for specified methods.
+ *
* @param httpConstraintElement Default constraint
* @param httpMethodConstraints Method constraints
- * @throws IllegalArgumentException if a method name is specified more than
- * once
+ *
+ * @throws IllegalArgumentException if a method name is specified more than once
*/
public ServletSecurityElement(HttpConstraintElement httpConstraintElement,
Collection<HttpMethodConstraintElement> httpMethodConstraints) {
- super(httpConstraintElement.getEmptyRoleSemantic(),
- httpConstraintElement.getTransportGuarantee(),
+ super(httpConstraintElement.getEmptyRoleSemantic(), httpConstraintElement.getTransportGuarantee(),
httpConstraintElement.getRolesAllowed());
addHttpMethodConstraints(httpMethodConstraints);
}
/**
* Create from an annotation.
+ *
* @param annotation Annotation to use as the basis for the new instance
- * @throws IllegalArgumentException if a method name is specified more than
- * once
+ *
+ * @throws IllegalArgumentException if a method name is specified more than once
*/
public ServletSecurityElement(ServletSecurity annotation) {
- this(new HttpConstraintElement(annotation.value().value(),
- annotation.value().transportGuarantee(),
+ this(new HttpConstraintElement(annotation.value().value(), annotation.value().transportGuarantee(),
annotation.value().rolesAllowed()));
List<HttpMethodConstraintElement> l = new ArrayList<>();
HttpMethodConstraint[] constraints = annotation.httpMethodConstraints();
if (constraints != null) {
for (HttpMethodConstraint constraint : constraints) {
- HttpMethodConstraintElement e =
- new HttpMethodConstraintElement(constraint.value(),
- new HttpConstraintElement(
- constraint.emptyRoleSemantic(),
- constraint.transportGuarantee(),
- constraint.rolesAllowed()));
+ HttpMethodConstraintElement e = new HttpMethodConstraintElement(constraint.value(),
+ new HttpConstraintElement(constraint.emptyRoleSemantic(), constraint.transportGuarantee(),
+ constraint.rolesAllowed()));
l.add(e);
}
}
@@ -110,8 +105,7 @@ public class ServletSecurityElement extends HttpConstraintElement {
}
/**
- * Obtain the collection of security constraints configured for specific
- * methods.
+ * Obtain the collection of security constraints configured for specific methods.
*
* @return The security constraints for specific methods
*/
@@ -121,8 +115,7 @@ public class ServletSecurityElement extends HttpConstraintElement {
}
/**
- * Obtain the collection HTTP methods for which security constraints have
- * been defined.
+ * Obtain the collection HTTP methods for which security constraints have been defined.
*
* @return The names of the HTTP methods
*/
@@ -131,16 +124,14 @@ public class ServletSecurityElement extends HttpConstraintElement {
return result;
}
- private void addHttpMethodConstraints(
- Collection<HttpMethodConstraintElement> httpMethodConstraints) {
+ private void addHttpMethodConstraints(Collection<HttpMethodConstraintElement> httpMethodConstraints) {
if (httpMethodConstraints == null) {
return;
}
for (HttpMethodConstraintElement constraint : httpMethodConstraints) {
String method = constraint.getMethodName();
if (methodConstraints.containsKey(method)) {
- throw new IllegalArgumentException(
- "Duplicate method name: " + method);
+ throw new IllegalArgumentException("Duplicate method name: " + method);
}
methodConstraints.put(method, constraint);
}
diff --git a/java/javax/servlet/SessionCookieConfig.java b/java/javax/servlet/SessionCookieConfig.java
index c1891c53dd..2b532697c6 100644
--- a/java/javax/servlet/SessionCookieConfig.java
+++ b/java/javax/servlet/SessionCookieConfig.java
@@ -17,8 +17,8 @@
package javax.servlet;
/**
- * Configures the session cookies used by the web application associated with
- * the ServletContext from which this SessionCookieConfig was obtained.
+ * Configures the session cookies used by the web application associated with the ServletContext from which this
+ * SessionCookieConfig was obtained.
*
* @since Servlet 3.0
*/
@@ -29,8 +29,7 @@ public interface SessionCookieConfig {
*
* @param name The name of the session cookie
*
- * @throws IllegalStateException if the associated ServletContext has
- * already been initialised
+ * @throws IllegalStateException if the associated ServletContext has already been initialised
*/
void setName(String name);
@@ -46,8 +45,7 @@ public interface SessionCookieConfig {
*
* @param domain The session cookie domain
*
- * @throws IllegalStateException if the associated ServletContext has
- * already been initialised
+ * @throws IllegalStateException if the associated ServletContext has already been initialised
*/
void setDomain(String domain);
@@ -63,14 +61,12 @@ public interface SessionCookieConfig {
*
* @param path The session cookie path
*
- * @throws IllegalStateException if the associated ServletContext has
- * already been initialised
+ * @throws IllegalStateException if the associated ServletContext has already been initialised
*/
void setPath(String path);
/**
- * Obtain the path to use for session cookies. This is normally the context
- * path.
+ * Obtain the path to use for session cookies. This is normally the context path.
*
* @return The path to use for session cookies.
*/
@@ -81,8 +77,7 @@ public interface SessionCookieConfig {
*
* @param comment The session cookie comment
*
- * @throws IllegalStateException if the associated ServletContext has
- * already been initialised
+ * @throws IllegalStateException if the associated ServletContext has already been initialised
*/
void setComment(String comment);
@@ -98,8 +93,7 @@ public interface SessionCookieConfig {
*
* @param httpOnly The httpOnly setting to use for session cookies
*
- * @throws IllegalStateException if the associated ServletContext has
- * already been initialised
+ * @throws IllegalStateException if the associated ServletContext has already been initialised
*/
void setHttpOnly(boolean httpOnly);
@@ -115,8 +109,7 @@ public interface SessionCookieConfig {
*
* @param secure The secure setting to use for session cookies
*
- * @throws IllegalStateException if the associated ServletContext has
- * already been initialised
+ * @throws IllegalStateException if the associated ServletContext has already been initialised
*/
void setSecure(boolean secure);
@@ -131,8 +124,8 @@ public interface SessionCookieConfig {
* Sets the maximum age.
*
* @param MaxAge the maximum age to set
- * @throws IllegalStateException if the associated ServletContext has
- * already been initialised
+ *
+ * @throws IllegalStateException if the associated ServletContext has already been initialised
*/
void setMaxAge(int MaxAge);
diff --git a/java/javax/servlet/SingleThreadModel.java b/java/javax/servlet/SingleThreadModel.java
index fa9732d1ea..e69e566fd7 100644
--- a/java/javax/servlet/SingleThreadModel.java
+++ b/java/javax/servlet/SingleThreadModel.java
@@ -17,23 +17,18 @@
package javax.servlet;
/**
- * Ensures that servlets handle only one request at a time. This interface has
- * no methods.
+ * Ensures that servlets handle only one request at a time. This interface has no methods.
* <p>
- * If a servlet implements this interface, you are <i>guaranteed</i> that no two
- * threads will execute concurrently in the servlet's <code>service</code>
- * method. The servlet container can make this guarantee by synchronizing access
- * to a single instance of the servlet, or by maintaining a pool of servlet
- * instances and dispatching each new request to a free servlet.
+ * If a servlet implements this interface, you are <i>guaranteed</i> that no two threads will execute concurrently in
+ * the servlet's <code>service</code> method. The servlet container can make this guarantee by synchronizing access to a
+ * single instance of the servlet, or by maintaining a pool of servlet instances and dispatching each new request to a
+ * free servlet.
* <p>
- * Note that SingleThreadModel does not solve all thread safety issues. For
- * example, session attributes and static variables can still be accessed by
- * multiple requests on multiple threads at the same time, even when
- * SingleThreadModel servlets are used. It is recommended that a developer take
- * other means to resolve those issues instead of implementing this interface,
- * such as avoiding the usage of an instance variable or synchronizing the block
- * of the code accessing those resources. This interface is deprecated in
- * Servlet API version 2.4.
+ * Note that SingleThreadModel does not solve all thread safety issues. For example, session attributes and static
+ * variables can still be accessed by multiple requests on multiple threads at the same time, even when
+ * SingleThreadModel servlets are used. It is recommended that a developer take other means to resolve those issues
+ * instead of implementing this interface, such as avoiding the usage of an instance variable or synchronizing the block
+ * of the code accessing those resources. This interface is deprecated in Servlet API version 2.4.
*
* @deprecated As of Java Servlet API 2.4, with no direct replacement.
*/
diff --git a/java/javax/servlet/UnavailableException.java b/java/javax/servlet/UnavailableException.java
index 3ae5fba99f..58033d4b29 100644
--- a/java/javax/servlet/UnavailableException.java
+++ b/java/javax/servlet/UnavailableException.java
@@ -17,26 +17,20 @@
package javax.servlet;
/**
- * Defines an exception that a servlet or filter throws to indicate that it is
- * permanently or temporarily unavailable.
+ * Defines an exception that a servlet or filter throws to indicate that it is permanently or temporarily unavailable.
* <p>
- * When a servlet or filter is permanently unavailable, something is wrong with
- * it, and it cannot handle requests until some action is taken. For example, a
- * servlet might be configured incorrectly, or a filter's state may be
- * corrupted. The component should log both the error and the corrective action
- * that is needed.
+ * When a servlet or filter is permanently unavailable, something is wrong with it, and it cannot handle requests until
+ * some action is taken. For example, a servlet might be configured incorrectly, or a filter's state may be corrupted.
+ * The component should log both the error and the corrective action that is needed.
* <p>
- * A servlet or filter is temporarily unavailable if it cannot handle requests
- * momentarily due to some system-wide problem. For example, a third-tier server
- * might not be accessible, or there may be insufficient memory or disk storage
- * to handle requests. A system administrator may need to take corrective
- * action.
+ * A servlet or filter is temporarily unavailable if it cannot handle requests momentarily due to some system-wide
+ * problem. For example, a third-tier server might not be accessible, or there may be insufficient memory or disk
+ * storage to handle requests. A system administrator may need to take corrective action.
* <p>
- * Servlet containers can safely treat both types of unavailable exceptions in
- * the same way. However, treating temporary unavailability effectively makes
- * the servlet container more robust. Specifically, the servlet container might
- * block requests to the servlet or filter for a period of time suggested by the
- * exception, rather than rejecting them until the servlet container restarts.
+ * Servlet containers can safely treat both types of unavailable exceptions in the same way. However, treating temporary
+ * unavailability effectively makes the servlet container more robust. Specifically, the servlet container might block
+ * requests to the servlet or filter for a period of time suggested by the exception, rather than rejecting them until
+ * the servlet container restarts.
*/
public class UnavailableException extends ServletException {
@@ -58,12 +52,10 @@ public class UnavailableException extends ServletException {
private final int seconds;
/**
- * @param servlet
- * the <code>Servlet</code> instance that is unavailable
- * @param msg
- * a <code>String</code> specifying the descriptive message
- * @deprecated As of Java Servlet API 2.2, use
- * {@link #UnavailableException(String)} instead.
+ * @param servlet the <code>Servlet</code> instance that is unavailable
+ * @param msg a <code>String</code> specifying the descriptive message
+ *
+ * @deprecated As of Java Servlet API 2.2, use {@link #UnavailableException(String)} instead.
*/
@Deprecated
public UnavailableException(Servlet servlet, String msg) {
@@ -74,17 +66,13 @@ public class UnavailableException extends ServletException {
}
/**
- * @param seconds
- * an integer specifying the number of seconds the servlet
- * expects to be unavailable; if zero or negative, indicates that
- * the servlet can't make an estimate
- * @param servlet
- * the <code>Servlet</code> that is unavailable
- * @param msg
- * a <code>String</code> specifying the descriptive message,
- * which can be written to a log file or displayed for the user.
- * @deprecated As of Java Servlet API 2.2, use
- * {@link #UnavailableException(String, int)} instead.
+ * @param seconds an integer specifying the number of seconds the servlet expects to be unavailable; if zero or
+ * negative, indicates that the servlet can't make an estimate
+ * @param servlet the <code>Servlet</code> that is unavailable
+ * @param msg a <code>String</code> specifying the descriptive message, which can be written to a log file or
+ * displayed for the user.
+ *
+ * @deprecated As of Java Servlet API 2.2, use {@link #UnavailableException(String, int)} instead.
*/
@Deprecated
public UnavailableException(int seconds, Servlet servlet, String msg) {
@@ -99,11 +87,9 @@ public class UnavailableException extends ServletException {
}
/**
- * Constructs a new exception with a descriptive message indicating that the
- * servlet is permanently unavailable.
+ * Constructs a new exception with a descriptive message indicating that the servlet is permanently unavailable.
*
- * @param msg
- * a <code>String</code> specifying the descriptive message
+ * @param msg a <code>String</code> specifying the descriptive message
*/
public UnavailableException(String msg) {
super(msg);
@@ -113,23 +99,17 @@ public class UnavailableException extends ServletException {
}
/**
- * Constructs a new exception with a descriptive message indicating that the
- * servlet is temporarily unavailable and giving an estimate of how long it
- * will be unavailable.
+ * Constructs a new exception with a descriptive message indicating that the servlet is temporarily unavailable and
+ * giving an estimate of how long it will be unavailable.
* <p>
- * In some cases, the servlet cannot make an estimate. For example, the
- * servlet might know that a server it needs is not running, but not be able
- * to report how long it will take to be restored to functionality. This can
- * be indicated with a negative or zero value for the <code>seconds</code>
- * argument.
+ * In some cases, the servlet cannot make an estimate. For example, the servlet might know that a server it needs is
+ * not running, but not be able to report how long it will take to be restored to functionality. This can be
+ * indicated with a negative or zero value for the <code>seconds</code> argument.
*
- * @param msg
- * a <code>String</code> specifying the descriptive message,
- * which can be written to a log file or displayed for the user.
- * @param seconds
- * an integer specifying the number of seconds the servlet
- * expects to be unavailable; if zero or negative, indicates that
- * the servlet can't make an estimate
+ * @param msg a <code>String</code> specifying the descriptive message, which can be written to a log file or
+ * displayed for the user.
+ * @param seconds an integer specifying the number of seconds the servlet expects to be unavailable; if zero or
+ * negative, indicates that the servlet can't make an estimate
*/
public UnavailableException(String msg, int seconds) {
super(msg);
@@ -144,13 +124,11 @@ public class UnavailableException extends ServletException {
}
/**
- * Returns a <code>boolean</code> indicating whether the servlet is
- * permanently unavailable. If so, something is wrong with the servlet, and
- * the system administrator must take some corrective action.
+ * Returns a <code>boolean</code> indicating whether the servlet is permanently unavailable. If so, something is
+ * wrong with the servlet, and the system administrator must take some corrective action.
*
- * @return <code>true</code> if the servlet is permanently unavailable;
- * <code>false</code> if the servlet is available or temporarily
- * unavailable
+ * @return <code>true</code> if the servlet is permanently unavailable; <code>false</code> if the servlet is
+ * available or temporarily unavailable
*/
public boolean isPermanent() {
return permanent;
@@ -159,8 +137,8 @@ public class UnavailableException extends ServletException {
/**
* Returns the servlet that is reporting its unavailability.
*
- * @return the <code>Servlet</code> object that is throwing the
- * <code>UnavailableException</code>
+ * @return the <code>Servlet</code> object that is throwing the <code>UnavailableException</code>
+ *
* @deprecated As of Java Servlet API 2.2, with no replacement.
*/
@Deprecated
@@ -169,17 +147,14 @@ public class UnavailableException extends ServletException {
}
/**
- * Returns the number of seconds the servlet expects to be temporarily
- * unavailable.
+ * Returns the number of seconds the servlet expects to be temporarily unavailable.
* <p>
- * If this method returns a negative number, the servlet is permanently
- * unavailable or cannot provide an estimate of how long it will be
- * unavailable. No effort is made to correct for the time elapsed since the
- * exception was first reported.
+ * If this method returns a negative number, the servlet is permanently unavailable or cannot provide an estimate of
+ * how long it will be unavailable. No effort is made to correct for the time elapsed since the exception was first
+ * reported.
*
- * @return an integer specifying the number of seconds the servlet will be
- * temporarily unavailable, or a negative number if the servlet is
- * permanently unavailable or cannot make an estimate
+ * @return an integer specifying the number of seconds the servlet will be temporarily unavailable, or a negative
+ * number if the servlet is permanently unavailable or cannot make an estimate
*/
public int getUnavailableSeconds() {
return permanent ? -1 : seconds;
diff --git a/java/javax/servlet/WriteListener.java b/java/javax/servlet/WriteListener.java
index b25f8aef96..44c4c6d285 100644
--- a/java/javax/servlet/WriteListener.java
+++ b/java/javax/servlet/WriteListener.java
@@ -23,14 +23,12 @@ import java.io.IOException;
*
* @since Servlet 3.1
*/
-public interface WriteListener extends java.util.EventListener{
+public interface WriteListener extends java.util.EventListener {
/**
- * Invoked when it it possible to write data without blocking. The container
- * will invoke this method the first time for a request as soon as data can
- * be written. Subsequent invocations will only occur if a call to
- * {@link ServletOutputStream#isReady()} has returned false and it has since
- * become possible to write data.
+ * Invoked when it it possible to write data without blocking. The container will invoke this method the first time
+ * for a request as soon as data can be written. Subsequent invocations will only occur if a call to
+ * {@link ServletOutputStream#isReady()} has returned false and it has since become possible to write data.
*
* @throws IOException if an I/O error occurs while processing this event
*/
diff --git a/java/javax/servlet/annotation/HandlesTypes.java b/java/javax/servlet/annotation/HandlesTypes.java
index 66f8dffc38..0fa286a20a 100644
--- a/java/javax/servlet/annotation/HandlesTypes.java
+++ b/java/javax/servlet/annotation/HandlesTypes.java
@@ -22,8 +22,8 @@ import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
/**
- * This annotation is used to declare an array of application classes which are
- * passed to a {@link javax.servlet.ServletContainerInitializer}.
+ * This annotation is used to declare an array of application classes which are passed to a
+ * {@link javax.servlet.ServletContainerInitializer}.
*
* @since Servlet 3.0
*/
diff --git a/java/javax/servlet/annotation/HttpConstraint.java b/java/javax/servlet/annotation/HttpConstraint.java
index eb4ff09f99..e88eaa6701 100644
--- a/java/javax/servlet/annotation/HttpConstraint.java
+++ b/java/javax/servlet/annotation/HttpConstraint.java
@@ -24,9 +24,8 @@ import javax.servlet.annotation.ServletSecurity.EmptyRoleSemantic;
import javax.servlet.annotation.ServletSecurity.TransportGuarantee;
/**
- * This annotation represents the security constraints that are applied to all
- * requests with HTTP protocol method types that are not otherwise represented
- * by a corresponding {@link javax.servlet.annotation.HttpMethodConstraint} in a
+ * This annotation represents the security constraints that are applied to all requests with HTTP protocol method types
+ * that are not otherwise represented by a corresponding {@link javax.servlet.annotation.HttpMethodConstraint} in a
* {@link javax.servlet.annotation.ServletSecurity} annotation.
*
* @since Servlet 3.0
@@ -36,8 +35,7 @@ import javax.servlet.annotation.ServletSecurity.TransportGuarantee;
public @interface HttpConstraint {
/**
- * The EmptyRoleSemantic determines the behaviour when the rolesAllowed list
- * is empty.
+ * The EmptyRoleSemantic determines the behaviour when the rolesAllowed list is empty.
*
* @return empty role semantic
*/
@@ -51,18 +49,14 @@ public @interface HttpConstraint {
TransportGuarantee transportGuarantee() default TransportGuarantee.NONE;
/**
- * The authorized roles' names. The container may discard duplicate role
- * names during processing of the annotation. N.B. The String "*" does not
- * have a special meaning if it occurs as a role name.
- *
- * @return array of names. The array may be of zero length, in which case
- * the EmptyRoleSemantic applies; the returned value determines
- * whether access is to be permitted or denied regardless of the
- * identity and authentication state in either case, PERMIT or DENY.<br>
- * Otherwise, when the array contains one or more role names access
- * is permitted if the user a member of at least one of the named
- * roles. The EmptyRoleSemantic is not applied in this case.
+ * The authorized roles' names. The container may discard duplicate role names during processing of the annotation.
+ * N.B. The String "*" does not have a special meaning if it occurs as a role name.
*
+ * @return array of names. The array may be of zero length, in which case the EmptyRoleSemantic applies; the
+ * returned value determines whether access is to be permitted or denied regardless of the identity and
+ * authentication state in either case, PERMIT or DENY.<br>
+ * Otherwise, when the array contains one or more role names access is permitted if the user a member of
+ * at least one of the named roles. The EmptyRoleSemantic is not applied in this case.
*/
String[] rolesAllowed() default {};
diff --git a/java/javax/servlet/annotation/HttpMethodConstraint.java b/java/javax/servlet/annotation/HttpMethodConstraint.java
index e8455ec757..b553c469de 100644
--- a/java/javax/servlet/annotation/HttpMethodConstraint.java
+++ b/java/javax/servlet/annotation/HttpMethodConstraint.java
@@ -24,12 +24,10 @@ import javax.servlet.annotation.ServletSecurity.EmptyRoleSemantic;
import javax.servlet.annotation.ServletSecurity.TransportGuarantee;
/**
- * Specific security constraints can be applied to different types of request,
- * differentiated by the HTTP protocol method type by using this annotation
- * inside the {@link javax.servlet.annotation.ServletSecurity} annotation.
+ * Specific security constraints can be applied to different types of request, differentiated by the HTTP protocol
+ * method type by using this annotation inside the {@link javax.servlet.annotation.ServletSecurity} annotation.
*
* @since Servlet 3.0
- *
*/
@Retention(RetentionPolicy.RUNTIME)
@Documented
@@ -43,8 +41,7 @@ public @interface HttpMethodConstraint {
String value();
/**
- * The EmptyRoleSemantic determines the behaviour when the rolesAllowed list
- * is empty.
+ * The EmptyRoleSemantic determines the behaviour when the rolesAllowed list is empty.
*
* @return empty role semantic
*/
@@ -58,17 +55,14 @@ public @interface HttpMethodConstraint {
TransportGuarantee transportGuarantee() default TransportGuarantee.NONE;
/**
- * The authorized roles' names. The container may discard duplicate role
- * names during processing of the annotation. N.B. The String "*" does not
- * have a special meaning if it occurs as a role name.
+ * The authorized roles' names. The container may discard duplicate role names during processing of the annotation.
+ * N.B. The String "*" does not have a special meaning if it occurs as a role name.
*
- * @return array of names. The array may be of zero length, in which case
- * the EmptyRoleSemantic applies; the returned value determines
- * whether access is to be permitted or denied regardless of the
- * identity and authentication state in either case, PERMIT or DENY.<br>
- * Otherwise, when the array contains one or more role names access
- * is permitted if the user a member of at least one of the named
- * roles. The EmptyRoleSemantic is not applied in this case.
+ * @return array of names. The array may be of zero length, in which case the EmptyRoleSemantic applies; the
+ * returned value determines whether access is to be permitted or denied regardless of the identity and
+ * authentication state in either case, PERMIT or DENY.<br>
+ * Otherwise, when the array contains one or more role names access is permitted if the user a member of
+ * at least one of the named roles. The EmptyRoleSemantic is not applied in this case.
*/
String[] rolesAllowed() default {};
}
diff --git a/java/javax/servlet/annotation/MultipartConfig.java b/java/javax/servlet/annotation/MultipartConfig.java
index 70e0dcc5e5..e7df1e1230 100644
--- a/java/javax/servlet/annotation/MultipartConfig.java
+++ b/java/javax/servlet/annotation/MultipartConfig.java
@@ -22,20 +22,15 @@ import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
/**
- * This annotation is used to indicate that the {@link javax.servlet.Servlet} on
- * which it is declared expects requests to made using the {@code
+ * This annotation is used to indicate that the {@link javax.servlet.Servlet} on which it is declared expects requests
+ * to made using the {@code
* multipart/form-data} MIME type. <br>
* <br>
- *
* {@link javax.servlet.http.Part} components of a given {@code
- * multipart/form-data} request are retrieved by a Servlet annotated with
- * {@code MultipartConfig} by calling
- * {@link javax.servlet.http.HttpServletRequest#getPart} or
- * {@link javax.servlet.http.HttpServletRequest#getParts}.<br>
+ * multipart/form-data} request are retrieved by a Servlet annotated with {@code MultipartConfig} by calling
+ * {@link javax.servlet.http.HttpServletRequest#getPart} or {@link javax.servlet.http.HttpServletRequest#getParts}.<br>
* <br>
- *
* E.g. <code>@WebServlet("/upload")}</code><br>
- *
* <code>@MultipartConfig()</code> <code>public class UploadServlet extends
* HttpServlet ... } </code><br>
*
diff --git a/java/javax/servlet/annotation/ServletSecurity.java b/java/javax/servlet/annotation/ServletSecurity.java
index 356fa0b9d3..0c0b25129c 100644
--- a/java/javax/servlet/annotation/ServletSecurity.java
+++ b/java/javax/servlet/annotation/ServletSecurity.java
@@ -24,10 +24,9 @@ import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
/**
- * Declare this annotation on a {@link javax.servlet.Servlet} implementation
- * class to enforce security constraints on HTTP protocol requests.<br>
- * The container applies constraints to the URL patterns mapped to each Servlet
- * which declares this annotation.<br>
+ * Declare this annotation on a {@link javax.servlet.Servlet} implementation class to enforce security constraints on
+ * HTTP protocol requests.<br>
+ * The container applies constraints to the URL patterns mapped to each Servlet which declares this annotation.<br>
* <br>
*
* @since Servlet 3.0
@@ -39,14 +38,12 @@ import java.lang.annotation.Target;
public @interface ServletSecurity {
/**
- * Represents the two possible values of the empty role semantic, active
- * when a list of role names is empty.
+ * Represents the two possible values of the empty role semantic, active when a list of role names is empty.
*/
enum EmptyRoleSemantic {
/**
- * Access MUST be permitted, regardless of authentication state or
- * identity
+ * Access MUST be permitted, regardless of authentication state or identity
*/
PERMIT,
@@ -73,16 +70,14 @@ public @interface ServletSecurity {
}
/**
- * The default constraint to apply to requests not handled by specific
- * method constraints
+ * The default constraint to apply to requests not handled by specific method constraints
*
* @return http constraint
*/
HttpConstraint value() default @HttpConstraint;
/**
- * An array of HttpMethodConstraint objects to which the security constraint
- * will be applied
+ * An array of HttpMethodConstraint objects to which the security constraint will be applied
*
* @return array of http method constraint
*/
diff --git a/java/javax/servlet/annotation/WebFilter.java b/java/javax/servlet/annotation/WebFilter.java
index ddaa08a2b2..e47339d04a 100644
--- a/java/javax/servlet/annotation/WebFilter.java
+++ b/java/javax/servlet/annotation/WebFilter.java
@@ -27,35 +27,22 @@ import javax.servlet.DispatcherType;
/**
* The annotation used to declare a Servlet {@link javax.servlet.Filter}. <br>
* <br>
- *
- * This annotation will be processed by the container during deployment, the
- * Filter class in which it is found will be created as per the configuration
- * and applied to the URL patterns, {@link javax.servlet.Servlet}s and
+ * This annotation will be processed by the container during deployment, the Filter class in which it is found will be
+ * created as per the configuration and applied to the URL patterns, {@link javax.servlet.Servlet}s and
* {@link javax.servlet.DispatcherType}s.<br>
* <br>
- *
- * If the name attribute is not defined, the fully qualified name of the class
- * is used.<br>
+ * If the name attribute is not defined, the fully qualified name of the class is used.<br>
* <br>
- *
- * At least one URL pattern MUST be declared in either the {@code value} or
- * {@code urlPattern} attribute of the annotation, but not both.<br>
+ * At least one URL pattern MUST be declared in either the {@code value} or {@code urlPattern} attribute of the
+ * annotation, but not both.<br>
* <br>
- *
- * The {@code value} attribute is recommended for use when the URL pattern is
- * the only attribute being set, otherwise the {@code urlPattern} attribute
- * should be used.<br>
+ * The {@code value} attribute is recommended for use when the URL pattern is the only attribute being set, otherwise
+ * the {@code urlPattern} attribute should be used.<br>
* <br>
- *
- * The annotated class MUST implement {@link javax.servlet.Filter}.
- *
- * E.g.
- *
- * <code>@WebFilter("/path/*")</code><br>
+ * The annotated class MUST implement {@link javax.servlet.Filter}. E.g. <code>@WebFilter("/path/*")</code><br>
* <code>public class AnExampleFilter implements Filter { ... </code><br>
*
* @since Servlet 3.0 (Section 8.1.2)
- *
*/
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@@ -101,6 +88,7 @@ public @interface WebFilter {
* A convenience method, to allow extremely simple annotation of a class.
*
* @return array of URL patterns
+ *
* @see #urlPatterns()
*/
String[] value() default {};
@@ -113,7 +101,7 @@ public @interface WebFilter {
/**
* @return array of DispatcherTypes to which this filter applies
*/
- DispatcherType[] dispatcherTypes() default {DispatcherType.REQUEST};
+ DispatcherType[] dispatcherTypes() default { DispatcherType.REQUEST };
/**
* @return asynchronous operation supported by this Filter
diff --git a/java/javax/servlet/annotation/WebInitParam.java b/java/javax/servlet/annotation/WebInitParam.java
index fe6c784c12..6ad74c8cdd 100644
--- a/java/javax/servlet/annotation/WebInitParam.java
+++ b/java/javax/servlet/annotation/WebInitParam.java
@@ -23,12 +23,10 @@ import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
/**
- * The annotation used to declare an initialization parameter on a
- * {@link javax.servlet.Servlet} or {@link javax.servlet.Filter}, within a
- * {@link javax.servlet.annotation.WebFilter} or
+ * The annotation used to declare an initialization parameter on a {@link javax.servlet.Servlet} or
+ * {@link javax.servlet.Filter}, within a {@link javax.servlet.annotation.WebFilter} or
* {@link javax.servlet.annotation.WebServlet} annotation.<br>
* <br>
- *
* E.g.
* <code>&#064;WebServlet(name="TestServlet", urlPatterns={"/test"},initParams={&#064;WebInitParam(name="test", value="true")})
* public class TestServlet extends HttpServlet { ... </code><br>
diff --git a/java/javax/servlet/annotation/WebListener.java b/java/javax/servlet/annotation/WebListener.java
index 6ca1e7e7a9..9b1ebd7746 100644
--- a/java/javax/servlet/annotation/WebListener.java
+++ b/java/javax/servlet/annotation/WebListener.java
@@ -23,20 +23,13 @@ import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
/**
- * The annotation used to declare a listener for various types of event, in a
- * given web application context.<br>
+ * The annotation used to declare a listener for various types of event, in a given web application context.<br>
* <br>
- *
- * The class annotated MUST implement one, (or more), of the following
- * interfaces: {@link javax.servlet.http.HttpSessionAttributeListener},
- * {@link javax.servlet.http.HttpSessionListener},
- * {@link javax.servlet.ServletContextAttributeListener},
- * {@link javax.servlet.ServletContextListener},
- * {@link javax.servlet.ServletRequestAttributeListener},
- * {@link javax.servlet.ServletRequestListener} or
- * {@link javax.servlet.http.HttpSessionIdListener}
- * <br>
- *
+ * The class annotated MUST implement one, (or more), of the following interfaces:
+ * {@link javax.servlet.http.HttpSessionAttributeListener}, {@link javax.servlet.http.HttpSessionListener},
+ * {@link javax.servlet.ServletContextAttributeListener}, {@link javax.servlet.ServletContextListener},
+ * {@link javax.servlet.ServletRequestAttributeListener}, {@link javax.servlet.ServletRequestListener} or
+ * {@link javax.servlet.http.HttpSessionIdListener} <br>
* E.g. <code>@WebListener</code><br>
* <code>public TestListener implements ServletContextListener {</code><br>
*
diff --git a/java/javax/servlet/annotation/WebServlet.java b/java/javax/servlet/annotation/WebServlet.java
index 29d0b322be..e320bd81ce 100644
--- a/java/javax/servlet/annotation/WebServlet.java
+++ b/java/javax/servlet/annotation/WebServlet.java
@@ -23,35 +23,23 @@ import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
/**
- * This annotation is used to declare the configuration of a
- * {@link javax.servlet.Servlet}. <br>
- *
- * If the name attribute is not defined, the fully qualified name of the class
- * is used.<br>
+ * This annotation is used to declare the configuration of a {@link javax.servlet.Servlet}. <br>
+ * If the name attribute is not defined, the fully qualified name of the class is used.<br>
* <br>
- *
- * At least one URL pattern MUST be declared in either the {@code value} or
- * {@code urlPattern} attribute of the annotation, but not both.<br>
+ * At least one URL pattern MUST be declared in either the {@code value} or {@code urlPattern} attribute of the
+ * annotation, but not both.<br>
* <br>
- *
- * The {@code value} attribute is recommended for use when the URL pattern is
- * the only attribute being set, otherwise the {@code urlPattern} attribute
- * should be used.<br>
+ * The {@code value} attribute is recommended for use when the URL pattern is the only attribute being set, otherwise
+ * the {@code urlPattern} attribute should be used.<br>
* <br>
- *
- * The class on which this annotation is declared MUST extend
- * {@link javax.servlet.http.HttpServlet}. <br>
+ * The class on which this annotation is declared MUST extend {@link javax.servlet.http.HttpServlet}. <br>
* <br>
- *
* E.g. <code>@WebServlet("/path")}<br>
* public class TestServlet extends HttpServlet ... {</code><br>
- *
- * E.g.
- * <code>@WebServlet(name="TestServlet", urlPatterns={"/path", "/alt"}) <br>
+ * E.g. <code>@WebServlet(name="TestServlet", urlPatterns={"/path", "/alt"}) <br>
* public class TestServlet extends HttpServlet ... {</code><br>
*
* @since Servlet 3.0 (Section 8.1.1)
- *
*/
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@@ -67,6 +55,7 @@ public @interface WebServlet {
* A convenience method, to allow extremely simple annotation of a class.
*
* @return array of URL patterns
+ *
* @see #urlPatterns()
*/
String[] value() default {};
diff --git a/java/javax/servlet/descriptor/JspConfigDescriptor.java b/java/javax/servlet/descriptor/JspConfigDescriptor.java
index 7ad4a26a85..3fab776ad4 100644
--- a/java/javax/servlet/descriptor/JspConfigDescriptor.java
+++ b/java/javax/servlet/descriptor/JspConfigDescriptor.java
@@ -19,27 +19,24 @@ package javax.servlet.descriptor;
import java.util.Collection;
/**
- * This interface exposes the JSP specific configuration information obtain ed
- * from the deployment descriptors. It is primarily provided so that JSP
- * implementations do not have to parse deployment descriptors.
+ * This interface exposes the JSP specific configuration information obtain ed from the deployment descriptors. It is
+ * primarily provided so that JSP implementations do not have to parse deployment descriptors.
*
* @since Servlet 3.0
*/
public interface JspConfigDescriptor {
/**
- * Provide the set of tag library descriptors obtained from the
- * <jsp-config> elements in the web application's deployment
- * descriptors.
+ * Provide the set of tag library descriptors obtained from the <jsp-config> elements in the web application's
+ * deployment descriptors.
*
* @return the tag library descriptors
*/
Collection<TaglibDescriptor> getTaglibs();
/**
- * Provide the set of JSP property groups obtained from the
- * <jsp-config> elements in the web application's deployment
- * descriptors.
+ * Provide the set of JSP property groups obtained from the <jsp-config> elements in the web application's
+ * deployment descriptors.
*
* @return the JSP property groups
*/
diff --git a/java/javax/servlet/descriptor/JspPropertyGroupDescriptor.java b/java/javax/servlet/descriptor/JspPropertyGroupDescriptor.java
index 4d1f1bcb03..a399295a6b 100644
--- a/java/javax/servlet/descriptor/JspPropertyGroupDescriptor.java
+++ b/java/javax/servlet/descriptor/JspPropertyGroupDescriptor.java
@@ -56,8 +56,7 @@ public interface JspPropertyGroupDescriptor {
/**
* Should the JSPs in this group be treated as JSP documents?
*
- * @return {@code true} if the JSPs should be treated as JSP documents,
- * otherwise {@code false}
+ * @return {@code true} if the JSPs should be treated as JSP documents, otherwise {@code false}
*/
String getIsXml();
@@ -76,20 +75,16 @@ public interface JspPropertyGroupDescriptor {
Collection<String> getIncludeCodas();
/**
- * Is the deferred El syntax <code>#{...}</code> allowed to be used as a
- * literal in this group?
+ * Is the deferred El syntax <code>#{...}</code> allowed to be used as a literal in this group?
*
- * @return {@code true} if the deferred EL syntax is allowed to be used as
- * a literal, otherwise {@code false}
+ * @return {@code true} if the deferred EL syntax is allowed to be used as a literal, otherwise {@code false}
*/
String getDeferredSyntaxAllowedAsLiteral();
/**
- * Should the JSPs in this group have template text that only contains
- * whitespace removed?
+ * Should the JSPs in this group have template text that only contains whitespace removed?
*
- * @return {@code true} if the whitespace be removed, otherwise
- * {@code false}
+ * @return {@code true} if the whitespace be removed, otherwise {@code false}
*/
String getTrimDirectiveWhitespaces();
@@ -108,11 +103,10 @@ public interface JspPropertyGroupDescriptor {
String getBuffer();
/**
- * Should an error be raised at translation time for a page in this group if
- * the page contains a reference (e.g. a tag) to a undeclared namespace.
+ * Should an error be raised at translation time for a page in this group if the page contains a reference (e.g. a
+ * tag) to a undeclared namespace.
*
- * @return {@code true} if an error should be raised, otherwise
- * {@code false}
+ * @return {@code true} if an error should be raised, otherwise {@code false}
*/
String getErrorOnUndeclaredNamespace();
}
diff --git a/java/javax/servlet/http/Cookie.java b/java/javax/servlet/http/Cookie.java
index 23595f0b3e..99137476d5 100644
--- a/java/javax/servlet/http/Cookie.java
+++ b/java/javax/servlet/http/Cookie.java
@@ -61,8 +61,8 @@ public class Cookie implements Cloneable, Serializable {
if (System.getSecurityManager() == null) {
strictServletCompliance = Boolean.getBoolean("org.apache.catalina.STRICT_SERVLET_COMPLIANCE");
propStrictNaming = System.getProperty("org.apache.tomcat.util.http.ServerCookie.STRICT_NAMING");
- propFwdSlashIsSeparator = System
- .getProperty("org.apache.tomcat.util.http.ServerCookie.FWD_SLASH_IS_SEPARATOR");
+ propFwdSlashIsSeparator =
+ System.getProperty("org.apache.tomcat.util.http.ServerCookie.FWD_SLASH_IS_SEPARATOR");
} else {
strictServletCompliance = AccessController
.doPrivileged((PrivilegedAction<Boolean>) () -> Boolean
diff --git a/java/javax/servlet/http/HttpServlet.java b/java/javax/servlet/http/HttpServlet.java
index 84e8e1971c..7cdc694e01 100644
--- a/java/javax/servlet/http/HttpServlet.java
+++ b/java/javax/servlet/http/HttpServlet.java
@@ -82,9 +82,8 @@ public abstract class HttpServlet extends GenericServlet {
private static final String LSTRING_FILE = "javax.servlet.http.LocalStrings";
private static final ResourceBundle lStrings = ResourceBundle.getBundle(LSTRING_FILE);
- private static final List<String> SENSITIVE_HTTP_HEADERS = Arrays.asList("authorization", "cookie", "x-forwarded",
- "forwarded", "proxy-authorization");
-
+ private static final List<String> SENSITIVE_HTTP_HEADERS =
+ Arrays.asList("authorization", "cookie", "x-forwarded", "forwarded", "proxy-authorization");
/**
@@ -353,8 +352,8 @@ public abstract class HttpServlet extends GenericServlet {
clazz = Class.forName("org.apache.catalina.connector.RequestFacade");
Method getAllowTrace = clazz.getMethod("getAllowTrace", (Class<?>[]) null);
ALLOW_TRACE = ((Boolean) getAllowTrace.invoke(req, (Object[]) null)).booleanValue();
- } catch (ClassNotFoundException | NoSuchMethodException | SecurityException | IllegalAccessException
- | IllegalArgumentException | InvocationTargetException e) {
+ } catch (ClassNotFoundException | NoSuchMethodException | SecurityException | IllegalAccessException |
+ IllegalArgumentException | InvocationTargetException e) {
// Ignore. Not running on Tomcat. TRACE is always allowed.
}
// End of Tomcat specific hack
@@ -444,8 +443,8 @@ public abstract class HttpServlet extends GenericServlet {
int responseLength;
String CRLF = "\r\n";
- StringBuilder buffer = new StringBuilder("TRACE ").append(req.getRequestURI()).append(' ')
- .append(req.getProtocol());
+ StringBuilder buffer =
+ new StringBuilder("TRACE ").append(req.getRequestURI()).append(' ').append(req.getProtocol());
Enumeration<String> reqHeaderNames = req.getHeaderNames();
diff --git a/java/javax/servlet/http/HttpServletRequest.java b/java/javax/servlet/http/HttpServletRequest.java
index 11e1a445c1..0028b9a1af 100644
--- a/java/javax/servlet/http/HttpServletRequest.java
+++ b/java/javax/servlet/http/HttpServletRequest.java
@@ -522,7 +522,7 @@ public interface HttpServletRequest extends ServletRequest {
*
* @since Servlet 4.0
*/
- default Map<String, String> getTrailerFields() {
+ default Map<String,String> getTrailerFields() {
return Collections.emptyMap();
}
diff --git a/java/javax/servlet/http/HttpServletRequestWrapper.java b/java/javax/servlet/http/HttpServletRequestWrapper.java
index be7e6df651..828e7d79b8 100644
--- a/java/javax/servlet/http/HttpServletRequestWrapper.java
+++ b/java/javax/servlet/http/HttpServletRequestWrapper.java
@@ -375,7 +375,7 @@ public class HttpServletRequestWrapper extends ServletRequestWrapper implements
* @since Servlet 4.0
*/
@Override
- public Map<String, String> getTrailerFields() {
+ public Map<String,String> getTrailerFields() {
return this._getHttpServletRequest().getTrailerFields();
}
diff --git a/java/javax/servlet/http/HttpServletResponse.java b/java/javax/servlet/http/HttpServletResponse.java
index 10dcc9f8ca..f779b4fc53 100644
--- a/java/javax/servlet/http/HttpServletResponse.java
+++ b/java/javax/servlet/http/HttpServletResponse.java
@@ -307,7 +307,7 @@ public interface HttpServletResponse extends ServletResponse {
*
* @since Servlet 4.0
*/
- default void setTrailerFields(Supplier<Map<String, String>> supplier) {
+ default void setTrailerFields(Supplier<Map<String,String>> supplier) {
// NO-OP
}
@@ -319,7 +319,7 @@ public interface HttpServletResponse extends ServletResponse {
*
* @since Servlet 4.0
*/
- default Supplier<Map<String, String>> getTrailerFields() {
+ default Supplier<Map<String,String>> getTrailerFields() {
return null;
}
diff --git a/java/javax/servlet/http/HttpServletResponseWrapper.java b/java/javax/servlet/http/HttpServletResponseWrapper.java
index 71730815f0..4999e12f9c 100644
--- a/java/javax/servlet/http/HttpServletResponseWrapper.java
+++ b/java/javax/servlet/http/HttpServletResponseWrapper.java
@@ -261,7 +261,7 @@ public class HttpServletResponseWrapper extends ServletResponseWrapper implement
* @since Servlet 4.0
*/
@Override
- public void setTrailerFields(Supplier<Map<String, String>> supplier) {
+ public void setTrailerFields(Supplier<Map<String,String>> supplier) {
this._getHttpServletResponse().setTrailerFields(supplier);
}
@@ -274,7 +274,7 @@ public class HttpServletResponseWrapper extends ServletResponseWrapper implement
* @since Servlet 4.0
*/
@Override
- public Supplier<Map<String, String>> getTrailerFields() {
+ public Supplier<Map<String,String>> getTrailerFields() {
return this._getHttpServletResponse().getTrailerFields();
}
}
diff --git a/java/javax/servlet/http/HttpSession.java b/java/javax/servlet/http/HttpSession.java
index a571e92ff8..c77b37f45b 100644
--- a/java/javax/servlet/http/HttpSession.java
+++ b/java/javax/servlet/http/HttpSession.java
@@ -127,7 +127,8 @@ public interface HttpSession {
* @deprecated As of Version 2.1, this method is deprecated and has no replacement. It will be removed in a future
* version of the Java Servlet API.
*/
- @Deprecated HttpSessionContext getSessionContext();
+ @Deprecated
+ HttpSessionContext getSessionContext();
/**
* Returns the object bound with the specified name in this session, or <code>null</code> if no object is bound
@@ -150,7 +151,8 @@ public interface HttpSession {
*
* @deprecated As of Version 2.2, this method is replaced by {@link #getAttribute}.
*/
- @Deprecated Object getValue(String name);
+ @Deprecated
+ Object getValue(String name);
/**
* Returns an <code>Enumeration</code> of <code>String</code> objects containing the names of all the objects bound
@@ -170,7 +172,8 @@ public interface HttpSession {
*
* @deprecated As of Version 2.2, this method is replaced by {@link #getAttributeNames}
*/
- @Deprecated String[] getValueNames();
+ @Deprecated
+ String[] getValueNames();
/**
* Binds an object to this session, using the name specified. If an object of the same name is already bound to the
@@ -201,7 +204,8 @@ public interface HttpSession {
*
* @deprecated As of Version 2.2, this method is replaced by {@link #setAttribute}
*/
- @Deprecated void putValue(String name, Object value);
+ @Deprecated
+ void putValue(String name, Object value);
/**
* Removes the object bound with the specified name from this session. If the session does not have an object bound
@@ -224,7 +228,8 @@ public interface HttpSession {
*
* @deprecated As of Version 2.2, this method is replaced by {@link #removeAttribute}
*/
- @Deprecated void removeValue(String name);
+ @Deprecated
+ void removeValue(String name);
/**
* Invalidates this session then unbinds any objects bound to it.
diff --git a/java/javax/servlet/http/HttpSessionContext.java b/java/javax/servlet/http/HttpSessionContext.java
index f0c84e85df..e2114c473a 100644
--- a/java/javax/servlet/http/HttpSessionContext.java
+++ b/java/javax/servlet/http/HttpSessionContext.java
@@ -41,7 +41,8 @@ public interface HttpSessionContext {
* @deprecated As of Java Servlet API 2.1 with no replacement. This method must return null and will be removed in a
* future version of this API.
*/
- @Deprecated HttpSession getSession(String sessionId);
+ @Deprecated
+ HttpSession getSession(String sessionId);
/**
* Do not use.
@@ -51,5 +52,6 @@ public interface HttpSessionContext {
* @deprecated As of Java Servlet API 2.1 with no replacement. This method must return an empty
* <code>Enumeration</code> and will be removed in a future version of this API.
*/
- @Deprecated Enumeration<String> getIds();
+ @Deprecated
+ Enumeration<String> getIds();
}
diff --git a/java/javax/servlet/http/HttpUtils.java b/java/javax/servlet/http/HttpUtils.java
index cffccd9fcf..5ddebaaa04 100644
--- a/java/javax/servlet/http/HttpUtils.java
+++ b/java/javax/servlet/http/HttpUtils.java
@@ -61,14 +61,14 @@ public class HttpUtils {
*
* @exception IllegalArgumentException if the query string is invalid
*/
- public static Hashtable<String, String[]> parseQueryString(String s) {
+ public static Hashtable<String,String[]> parseQueryString(String s) {
String valArray[] = null;
if (s == null) {
throw new IllegalArgumentException();
}
- Hashtable<String, String[]> ht = new Hashtable<>();
+ Hashtable<String,String[]> ht = new Hashtable<>();
StringBuilder sb = new StringBuilder();
StringTokenizer st = new StringTokenizer(s, "&");
while (st.hasMoreTokens()) {
@@ -114,7 +114,7 @@ public class HttpUtils {
*
* @exception IllegalArgumentException if the data sent by the POST method is invalid
*/
- public static Hashtable<String, String[]> parsePostData(int len, ServletInputStream in) {
+ public static Hashtable<String,String[]> parsePostData(int len, ServletInputStream in) {
// XXX
// should a length of 0 be an IllegalArgumentException
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@tomcat.apache.org
For additional commands, e-mail: dev-help@tomcat.apache.org
[tomcat] 06/08: Code clean-up - no functional change
Posted by ma...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
markt pushed a commit to branch 9.0.x
in repository https://gitbox.apache.org/repos/asf/tomcat.git
commit cf8605a1aaeb1f377ca4dbd89343a6d3f133cec4
Author: Mark Thomas <ma...@apache.org>
AuthorDate: Fri Apr 14 11:37:11 2023 +0100
Code clean-up - no functional change
---
java/javax/ejb/EJB.java | 7 ++++++-
java/javax/mail/Session.java | 1 +
java/javax/mail/internet/MimeMessage.java | 2 ++
java/javax/persistence/PersistenceContext.java | 6 +++++-
java/javax/persistence/PersistenceProperty.java | 1 +
java/javax/persistence/PersistenceUnit.java | 3 ++-
java/javax/transaction/Synchronization.java | 1 +
java/javax/transaction/Transaction.java | 12 ++++--------
java/javax/transaction/TransactionManager.java | 9 +++------
java/javax/transaction/UserTransaction.java | 6 ++----
java/javax/xml/ws/WebServiceRef.java | 6 +++++-
11 files changed, 32 insertions(+), 22 deletions(-)
diff --git a/java/javax/ejb/EJB.java b/java/javax/ejb/EJB.java
index bf37ba8b14..46b0aa23f6 100644
--- a/java/javax/ejb/EJB.java
+++ b/java/javax/ejb/EJB.java
@@ -21,15 +21,20 @@ import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
-@Target({ElementType.METHOD, ElementType.TYPE, ElementType.FIELD})
+@Target({ ElementType.METHOD, ElementType.TYPE, ElementType.FIELD })
@Retention(RetentionPolicy.RUNTIME)
public @interface EJB {
String name() default "";
+
String description() default "";
+
@SuppressWarnings("rawtypes") // Can't use Class<?> because API needs to match specification
Class beanInterface() default java.lang.Object.class;
+
String beanName() default "";
+
String mappedName() default "";
+
String lookup() default "";
}
diff --git a/java/javax/mail/Session.java b/java/javax/mail/Session.java
index a95a11b574..b409fa4110 100644
--- a/java/javax/mail/Session.java
+++ b/java/javax/mail/Session.java
@@ -23,6 +23,7 @@ public class Session {
public static Session getInstance(Properties props, Authenticator auth) {
return null;
}
+
public static Session getInstance(Properties props) {
return null;
}
diff --git a/java/javax/mail/internet/MimeMessage.java b/java/javax/mail/internet/MimeMessage.java
index 25877302af..4945ffd8af 100644
--- a/java/javax/mail/internet/MimeMessage.java
+++ b/java/javax/mail/internet/MimeMessage.java
@@ -23,9 +23,11 @@ public class MimeMessage implements MimePart {
public MimeMessage(Session session) {
// Dummy implementation
}
+
public void setFrom(InternetAddress from) {
// Dummy implementation
}
+
public void setSubject(String subject) {
// Dummy implementation
}
diff --git a/java/javax/persistence/PersistenceContext.java b/java/javax/persistence/PersistenceContext.java
index 428fa09cff..eb65739aef 100644
--- a/java/javax/persistence/PersistenceContext.java
+++ b/java/javax/persistence/PersistenceContext.java
@@ -21,13 +21,17 @@ import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
-@Target({ElementType.TYPE, ElementType.METHOD, ElementType.FIELD})
+@Target({ ElementType.TYPE, ElementType.METHOD, ElementType.FIELD })
@Retention(RetentionPolicy.RUNTIME)
public @interface PersistenceContext {
String name() default "";
+
String unitName() default "";
+
PersistenceContextType type() default PersistenceContextType.TRANSACTION;
+
PersistenceProperty[] properties() default {};
+
SynchronizationType synchronization() default SynchronizationType.SYNCHRONIZED;
}
diff --git a/java/javax/persistence/PersistenceProperty.java b/java/javax/persistence/PersistenceProperty.java
index 6379071b11..5a8643482d 100644
--- a/java/javax/persistence/PersistenceProperty.java
+++ b/java/javax/persistence/PersistenceProperty.java
@@ -25,5 +25,6 @@ import java.lang.annotation.Target;
public @interface PersistenceProperty {
String name();
+
String value();
}
diff --git a/java/javax/persistence/PersistenceUnit.java b/java/javax/persistence/PersistenceUnit.java
index 54f5150c4b..5024f4159e 100644
--- a/java/javax/persistence/PersistenceUnit.java
+++ b/java/javax/persistence/PersistenceUnit.java
@@ -21,10 +21,11 @@ import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
-@Target({ElementType.TYPE, ElementType.METHOD, ElementType.FIELD})
+@Target({ ElementType.TYPE, ElementType.METHOD, ElementType.FIELD })
@Retention(RetentionPolicy.RUNTIME)
public @interface PersistenceUnit {
String name() default "";
+
String unitName() default "";
}
diff --git a/java/javax/transaction/Synchronization.java b/java/javax/transaction/Synchronization.java
index e187126363..9efecfca18 100644
--- a/java/javax/transaction/Synchronization.java
+++ b/java/javax/transaction/Synchronization.java
@@ -18,5 +18,6 @@ package javax.transaction;
public interface Synchronization {
void beforeCompletion();
+
void afterCompletion(int status);
}
diff --git a/java/javax/transaction/Transaction.java b/java/javax/transaction/Transaction.java
index fb449dbe13..934b306390 100644
--- a/java/javax/transaction/Transaction.java
+++ b/java/javax/transaction/Transaction.java
@@ -20,20 +20,16 @@ import javax.transaction.xa.XAResource;
public interface Transaction {
- void commit() throws RollbackException, HeuristicMixedException,
- HeuristicRollbackException, SecurityException,
+ void commit() throws RollbackException, HeuristicMixedException, HeuristicRollbackException, SecurityException,
IllegalStateException, SystemException;
- boolean delistResource(XAResource xaRes, int flag)
- throws IllegalStateException, SystemException;
+ boolean delistResource(XAResource xaRes, int flag) throws IllegalStateException, SystemException;
- boolean enlistResource(XAResource xaRes)
- throws RollbackException, IllegalStateException, SystemException;
+ boolean enlistResource(XAResource xaRes) throws RollbackException, IllegalStateException, SystemException;
int getStatus() throws SystemException;
- void registerSynchronization(Synchronization sync)
- throws RollbackException, IllegalStateException, SystemException;
+ void registerSynchronization(Synchronization sync) throws RollbackException, IllegalStateException, SystemException;
void rollback() throws IllegalStateException, SystemException;
diff --git a/java/javax/transaction/TransactionManager.java b/java/javax/transaction/TransactionManager.java
index 450de6eb47..22364e505e 100644
--- a/java/javax/transaction/TransactionManager.java
+++ b/java/javax/transaction/TransactionManager.java
@@ -19,19 +19,16 @@ package javax.transaction;
public interface TransactionManager {
void begin() throws NotSupportedException, SystemException;
- void commit() throws RollbackException, HeuristicMixedException,
- HeuristicRollbackException, SecurityException,
+ void commit() throws RollbackException, HeuristicMixedException, HeuristicRollbackException, SecurityException,
IllegalStateException, SystemException;
int getStatus() throws SystemException;
Transaction getTransaction() throws SystemException;
- void resume(Transaction tobj) throws InvalidTransactionException,
- IllegalStateException, SystemException;
+ void resume(Transaction tobj) throws InvalidTransactionException, IllegalStateException, SystemException;
- void rollback()
- throws IllegalStateException, SecurityException, SystemException;
+ void rollback() throws IllegalStateException, SecurityException, SystemException;
void setRollbackOnly() throws IllegalStateException, SystemException;
diff --git a/java/javax/transaction/UserTransaction.java b/java/javax/transaction/UserTransaction.java
index b0cce4a244..af11b68701 100644
--- a/java/javax/transaction/UserTransaction.java
+++ b/java/javax/transaction/UserTransaction.java
@@ -19,12 +19,10 @@ package javax.transaction;
public interface UserTransaction {
void begin() throws NotSupportedException, SystemException;
- void commit() throws RollbackException, HeuristicMixedException,
- HeuristicRollbackException, SecurityException,
+ void commit() throws RollbackException, HeuristicMixedException, HeuristicRollbackException, SecurityException,
IllegalStateException, SystemException;
- void rollback()
- throws IllegalStateException, SecurityException, SystemException;
+ void rollback() throws IllegalStateException, SecurityException, SystemException;
void setRollbackOnly() throws IllegalStateException, SystemException;
diff --git a/java/javax/xml/ws/WebServiceRef.java b/java/javax/xml/ws/WebServiceRef.java
index 8106123a99..5edcbe4324 100644
--- a/java/javax/xml/ws/WebServiceRef.java
+++ b/java/javax/xml/ws/WebServiceRef.java
@@ -21,15 +21,19 @@ import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
-@Target({ElementType.TYPE, ElementType.METHOD, ElementType.FIELD})
+@Target({ ElementType.TYPE, ElementType.METHOD, ElementType.FIELD })
@Retention(RetentionPolicy.RUNTIME)
public @interface WebServiceRef {
String name() default "";
+
@SuppressWarnings("rawtypes") // Can't use Class<?> because API needs to match specification
Class type() default java.lang.Object.class;
+
@SuppressWarnings("rawtypes") // Can't use Class<?> because API needs to match specification
Class value() default java.lang.Object.class;
+
String wsdlLocation() default "";
+
String mappedName() default "";
}
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@tomcat.apache.org
For additional commands, e-mail: dev-help@tomcat.apache.org
[tomcat] 01/08: Code clean-up - no functional change
Posted by ma...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
markt pushed a commit to branch 9.0.x
in repository https://gitbox.apache.org/repos/asf/tomcat.git
commit 3b1b9412dcbefdcd0f1e7669227b80ea2c7492da
Author: Mark Thomas <ma...@apache.org>
AuthorDate: Fri Apr 14 11:36:44 2023 +0100
Code clean-up - no functional change
---
java/javax/servlet/jsp/ErrorData.java | 21 +-
java/javax/servlet/jsp/HttpJspPage.java | 37 +-
java/javax/servlet/jsp/JspApplicationContext.java | 25 +-
java/javax/servlet/jsp/JspContext.java | 206 +++++------
java/javax/servlet/jsp/JspEngineInfo.java | 17 +-
java/javax/servlet/jsp/JspException.java | 42 +--
java/javax/servlet/jsp/JspFactory.java | 81 ++---
java/javax/servlet/jsp/JspPage.java | 67 ++--
java/javax/servlet/jsp/JspTagException.java | 50 ++-
java/javax/servlet/jsp/JspWriter.java | 363 ++++++++------------
java/javax/servlet/jsp/PageContext.java | 377 ++++++++-------------
java/javax/servlet/jsp/SkipPageException.java | 28 +-
java/javax/servlet/jsp/el/ELException.java | 16 +-
java/javax/servlet/jsp/el/ELParseException.java | 9 +-
java/javax/servlet/jsp/el/Expression.java | 35 +-
java/javax/servlet/jsp/el/ExpressionEvaluator.java | 105 +++---
java/javax/servlet/jsp/el/FunctionMapper.java | 20 +-
.../servlet/jsp/el/ImplicitObjectELResolver.java | 29 +-
.../servlet/jsp/el/ScopedAttributeELResolver.java | 9 +-
java/javax/servlet/jsp/el/VariableResolver.java | 25 +-
java/javax/servlet/jsp/tagext/BodyContent.java | 46 +--
java/javax/servlet/jsp/tagext/BodyTag.java | 147 ++++----
java/javax/servlet/jsp/tagext/BodyTagSupport.java | 41 ++-
.../servlet/jsp/tagext/DynamicAttributes.java | 29 +-
java/javax/servlet/jsp/tagext/FunctionInfo.java | 7 +-
java/javax/servlet/jsp/tagext/IterationTag.java | 118 +++----
java/javax/servlet/jsp/tagext/JspFragment.java | 64 ++--
java/javax/servlet/jsp/tagext/JspIdConsumer.java | 3 +-
java/javax/servlet/jsp/tagext/JspTag.java | 3 +-
java/javax/servlet/jsp/tagext/PageData.java | 15 +-
java/javax/servlet/jsp/tagext/SimpleTag.java | 132 +++-----
.../javax/servlet/jsp/tagext/SimpleTagSupport.java | 126 +++----
java/javax/servlet/jsp/tagext/Tag.java | 254 ++++++--------
java/javax/servlet/jsp/tagext/TagAdapter.java | 81 ++---
.../javax/servlet/jsp/tagext/TagAttributeInfo.java | 126 +++----
java/javax/servlet/jsp/tagext/TagData.java | 56 ++-
java/javax/servlet/jsp/tagext/TagExtraInfo.java | 92 +++--
java/javax/servlet/jsp/tagext/TagFileInfo.java | 35 +-
java/javax/servlet/jsp/tagext/TagInfo.java | 273 ++++++---------
java/javax/servlet/jsp/tagext/TagLibraryInfo.java | 97 +++---
.../servlet/jsp/tagext/TagLibraryValidator.java | 110 +++---
java/javax/servlet/jsp/tagext/TagSupport.java | 87 ++---
java/javax/servlet/jsp/tagext/TagVariableInfo.java | 40 +--
java/javax/servlet/jsp/tagext/TryCatchFinally.java | 61 ++--
.../servlet/jsp/tagext/ValidationMessage.java | 35 +-
java/javax/servlet/jsp/tagext/VariableInfo.java | 128 +++----
46 files changed, 1526 insertions(+), 2242 deletions(-)
diff --git a/java/javax/servlet/jsp/ErrorData.java b/java/javax/servlet/jsp/ErrorData.java
index cc625c6aef..4dc5ca5a02 100644
--- a/java/javax/servlet/jsp/ErrorData.java
+++ b/java/javax/servlet/jsp/ErrorData.java
@@ -17,12 +17,12 @@
package javax.servlet.jsp;
/**
- * Contains information about an error, for error pages. The information
- * contained in this instance is meaningless if not used in the context of an
- * error page. To indicate a JSP is an error page, the page author must set the
+ * Contains information about an error, for error pages. The information contained in this instance is meaningless if
+ * not used in the context of an error page. To indicate a JSP is an error page, the page author must set the
* isErrorPage attribute of the page directive to "true".
*
* @see PageContext#getErrorData
+ *
* @since JSP 2.0
*/
public final class ErrorData {
@@ -35,17 +35,12 @@ public final class ErrorData {
/**
* Creates a new ErrorData object.
*
- * @param throwable
- * The Throwable that is the cause of the error
- * @param statusCode
- * The status code of the error
- * @param uri
- * The request URI
- * @param servletName
- * The name of the servlet invoked
+ * @param throwable The Throwable that is the cause of the error
+ * @param statusCode The status code of the error
+ * @param uri The request URI
+ * @param servletName The name of the servlet invoked
*/
- public ErrorData(Throwable throwable, int statusCode, String uri,
- String servletName) {
+ public ErrorData(Throwable throwable, int statusCode, String uri, String servletName) {
this.throwable = throwable;
this.statusCode = statusCode;
this.uri = uri;
diff --git a/java/javax/servlet/jsp/HttpJspPage.java b/java/javax/servlet/jsp/HttpJspPage.java
index 322bcb67ae..ddebf948b6 100644
--- a/java/javax/servlet/jsp/HttpJspPage.java
+++ b/java/javax/servlet/jsp/HttpJspPage.java
@@ -23,13 +23,11 @@ import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
/**
- * The HttpJspPage interface describes the interaction that a JSP Page
- * Implementation Class must satisfy when using the HTTP protocol.
- *
+ * The HttpJspPage interface describes the interaction that a JSP Page Implementation Class must satisfy when using the
+ * HTTP protocol.
* <p>
- * The behaviour is identical to that of the JspPage, except for the signature
- * of the _jspService method, which is now expressible in the Java type
- * system and included explicitly in the interface.
+ * The behaviour is identical to that of the JspPage, except for the signature of the _jspService method, which is now
+ * expressible in the Java type system and included explicitly in the interface.
*
* @see JspPage
*/
@@ -37,24 +35,19 @@ import javax.servlet.http.HttpServletResponse;
public interface HttpJspPage extends JspPage {
/**
- * The _jspService()method corresponds to the body of the JSP page. This
- * method is defined automatically by the JSP container and should never
- * be defined by the JSP page author.
+ * The _jspService()method corresponds to the body of the JSP page. This method is defined automatically by the JSP
+ * container and should never be defined by the JSP page author.
* <p>
- * If a superclass is specified using the extends attribute, that
- * superclass may choose to perform some actions in its service() method
- * before or after calling the _jspService() method. See using the extends
- * attribute in the JSP_Engine chapter of the JSP specification.
+ * If a superclass is specified using the extends attribute, that superclass may choose to perform some actions in
+ * its service() method before or after calling the _jspService() method. See using the extends attribute in the
+ * JSP_Engine chapter of the JSP specification.
*
- * @param request Provides client request information to the JSP.
+ * @param request Provides client request information to the JSP.
* @param response Assists the JSP in sending a response to the client.
- * @throws ServletException Thrown if an error occurred during the
- * processing of the JSP and that the container should take
- * appropriate action to clean up the request.
- * @throws IOException Thrown if an error occurred while writing the
- * response for this page.
+ *
+ * @throws ServletException Thrown if an error occurred during the processing of the JSP and that the container
+ * should take appropriate action to clean up the request.
+ * @throws IOException Thrown if an error occurred while writing the response for this page.
*/
- void _jspService(HttpServletRequest request,
- HttpServletResponse response)
- throws ServletException, IOException;
+ void _jspService(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException;
}
diff --git a/java/javax/servlet/jsp/JspApplicationContext.java b/java/javax/servlet/jsp/JspApplicationContext.java
index 6220c8ccb1..92a793a7d8 100644
--- a/java/javax/servlet/jsp/JspApplicationContext.java
+++ b/java/javax/servlet/jsp/JspApplicationContext.java
@@ -30,12 +30,11 @@ import javax.el.ExpressionFactory;
public interface JspApplicationContext {
/**
- * Registers an <code>ELContextListener</code> that will be notified
- * whenever a new <code>ELContext</code> is created.
+ * Registers an <code>ELContextListener</code> that will be notified whenever a new <code>ELContext</code> is
+ * created.
* <p>
- * At the very least, any <code>ELContext</code> instantiated will have
- * reference to the <code>JspContext</code> under
- * <code>JspContext.class</code>.
+ * At the very least, any <code>ELContext</code> instantiated will have reference to the <code>JspContext</code>
+ * under <code>JspContext.class</code>.
*
* @param listener The listener to add
*/
@@ -43,8 +42,8 @@ public interface JspApplicationContext {
/**
* <p>
- * Adds an <code>ELResolver</code> to the chain of EL variable and property
- * management within JSP pages and Tag files.
+ * Adds an <code>ELResolver</code> to the chain of EL variable and property management within JSP pages and Tag
+ * files.
* </p>
* <p>
* JSP has a default set of ELResolvers to chain for all EL evaluation:
@@ -59,18 +58,16 @@ public interface JspApplicationContext {
* <li><code>ScopedAttributeELResolver</code></li>
* </ul>
*
- * @param resolver
- * an additional resolver
- * @throws IllegalStateException
- * if called after the application's
- * <code>ServletContextListeners</code> have been initialized.
+ * @param resolver an additional resolver
+ *
+ * @throws IllegalStateException if called after the application's <code>ServletContextListeners</code> have been
+ * initialized.
*/
void addELResolver(ELResolver resolver);
/**
* <p>
- * Returns the JSP container's <code>ExpressionFactory</code> implementation
- * for EL use.
+ * Returns the JSP container's <code>ExpressionFactory</code> implementation for EL use.
* </p>
*
* @return an <code>ExpressionFactory</code> implementation
diff --git a/java/javax/servlet/jsp/JspContext.java b/java/javax/servlet/jsp/JspContext.java
index f117784749..84f9844580 100644
--- a/java/javax/servlet/jsp/JspContext.java
+++ b/java/javax/servlet/jsp/JspContext.java
@@ -22,46 +22,33 @@ import javax.el.ELContext;
/**
* <p>
- * <code>JspContext</code> serves as the base class for the
- * PageContext class and abstracts all information that is not specific
- * to servlets. This allows for Simple Tag Extensions to be used
- * outside of the context of a request/response Servlet.
+ * <code>JspContext</code> serves as the base class for the PageContext class and abstracts all information that is not
+ * specific to servlets. This allows for Simple Tag Extensions to be used outside of the context of a request/response
+ * Servlet.
* <p>
- * The JspContext provides a number of facilities to the
- * page/component author and page implementor, including:
+ * The JspContext provides a number of facilities to the page/component author and page implementor, including:
* <ul>
* <li>a single API to manage the various scoped namespaces
* <li>a mechanism to obtain the JspWriter for output
- * <li>a mechanism to expose page directive attributes to the
- * scripting environment
+ * <li>a mechanism to expose page directive attributes to the scripting environment
* </ul>
- *
- * <p><B>Methods Intended for Container Generated Code</B>
* <p>
- * The following methods enable the <B>management of nested</B> JspWriter
- * streams to implement Tag Extensions: <code>pushBody()</code> and
- * <code>popBody()</code>
- *
- * <p><B>Methods Intended for JSP authors</B>
+ * <B>Methods Intended for Container Generated Code</B>
* <p>
- * Some methods provide <B>uniform access</B> to the diverse objects
- * representing scopes.
- * The implementation must use the underlying machinery
- * corresponding to that scope, so information can be passed back and
- * forth between the underlying environment (e.g. Servlets) and JSP pages.
- * The methods are:
- * <code>setAttribute()</code>, <code>getAttribute()</code>,
- * <code>findAttribute()</code>, <code>removeAttribute()</code>,
- * <code>getAttributesScope()</code> and
- * <code>getAttributeNamesInScope()</code>.
- *
+ * The following methods enable the <B>management of nested</B> JspWriter streams to implement Tag Extensions:
+ * <code>pushBody()</code> and <code>popBody()</code>
* <p>
- * The following methods provide <B>convenient access</B> to implicit objects:
- * <code>getOut()</code>
- *
+ * <B>Methods Intended for JSP authors</B>
* <p>
- * The following methods provide <B>programmatic access</b> to the
- * Expression Language evaluator:
+ * Some methods provide <B>uniform access</B> to the diverse objects representing scopes. The implementation must use
+ * the underlying machinery corresponding to that scope, so information can be passed back and forth between the
+ * underlying environment (e.g. Servlets) and JSP pages. The methods are: <code>setAttribute()</code>,
+ * <code>getAttribute()</code>, <code>findAttribute()</code>, <code>removeAttribute()</code>,
+ * <code>getAttributesScope()</code> and <code>getAttributeNamesInScope()</code>.
+ * <p>
+ * The following methods provide <B>convenient access</B> to implicit objects: <code>getOut()</code>
+ * <p>
+ * The following methods provide <B>programmatic access</b> to the Expression Language evaluator:
* <code>getExpressionEvaluator()</code>, <code>getVariableResolver()</code>
*
* @since JSP 2.0
@@ -70,55 +57,47 @@ import javax.el.ELContext;
public abstract class JspContext {
/**
- * Sole constructor. (For invocation by subclass constructors,
- * typically implicit.)
+ * Sole constructor. (For invocation by subclass constructors, typically implicit.)
*/
public JspContext() {
// NOOP by default
}
/**
- * Register the name and value specified with page scope semantics.
- * If the value passed in is <code>null</code>, this has the same
- * effect as calling
- * <code>removeAttribute( name, PageContext.PAGE_SCOPE )</code>.
- *
- * @param name the name of the attribute to set
- * @param value the value to associate with the name, or null if the
- * attribute is to be removed from the page scope.
+ * Register the name and value specified with page scope semantics. If the value passed in is <code>null</code>,
+ * this has the same effect as calling <code>removeAttribute( name, PageContext.PAGE_SCOPE )</code>.
+ *
+ * @param name the name of the attribute to set
+ * @param value the value to associate with the name, or null if the attribute is to be removed from the page scope.
+ *
* @throws NullPointerException if the name is null
*/
public abstract void setAttribute(String name, Object value);
/**
- * Register the name and value specified with appropriate
- * scope semantics. If the value passed in is <code>null</code>,
- * this has the same effect as calling
- * <code>removeAttribute( name, scope )</code>.
- *
- * @param name the name of the attribute to set
- * @param value the object to associate with the name, or null if
- * the attribute is to be removed from the specified scope.
+ * Register the name and value specified with appropriate scope semantics. If the value passed in is
+ * <code>null</code>, this has the same effect as calling <code>removeAttribute( name, scope )</code>.
+ *
+ * @param name the name of the attribute to set
+ * @param value the object to associate with the name, or null if the attribute is to be removed from the specified
+ * scope.
* @param scope the scope with which to associate the name/object
*
- * @throws NullPointerException if the name is null
+ * @throws NullPointerException if the name is null
* @throws IllegalArgumentException if the scope is invalid
- * @throws IllegalStateException if the scope is
- * PageContext.SESSION_SCOPE but the page that was requested
- * does not participate in a session or the session has been
- * invalidated.
+ * @throws IllegalStateException if the scope is PageContext.SESSION_SCOPE but the page that was requested does
+ * not participate in a session or the session has been invalidated.
*/
public abstract void setAttribute(String name, Object value, int scope);
/**
- * Returns the object associated with the name in the page scope or null
- * if not found.
+ * Returns the object associated with the name in the page scope or null if not found.
*
* @param name the name of the attribute to get
- * @return the object associated with the name in the page scope
- * or null if not found.
+ *
+ * @return the object associated with the name in the page scope or null if not found.
*
* @throws NullPointerException if the name is null
*/
@@ -126,58 +105,56 @@ public abstract class JspContext {
public abstract Object getAttribute(String name);
/**
- * Return the object associated with the name in the specified
- * scope or null if not found.
+ * Return the object associated with the name in the specified scope or null if not found.
*
- * @param name the name of the attribute to set
+ * @param name the name of the attribute to set
* @param scope the scope with which to associate the name/object
- * @return the object associated with the name in the specified
- * scope or null if not found.
*
- * @throws NullPointerException if the name is null
+ * @return the object associated with the name in the specified scope or null if not found.
+ *
+ * @throws NullPointerException if the name is null
* @throws IllegalArgumentException if the scope is invalid
- * @throws IllegalStateException if the scope is
- * PageContext.SESSION_SCOPE but the page that was requested
- * does not participate in a session or the session has been
- * invalidated.
+ * @throws IllegalStateException if the scope is PageContext.SESSION_SCOPE but the page that was requested does
+ * not participate in a session or the session has been invalidated.
*/
public abstract Object getAttribute(String name, int scope);
/**
- * Searches for the named attribute in page, request, session (if valid),
- * and application scope(s) in order and returns the value associated or
- * null.
+ * Searches for the named attribute in page, request, session (if valid), and application scope(s) in order and
+ * returns the value associated or null.
*
* @param name the name of the attribute to search for
+ *
* @return the value associated or null
+ *
* @throws NullPointerException if the name is null
*/
public abstract Object findAttribute(String name);
/**
- * Remove the object reference associated with the given name
- * from all scopes. Does nothing if there is no such object.
+ * Remove the object reference associated with the given name from all scopes. Does nothing if there is no such
+ * object.
*
* @param name The name of the object to remove.
+ *
* @throws NullPointerException if the name is null
*/
public abstract void removeAttribute(String name);
/**
- * Remove the object reference associated with the specified name
- * in the given scope. Does nothing if there is no such object.
+ * Remove the object reference associated with the specified name in the given scope. Does nothing if there is no
+ * such object.
*
- * @param name The name of the object to remove.
+ * @param name The name of the object to remove.
* @param scope The scope where to look.
+ *
* @throws IllegalArgumentException if the scope is invalid
- * @throws IllegalStateException if the scope is
- * PageContext.SESSION_SCOPE but the page that was requested
- * does not participate in a session or the session has been
- * invalidated.
- * @throws NullPointerException if the name is null
+ * @throws IllegalStateException if the scope is PageContext.SESSION_SCOPE but the page that was requested does
+ * not participate in a session or the session has been invalidated.
+ * @throws NullPointerException if the name is null
*/
public abstract void removeAttribute(String name, int scope);
@@ -186,7 +163,9 @@ public abstract class JspContext {
* Get the scope where a given attribute is defined.
*
* @param name the name of the attribute to return the scope for
+ *
* @return the scope of the object associated with the name specified or 0
+ *
* @throws NullPointerException if the name is null
*/
@@ -196,13 +175,12 @@ public abstract class JspContext {
* Enumerate all the attributes in a given scope.
*
* @param scope the scope to enumerate all the attributes for
- * @return an enumeration of names (java.lang.String) of all the
- * attributes the specified scope
+ *
+ * @return an enumeration of names (java.lang.String) of all the attributes the specified scope
+ *
* @throws IllegalArgumentException if the scope is invalid
- * @throws IllegalStateException if the scope is
- * PageContext.SESSION_SCOPE but the page that was requested
- * does not participate in a session or the session has been
- * invalidated.
+ * @throws IllegalStateException if the scope is PageContext.SESSION_SCOPE but the page that was requested does
+ * not participate in a session or the session has been invalidated.
*/
public abstract Enumeration<String> getAttributeNamesInScope(int scope);
@@ -215,69 +193,65 @@ public abstract class JspContext {
public abstract JspWriter getOut();
/**
- * Provides programmatic access to the ExpressionEvaluator.
- * The JSP Container must return a valid instance of an
+ * Provides programmatic access to the ExpressionEvaluator. The JSP Container must return a valid instance of an
* ExpressionEvaluator that can parse EL expressions.
*
* @return A valid instance of an ExpressionEvaluator.
+ *
* @since JSP 2.0
- * @deprecated As of JSP 2.1, replaced by
- * JspApplicationContext.getExpressionFactory()
+ *
+ * @deprecated As of JSP 2.1, replaced by JspApplicationContext.getExpressionFactory()
*/
@SuppressWarnings("dep-ann") // TCK signature test fails with annotation
public abstract javax.servlet.jsp.el.ExpressionEvaluator getExpressionEvaluator();
/**
- * Obtain the ELContext for this JSPContext. Each JSPContext has a dedicated
- * ELContext.
+ * Obtain the ELContext for this JSPContext. Each JSPContext has a dedicated ELContext.
*
* @return the ELContext for this JSPContext
*/
public abstract ELContext getELContext();
/**
- * Returns an instance of a VariableResolver that provides access to the
- * implicit objects specified in the JSP specification using this JspContext
- * as the context object.
+ * Returns an instance of a VariableResolver that provides access to the implicit objects specified in the JSP
+ * specification using this JspContext as the context object.
*
* @return A valid instance of a VariableResolver.
+ *
* @since JSP 2.0
- * @deprecated As of JSP 2.1,
- * replaced by javax.el.ELContext.getELResolver()
- * which can be obtained by
- * jspContext.getELContext().getELResolver()
+ *
+ * @deprecated As of JSP 2.1, replaced by javax.el.ELContext.getELResolver() which can be obtained by
+ * jspContext.getELContext().getELResolver()
*/
@SuppressWarnings("dep-ann") // TCK signature test fails with annotation
public abstract javax.servlet.jsp.el.VariableResolver getVariableResolver();
/**
- * Return a new JspWriter object that sends output to the
- * provided Writer. Saves the current "out" JspWriter,
- * and updates the value of the "out" attribute in the
- * page scope attribute namespace of the JspContext.
- * <p>The returned JspWriter must implement all methods and
- * behave as though it were unbuffered. More specifically:
+ * Return a new JspWriter object that sends output to the provided Writer. Saves the current "out" JspWriter, and
+ * updates the value of the "out" attribute in the page scope attribute namespace of the JspContext.
+ * <p>
+ * The returned JspWriter must implement all methods and behave as though it were unbuffered. More specifically:
* </p>
* <ul>
- * <li>clear() must throw an IOException</li>
- * <li>clearBuffer() does nothing</li>
- * <li>getBufferSize() always returns 0</li>
- * <li>getRemaining() always returns 0</li>
+ * <li>clear() must throw an IOException</li>
+ * <li>clearBuffer() does nothing</li>
+ * <li>getBufferSize() always returns 0</li>
+ * <li>getRemaining() always returns 0</li>
* </ul>
*
- * @param writer The Writer for the returned JspWriter to send
- * output to.
+ * @param writer The Writer for the returned JspWriter to send output to.
+ *
* @return a new JspWriter that writes to the given Writer.
+ *
* @since JSP 2.0
*/
- public JspWriter pushBody( java.io.Writer writer ) {
+ public JspWriter pushBody(java.io.Writer writer) {
return null; // XXX to implement
}
/**
- * Return the previous JspWriter "out" saved by the matching
- * pushBody(), and update the value of the "out" attribute in
- * the page scope attribute namespace of the JspContext.
+ * Return the previous JspWriter "out" saved by the matching pushBody(), and update the value of the "out" attribute
+ * in the page scope attribute namespace of the JspContext.
*
* @return the saved JspWriter.
*/
diff --git a/java/javax/servlet/jsp/JspEngineInfo.java b/java/javax/servlet/jsp/JspEngineInfo.java
index a12188c8d3..4c3f3929a1 100644
--- a/java/javax/servlet/jsp/JspEngineInfo.java
+++ b/java/javax/servlet/jsp/JspEngineInfo.java
@@ -17,29 +17,24 @@
package javax.servlet.jsp;
/**
- * The JspEngineInfo is an abstract class that provides information on the
- * current JSP engine.
+ * The JspEngineInfo is an abstract class that provides information on the current JSP engine.
*/
public abstract class JspEngineInfo {
/**
- * Sole constructor. (For invocation by subclass constructors,
- * typically implicit.)
+ * Sole constructor. (For invocation by subclass constructors, typically implicit.)
*/
public JspEngineInfo() {
// NOOP by default
}
/**
- * Return the version number of the JSP specification that is supported by
- * this JSP engine.
+ * Return the version number of the JSP specification that is supported by this JSP engine.
* <p>
- * Specification version numbers that consists of positive decimal integers
- * separated by periods ".", for example, "2.0" or "1.2.3.4.5.6.7".
- * This allows an extensible number to be used to
- * represent major, minor, micro, etc versions.
- * The version number must begin with a number.
+ * Specification version numbers that consists of positive decimal integers separated by periods ".", for example,
+ * "2.0" or "1.2.3.4.5.6.7". This allows an extensible number to be used to represent major, minor, micro, etc
+ * versions. The version number must begin with a number.
* </p>
*
* @return the specification version, null is returned if it is not known
diff --git a/java/javax/servlet/jsp/JspException.java b/java/javax/servlet/jsp/JspException.java
index 71c962b36f..f0f22f3d64 100644
--- a/java/javax/servlet/jsp/JspException.java
+++ b/java/javax/servlet/jsp/JspException.java
@@ -17,8 +17,7 @@
package javax.servlet.jsp;
/**
- * A generic exception known to the JSP engine; uncaught
- * JspExceptions will result in an invocation of the errorpage
+ * A generic exception known to the JSP engine; uncaught JspExceptions will result in an invocation of the errorpage
* machinery.
*/
public class JspException extends Exception {
@@ -35,12 +34,10 @@ public class JspException extends Exception {
/**
- * Constructs a new JSP exception with the
- * specified message. The message can be written
- * to the server log and/or displayed for the user.
+ * Constructs a new JSP exception with the specified message. The message can be written to the server log and/or
+ * displayed for the user.
*
- * @param msg a <code>String</code> specifying the text of the exception
- * message
+ * @param msg a <code>String</code> specifying the text of the exception message
*/
public JspException(String msg) {
super(msg);
@@ -48,19 +45,14 @@ public class JspException extends Exception {
/**
- * Constructs a new <code>JSPException</code> with the specified detail
- * message and cause. The cause is saved for later retrieval by the
- * <code>java.lang.Throwable.getCause()</code> and {@link #getRootCause()}
- * methods.
+ * Constructs a new <code>JSPException</code> with the specified detail message and cause. The cause is saved for
+ * later retrieval by the <code>java.lang.Throwable.getCause()</code> and {@link #getRootCause()} methods.
*
* @see java.lang.Exception#Exception(String, Throwable)
*
- * @param message a <code>String</code> containing the text of the
- * exception message
- *
- * @param cause the <code>Throwable</code> exception that
- * interfered with the JSP's normal operation,
- * making this JSP exception necessary
+ * @param message a <code>String</code> containing the text of the exception message
+ * @param cause the <code>Throwable</code> exception that interfered with the JSP's normal operation, making this
+ * JSP exception necessary
*/
public JspException(String message, Throwable cause) {
@@ -69,16 +61,13 @@ public class JspException extends Exception {
/**
- * Constructs a new <code>JSPException</code> with the specified cause.
- * The cause is saved for later retrieval by the
- * <code>java.lang.Throwable.getCause()</code> and {@link #getRootCause()}
- * methods.
+ * Constructs a new <code>JSPException</code> with the specified cause. The cause is saved for later retrieval by
+ * the <code>java.lang.Throwable.getCause()</code> and {@link #getRootCause()} methods.
*
* @see java.lang.Exception#Exception(Throwable)
*
- * @param cause the <code>Throwable</code> exception that
- * interfered with the JSP's normal operation, making
- * the JSP exception necessary
+ * @param cause the <code>Throwable</code> exception that interfered with the JSP's normal operation, making the JSP
+ * exception necessary
*/
public JspException(Throwable cause) {
@@ -89,10 +78,9 @@ public class JspException extends Exception {
/**
* Returns the exception that caused this JSP exception.
*
- * @return the <code>Throwable</code> that caused this JSP exception
+ * @return the <code>Throwable</code> that caused this JSP exception
*
- * @deprecated As of JSP 2.1, replaced by
- * <code>java.lang.Throwable.getCause()</code>
+ * @deprecated As of JSP 2.1, replaced by <code>java.lang.Throwable.getCause()</code>
*/
@SuppressWarnings("dep-ann") // TCK signature test fails with annotation
public Throwable getRootCause() {
diff --git a/java/javax/servlet/jsp/JspFactory.java b/java/javax/servlet/jsp/JspFactory.java
index e642279a60..5dfdec5260 100644
--- a/java/javax/servlet/jsp/JspFactory.java
+++ b/java/javax/servlet/jsp/JspFactory.java
@@ -23,19 +23,15 @@ import javax.servlet.ServletResponse;
/**
* <p>
- * The JspFactory is an abstract class that defines a number of factory
- * methods available to a JSP page at runtime for the purposes of creating
- * instances of various interfaces and classes used to support the JSP
- * implementation.
+ * The JspFactory is an abstract class that defines a number of factory methods available to a JSP page at runtime for
+ * the purposes of creating instances of various interfaces and classes used to support the JSP implementation.
* <p>
- * A conformant JSP Engine implementation will, during it's initialization
- * instantiate an implementation dependent subclass of this class, and make
- * it globally available for use by JSP implementation classes by registering
- * the instance created with this class via the
- * static <code> setDefaultFactory() </code> method.
+ * A conformant JSP Engine implementation will, during it's initialization instantiate an implementation dependent
+ * subclass of this class, and make it globally available for use by JSP implementation classes by registering the
+ * instance created with this class via the static <code> setDefaultFactory() </code> method.
* <p>
- * The PageContext and the JspEngineInfo classes are the only
- * implementation-dependent classes that can be created from the factory.
+ * The PageContext and the JspEngineInfo classes are the only implementation-dependent classes that can be created from
+ * the factory.
* <p>
* JspFactory objects should not be used by JSP page authors.
*/
@@ -45,8 +41,7 @@ public abstract class JspFactory {
private static volatile JspFactory deflt = null;
/**
- * Sole constructor. (For invocation by subclass constructors,
- * typically implicit.)
+ * Sole constructor. (For invocation by subclass constructors, typically implicit.)
*/
public JspFactory() {
// NOOP by default
@@ -54,11 +49,11 @@ public abstract class JspFactory {
/**
* <p>
- * set the default factory for this implementation. It is illegal for
- * any principal other than the JSP Engine runtime to call this method.
+ * set the default factory for this implementation. It is illegal for any principal other than the JSP Engine
+ * runtime to call this method.
* </p>
*
- * @param deflt The default factory implementation
+ * @param deflt The default factory implementation
*/
public static void setDefaultFactory(JspFactory deflt) {
@@ -77,53 +72,42 @@ public abstract class JspFactory {
/**
* <p>
- * obtains an instance of an implementation dependent
- * javax.servlet.jsp.PageContext abstract class for the calling Servlet
- * and currently pending request and response.
+ * obtains an instance of an implementation dependent javax.servlet.jsp.PageContext abstract class for the calling
+ * Servlet and currently pending request and response.
* </p>
- *
* <p>
- * This method is typically called early in the processing of the
- * _jspService() method of a JSP implementation class in order to
- * obtain a PageContext object for the request being processed.
+ * This method is typically called early in the processing of the _jspService() method of a JSP implementation class
+ * in order to obtain a PageContext object for the request being processed.
* </p>
* <p>
- * Invoking this method shall result in the PageContext.initialize()
- * method being invoked. The PageContext returned is properly initialized.
+ * Invoking this method shall result in the PageContext.initialize() method being invoked. The PageContext returned
+ * is properly initialized.
* </p>
* <p>
- * All PageContext objects obtained via this method shall be released
- * by invoking releasePageContext().
+ * All PageContext objects obtained via this method shall be released by invoking releasePageContext().
* </p>
*
* @param servlet the requesting servlet
* @param request the current request pending on the servlet
* @param response the current response pending on the servlet
- * @param errorPageURL the URL of the error page for the requesting JSP, or
- * null
+ * @param errorPageURL the URL of the error page for the requesting JSP, or null
* @param needsSession true if the JSP participates in a session
- * @param buffer size of buffer in bytes, {@link JspWriter#NO_BUFFER}
- * if no buffer, {@link JspWriter#DEFAULT_BUFFER}
- * if implementation default.
- * @param autoflush should the buffer autoflush to the output stream on
- * buffer overflow, or throw an IOException?
+ * @param buffer size of buffer in bytes, {@link JspWriter#NO_BUFFER} if no buffer,
+ * {@link JspWriter#DEFAULT_BUFFER} if implementation default.
+ * @param autoflush should the buffer autoflush to the output stream on buffer overflow, or throw an IOException?
*
* @return the page context
*
* @see javax.servlet.jsp.PageContext
*/
- public abstract PageContext getPageContext(Servlet servlet,
- ServletRequest request, ServletResponse response,
- String errorPageURL, boolean needsSession, int buffer,
- boolean autoflush);
+ public abstract PageContext getPageContext(Servlet servlet, ServletRequest request, ServletResponse response,
+ String errorPageURL, boolean needsSession, int buffer, boolean autoflush);
/**
* <p>
- * called to release a previously allocated PageContext object.
- * Results in PageContext.release() being invoked.
- * This method should be invoked prior to returning from the _jspService()
- * method of a JSP implementation class.
+ * called to release a previously allocated PageContext object. Results in PageContext.release() being invoked. This
+ * method should be invoked prior to returning from the _jspService() method of a JSP implementation class.
* </p>
*
* @param pc A PageContext previously obtained by getPageContext()
@@ -132,8 +116,7 @@ public abstract class JspFactory {
/**
* <p>
- * called to get implementation-specific information on the current JSP
- * engine.
+ * called to get implementation-specific information on the current JSP engine.
* </p>
*
* @return a JspEngineInfo object describing the current JSP engine
@@ -143,15 +126,15 @@ public abstract class JspFactory {
/**
* <p>
- * Obtain the <code>JspApplicationContext</code> instance that was
- * associated within the passed <code>ServletContext</code> for this web
- * application.
+ * Obtain the <code>JspApplicationContext</code> instance that was associated within the passed
+ * <code>ServletContext</code> for this web application.
* </p>
*
* @param context the current web application's <code>ServletContext</code>
+ *
* @return <code>JspApplicationContext</code> instance
+ *
* @since JSP 2.1
*/
- public abstract JspApplicationContext getJspApplicationContext(
- ServletContext context);
+ public abstract JspApplicationContext getJspApplicationContext(ServletContext context);
}
diff --git a/java/javax/servlet/jsp/JspPage.java b/java/javax/servlet/jsp/JspPage.java
index 21ac354c99..e9f10f8805 100644
--- a/java/javax/servlet/jsp/JspPage.java
+++ b/java/javax/servlet/jsp/JspPage.java
@@ -19,36 +19,29 @@ package javax.servlet.jsp;
import javax.servlet.Servlet;
/**
- * The JspPage interface describes the generic interaction that a JSP Page
- * Implementation class must satisfy; pages that use the HTTP protocol
- * are described by the HttpJspPage interface.
- *
- * <p><B>Two plus One Methods</B>
+ * The JspPage interface describes the generic interaction that a JSP Page Implementation class must satisfy; pages that
+ * use the HTTP protocol are described by the HttpJspPage interface.
* <p>
- * The interface defines a protocol with 3 methods; only two of
- * them: jspInit() and jspDestroy() are part of this interface as
- * the signature of the third method: _jspService() depends on
- * the specific protocol used and cannot be expressed in a generic
- * way in Java.
+ * <B>Two plus One Methods</B>
* <p>
- * A class implementing this interface is responsible for invoking
- * the above methods at the appropriate time based on the
- * corresponding Servlet-based method invocations.
+ * The interface defines a protocol with 3 methods; only two of them: jspInit() and jspDestroy() are part of this
+ * interface as the signature of the third method: _jspService() depends on the specific protocol used and cannot be
+ * expressed in a generic way in Java.
* <p>
- * The jspInit() and jspDestroy() methods can be defined by a JSP
- * author, but the _jspService() method is defined automatically
- * by the JSP processor based on the contents of the JSP page.
- *
- * <p><B>_jspService()</B>
+ * A class implementing this interface is responsible for invoking the above methods at the appropriate time based on
+ * the corresponding Servlet-based method invocations.
+ * <p>
+ * The jspInit() and jspDestroy() methods can be defined by a JSP author, but the _jspService() method is defined
+ * automatically by the JSP processor based on the contents of the JSP page.
+ * <p>
+ * <B>_jspService()</B>
* <p>
- * The _jspService()method corresponds to the body of the JSP page. This
- * method is defined automatically by the JSP container and should never
- * be defined by the JSP page author.
+ * The _jspService()method corresponds to the body of the JSP page. This method is defined automatically by the JSP
+ * container and should never be defined by the JSP page author.
* <p>
- * If a superclass is specified using the extends attribute, that
- * superclass may choose to perform some actions in its service() method
- * before or after calling the _jspService() method. See using the extends
- * attribute in the JSP_Engine chapter of the JSP specification.
+ * If a superclass is specified using the extends attribute, that superclass may choose to perform some actions in its
+ * service() method before or after calling the _jspService() method. See using the extends attribute in the JSP_Engine
+ * chapter of the JSP specification.
* <p>
* The specific signature depends on the protocol supported by the JSP page.
*
@@ -63,27 +56,17 @@ import javax.servlet.Servlet;
public interface JspPage extends Servlet {
/**
- * The jspInit() method is invoked when the JSP page is initialized. It
- * is the responsibility of the JSP implementation (and of the class
- * mentioned by the extends attribute, if present) that at this point
- * invocations to the getServletConfig() method will return the desired
- * value.
- *
- * A JSP page can override this method by including a definition for it
- * in a declaration element.
- *
- * A JSP page should redefine the init() method from Servlet.
+ * The jspInit() method is invoked when the JSP page is initialized. It is the responsibility of the JSP
+ * implementation (and of the class mentioned by the extends attribute, if present) that at this point invocations
+ * to the getServletConfig() method will return the desired value. A JSP page can override this method by including
+ * a definition for it in a declaration element. A JSP page should redefine the init() method from Servlet.
*/
void jspInit();
/**
- * The jspDestroy() method is invoked when the JSP page is about to be
- * destroyed.
- *
- * A JSP page can override this method by including a definition for it
- * in a declaration element.
- *
- * A JSP page should redefine the destroy() method from Servlet.
+ * The jspDestroy() method is invoked when the JSP page is about to be destroyed. A JSP page can override this
+ * method by including a definition for it in a declaration element. A JSP page should redefine the destroy() method
+ * from Servlet.
*/
void jspDestroy();
diff --git a/java/javax/servlet/jsp/JspTagException.java b/java/javax/servlet/jsp/JspTagException.java
index ef18bdc107..b892442826 100644
--- a/java/javax/servlet/jsp/JspTagException.java
+++ b/java/javax/servlet/jsp/JspTagException.java
@@ -17,21 +17,18 @@
package javax.servlet.jsp;
/**
- * Exception to be used by a Tag Handler to indicate some unrecoverable error.
- * This error is to be caught by the top level of the JSP page and will result
- * in an error page.
+ * Exception to be used by a Tag Handler to indicate some unrecoverable error. This error is to be caught by the top
+ * level of the JSP page and will result in an error page.
*/
public class JspTagException extends JspException {
private static final long serialVersionUID = 1L;
/**
- * Constructs a new JspTagException with the specified message. The message
- * can be written to the server log and/or displayed for the user.
+ * Constructs a new JspTagException with the specified message. The message can be written to the server log and/or
+ * displayed for the user.
*
- * @param msg
- * a <code>String</code> specifying the text of the exception
- * message
+ * @param msg a <code>String</code> specifying the text of the exception message
*/
public JspTagException(String msg) {
super(msg);
@@ -45,17 +42,13 @@ public class JspTagException extends JspException {
}
/**
- * Constructs a new JspTagException when the JSP Tag needs to throw an
- * exception and include a message about the "root cause" exception that
- * interfered with its normal operation, including a description message.
+ * Constructs a new JspTagException when the JSP Tag needs to throw an exception and include a message about the
+ * "root cause" exception that interfered with its normal operation, including a description message.
+ *
+ * @param message a <code>String</code> containing the text of the exception message
+ * @param rootCause the <code>Throwable</code> exception that interfered with the JSP Tag's normal operation, making
+ * this JSP Tag exception necessary
*
- * @param message
- * a <code>String</code> containing the text of the exception
- * message
- * @param rootCause
- * the <code>Throwable</code> exception that interfered with the
- * JSP Tag's normal operation, making this JSP Tag exception
- * necessary
* @since JSP 2.0
*/
public JspTagException(String message, Throwable rootCause) {
@@ -63,20 +56,17 @@ public class JspTagException extends JspException {
}
/**
- * Constructs a new JSP Tag exception when the JSP Tag needs to throw an
- * exception and include a message about the "root cause" exception that
- * interfered with its normal operation. The exception's message is based on
- * the localized message of the underlying exception.
+ * Constructs a new JSP Tag exception when the JSP Tag needs to throw an exception and include a message about the
+ * "root cause" exception that interfered with its normal operation. The exception's message is based on the
+ * localized message of the underlying exception.
* <p>
- * This method calls the <code>getLocalizedMessage</code> method on the
- * <code>Throwable</code> exception to get a localized exception message.
- * When subclassing <code>JspTagException</code>, this method can be
- * overridden to create an exception message designed for a specific locale.
+ * This method calls the <code>getLocalizedMessage</code> method on the <code>Throwable</code> exception to get a
+ * localized exception message. When subclassing <code>JspTagException</code>, this method can be overridden to
+ * create an exception message designed for a specific locale.
+ *
+ * @param rootCause the <code>Throwable</code> exception that interfered with the JSP Tag's normal operation, making
+ * the JSP Tag exception necessary
*
- * @param rootCause
- * the <code>Throwable</code> exception that interfered with the
- * JSP Tag's normal operation, making the JSP Tag exception
- * necessary
* @since JSP 2.0
*/
public JspTagException(Throwable rootCause) {
diff --git a/java/javax/servlet/jsp/JspWriter.java b/java/javax/servlet/jsp/JspWriter.java
index fb2166869a..b6e5f3b7a3 100644
--- a/java/javax/servlet/jsp/JspWriter.java
+++ b/java/javax/servlet/jsp/JspWriter.java
@@ -20,57 +20,42 @@ import java.io.IOException;
/**
* <p>
- * The actions and template data in a JSP page is written using the JspWriter
- * object that is referenced by the implicit variable out which is initialized
- * automatically using methods in the PageContext object.
+ * The actions and template data in a JSP page is written using the JspWriter object that is referenced by the implicit
+ * variable out which is initialized automatically using methods in the PageContext object.
* <p>
- * This abstract class emulates some of the functionality found in the
- * java.io.BufferedWriter and java.io.PrintWriter classes, however it differs in
- * that it throws java.io.IOException from the print methods while PrintWriter
- * does not.
+ * This abstract class emulates some of the functionality found in the java.io.BufferedWriter and java.io.PrintWriter
+ * classes, however it differs in that it throws java.io.IOException from the print methods while PrintWriter does not.
* <p>
* <B>Buffering</B>
* <p>
- * The initial JspWriter object is associated with the PrintWriter object of the
- * ServletResponse in a way that depends on whether the page is or is not
- * buffered. If the page is not buffered, output written to this JspWriter
- * object will be written through to the PrintWriter directly, which will be
- * created if necessary by invoking the getWriter() method on the response
- * object. But if the page is buffered, the PrintWriter object will not be
- * created until the buffer is flushed and operations like setContentType() are
- * legal. Since this flexibility simplifies programming substantially, buffering
- * is the default for JSP pages.
+ * The initial JspWriter object is associated with the PrintWriter object of the ServletResponse in a way that depends
+ * on whether the page is or is not buffered. If the page is not buffered, output written to this JspWriter object will
+ * be written through to the PrintWriter directly, which will be created if necessary by invoking the getWriter() method
+ * on the response object. But if the page is buffered, the PrintWriter object will not be created until the buffer is
+ * flushed and operations like setContentType() are legal. Since this flexibility simplifies programming substantially,
+ * buffering is the default for JSP pages.
* <p>
- * Buffering raises the issue of what to do when the buffer is exceeded. Two
- * approaches can be taken:
+ * Buffering raises the issue of what to do when the buffer is exceeded. Two approaches can be taken:
* <ul>
- * <li>Exceeding the buffer is not a fatal error; when the buffer is exceeded,
- * just flush the output.
- * <li>Exceeding the buffer is a fatal error; when the buffer is exceeded, raise
- * an exception.
+ * <li>Exceeding the buffer is not a fatal error; when the buffer is exceeded, just flush the output.
+ * <li>Exceeding the buffer is a fatal error; when the buffer is exceeded, raise an exception.
* </ul>
* <p>
- * Both approaches are valid, and thus both are supported in the JSP technology.
- * The behavior of a page is controlled by the autoFlush attribute, which
- * defaults to true. In general, JSP pages that need to be sure that correct and
- * complete data has been sent to their client may want to set autoFlush to
- * false, with a typical case being that where the client is an application
- * itself. On the other hand, JSP pages that send data that is meaningful even
- * when partially constructed may want to set autoFlush to true; such as when
- * the data is sent for immediate display through a browser. Each application
- * will need to consider their specific needs.
+ * Both approaches are valid, and thus both are supported in the JSP technology. The behavior of a page is controlled by
+ * the autoFlush attribute, which defaults to true. In general, JSP pages that need to be sure that correct and complete
+ * data has been sent to their client may want to set autoFlush to false, with a typical case being that where the
+ * client is an application itself. On the other hand, JSP pages that send data that is meaningful even when partially
+ * constructed may want to set autoFlush to true; such as when the data is sent for immediate display through a browser.
+ * Each application will need to consider their specific needs.
* <p>
- * An alternative considered was to make the buffer size unbounded; but, this
- * had the disadvantage that runaway computations would consume an unbounded
- * amount of resources.
+ * An alternative considered was to make the buffer size unbounded; but, this had the disadvantage that runaway
+ * computations would consume an unbounded amount of resources.
* <p>
- * The "out" implicit variable of a JSP implementation class is of this type. If
- * the page directive selects autoflush="true" then all the I/O operations on
- * this class shall automatically flush the contents of the buffer if an
- * overflow condition would result if the current operation were performed
- * without a flush. If autoflush="false" then all the I/O operations on this
- * class shall throw an IOException if performing the current operation would
- * result in a buffer overflow condition.
+ * The "out" implicit variable of a JSP implementation class is of this type. If the page directive selects
+ * autoflush="true" then all the I/O operations on this class shall automatically flush the contents of the buffer if an
+ * overflow condition would result if the current operation were performed without a flush. If autoflush="false" then
+ * all the I/O operations on this class shall throw an IOException if performing the current operation would result in a
+ * buffer overflow condition.
*
* @see java.io.Writer
* @see java.io.BufferedWriter
@@ -84,24 +69,20 @@ public abstract class JspWriter extends java.io.Writer {
public static final int NO_BUFFER = 0;
/**
- * Constant indicating that the Writer is buffered and is using the
- * implementation default buffer size.
+ * Constant indicating that the Writer is buffered and is using the implementation default buffer size.
*/
public static final int DEFAULT_BUFFER = -1;
/**
- * Constant indicating that the Writer is buffered and is unbounded; this is
- * used in BodyContent.
+ * Constant indicating that the Writer is buffered and is unbounded; this is used in BodyContent.
*/
public static final int UNBOUNDED_BUFFER = -2;
/**
* Protected constructor.
*
- * @param bufferSize
- * the size of the buffer to be used by the JspWriter
- * @param autoFlush
- * whether the JspWriter should be autoflushing
+ * @param bufferSize the size of the buffer to be used by the JspWriter
+ * @param autoFlush whether the JspWriter should be autoflushing
*/
protected JspWriter(int bufferSize, boolean autoFlush) {
this.bufferSize = bufferSize;
@@ -109,293 +90,250 @@ public abstract class JspWriter extends java.io.Writer {
}
/**
- * Write a line separator. The line separator string is defined by the
- * system property <code>line.separator</code>, and is not necessarily a
- * single newline ('\n') character.
+ * Write a line separator. The line separator string is defined by the system property <code>line.separator</code>,
+ * and is not necessarily a single newline ('\n') character.
*
- * @exception IOException
- * If an I/O error occurs
+ * @exception IOException If an I/O error occurs
*/
public abstract void newLine() throws IOException;
/**
* Print a boolean value. The string produced by <code>{@link
- * java.lang.String#valueOf(boolean)}</code>
- * is written to the JspWriter's buffer or, if no buffer is used, directly
+ * java.lang.String#valueOf(boolean)}</code> is written to the JspWriter's buffer or, if no buffer is used, directly
* to the underlying writer.
*
- * @param b
- * The <code>boolean</code> to be printed
- * @throws java.io.IOException
- * If an error occurred while writing
+ * @param b The <code>boolean</code> to be printed
+ *
+ * @throws java.io.IOException If an error occurred while writing
*/
public abstract void print(boolean b) throws IOException;
/**
- * Print a character. The character is written to the JspWriter's buffer or,
- * if no buffer is used, directly to the underlying writer.
+ * Print a character. The character is written to the JspWriter's buffer or, if no buffer is used, directly to the
+ * underlying writer.
+ *
+ * @param c The <code>char</code> to be printed
*
- * @param c
- * The <code>char</code> to be printed
- * @throws java.io.IOException
- * If an error occurred while writing
+ * @throws java.io.IOException If an error occurred while writing
*/
public abstract void print(char c) throws IOException;
/**
* Print an integer. The string produced by <code>{@link
- * java.lang.String#valueOf(int)}</code>
- * is written to the JspWriter's buffer or, if no buffer is used, directly
- * to the underlying writer.
+ * java.lang.String#valueOf(int)}</code> is written to the JspWriter's buffer or, if no buffer is used, directly to
+ * the underlying writer.
+ *
+ * @param i The <code>int</code> to be printed
*
- * @param i
- * The <code>int</code> to be printed
* @see java.lang.Integer#toString(int)
- * @throws java.io.IOException
- * If an error occurred while writing
+ *
+ * @throws java.io.IOException If an error occurred while writing
*/
public abstract void print(int i) throws IOException;
/**
* Print a long integer. The string produced by <code>{@link
- * java.lang.String#valueOf(long)}</code>
- * is written to the JspWriter's buffer or, if no buffer is used, directly
- * to the underlying writer.
+ * java.lang.String#valueOf(long)}</code> is written to the JspWriter's buffer or, if no buffer is used, directly to
+ * the underlying writer.
+ *
+ * @param l The <code>long</code> to be printed
*
- * @param l
- * The <code>long</code> to be printed
* @see java.lang.Long#toString(long)
- * @throws java.io.IOException
- * If an error occurred while writing
+ *
+ * @throws java.io.IOException If an error occurred while writing
*/
public abstract void print(long l) throws IOException;
/**
* Print a floating-point number. The string produced by <code>{@link
- * java.lang.String#valueOf(float)}</code>
- * is written to the JspWriter's buffer or, if no buffer is used, directly
+ * java.lang.String#valueOf(float)}</code> is written to the JspWriter's buffer or, if no buffer is used, directly
* to the underlying writer.
*
- * @param f
- * The <code>float</code> to be printed
+ * @param f The <code>float</code> to be printed
+ *
* @see java.lang.Float#toString(float)
- * @throws java.io.IOException
- * If an error occurred while writing
+ *
+ * @throws java.io.IOException If an error occurred while writing
*/
public abstract void print(float f) throws IOException;
/**
* Print a double-precision floating-point number. The string produced by
- * <code>{@link java.lang.String#valueOf(double)}</code> is written to the
- * JspWriter's buffer or, if no buffer is used, directly to the underlying
- * writer.
+ * <code>{@link java.lang.String#valueOf(double)}</code> is written to the JspWriter's buffer or, if no buffer is
+ * used, directly to the underlying writer.
+ *
+ * @param d The <code>double</code> to be printed
*
- * @param d
- * The <code>double</code> to be printed
* @see java.lang.Double#toString(double)
- * @throws java.io.IOException
- * If an error occurred while writing
+ *
+ * @throws java.io.IOException If an error occurred while writing
*/
public abstract void print(double d) throws IOException;
/**
- * Print an array of characters. The characters are written to the
- * JspWriter's buffer or, if no buffer is used, directly to the underlying
- * writer.
+ * Print an array of characters. The characters are written to the JspWriter's buffer or, if no buffer is used,
+ * directly to the underlying writer.
*
- * @param s
- * The array of chars to be printed
- * @throws NullPointerException
- * If <code>s</code> is <code>null</code>
- * @throws java.io.IOException
- * If an error occurred while writing
+ * @param s The array of chars to be printed
+ *
+ * @throws NullPointerException If <code>s</code> is <code>null</code>
+ * @throws java.io.IOException If an error occurred while writing
*/
public abstract void print(char s[]) throws IOException;
/**
- * Print a string. If the argument is <code>null</code> then the string
- * <code>"null"</code> is printed. Otherwise, the string's characters are
- * written to the JspWriter's buffer or, if no buffer is used, directly to
- * the underlying writer.
+ * Print a string. If the argument is <code>null</code> then the string <code>"null"</code> is printed. Otherwise,
+ * the string's characters are written to the JspWriter's buffer or, if no buffer is used, directly to the
+ * underlying writer.
*
- * @param s
- * The <code>String</code> to be printed
- * @throws java.io.IOException
- * If an error occurred while writing
+ * @param s The <code>String</code> to be printed
+ *
+ * @throws java.io.IOException If an error occurred while writing
*/
public abstract void print(String s) throws IOException;
/**
* Print an object. The string produced by the <code>{@link
- * java.lang.String#valueOf(Object)}</code>
- * method is written to the JspWriter's buffer or, if no buffer is used,
+ * java.lang.String#valueOf(Object)}</code> method is written to the JspWriter's buffer or, if no buffer is used,
* directly to the underlying writer.
*
- * @param obj
- * The <code>Object</code> to be printed
+ * @param obj The <code>Object</code> to be printed
+ *
* @see java.lang.Object#toString()
- * @throws java.io.IOException
- * If an error occurred while writing
+ *
+ * @throws java.io.IOException If an error occurred while writing
*/
public abstract void print(Object obj) throws IOException;
/**
- * Terminate the current line by writing the line separator string. The line
- * separator string is defined by the system property
- * <code>line.separator</code>, and is not necessarily a single newline
- * character (<code>'\n'</code>).
+ * Terminate the current line by writing the line separator string. The line separator string is defined by the
+ * system property <code>line.separator</code>, and is not necessarily a single newline character
+ * (<code>'\n'</code>).
*
- * @throws java.io.IOException
- * If an error occurred while writing
+ * @throws java.io.IOException If an error occurred while writing
*/
public abstract void println() throws IOException;
/**
- * Print a boolean value and then terminate the line. This method behaves as
- * though it invokes <code>{@link #print(boolean)}</code> and then
- * <code>{@link #println()}</code>.
+ * Print a boolean value and then terminate the line. This method behaves as though it invokes
+ * <code>{@link #print(boolean)}</code> and then <code>{@link #println()}</code>.
+ *
+ * @param x the boolean to write
*
- * @param x
- * the boolean to write
- * @throws java.io.IOException
- * If an error occurred while writing
+ * @throws java.io.IOException If an error occurred while writing
*/
public abstract void println(boolean x) throws IOException;
/**
- * Print a character and then terminate the line. This method behaves as
- * though it invokes <code>{@link #print(char)}</code> and then <code>{@link
- * #println()}</code>
- * .
+ * Print a character and then terminate the line. This method behaves as though it invokes
+ * <code>{@link #print(char)}</code> and then <code>{@link
+ * #println()}</code> .
+ *
+ * @param x the char to write
*
- * @param x
- * the char to write
- * @throws java.io.IOException
- * If an error occurred while writing
+ * @throws java.io.IOException If an error occurred while writing
*/
public abstract void println(char x) throws IOException;
/**
- * Print an integer and then terminate the line. This method behaves as
- * though it invokes <code>{@link #print(int)}</code> and then <code>{@link
- * #println()}</code>
- * .
+ * Print an integer and then terminate the line. This method behaves as though it invokes
+ * <code>{@link #print(int)}</code> and then <code>{@link
+ * #println()}</code> .
*
- * @param x
- * the int to write
- * @throws java.io.IOException
- * If an error occurred while writing
+ * @param x the int to write
+ *
+ * @throws java.io.IOException If an error occurred while writing
*/
public abstract void println(int x) throws IOException;
/**
- * Print a long integer and then terminate the line. This method behaves as
- * though it invokes <code>{@link #print(long)}</code> and then
- * <code>{@link #println()}</code>.
+ * Print a long integer and then terminate the line. This method behaves as though it invokes
+ * <code>{@link #print(long)}</code> and then <code>{@link #println()}</code>.
+ *
+ * @param x the long to write
*
- * @param x
- * the long to write
- * @throws java.io.IOException
- * If an error occurred while writing
+ * @throws java.io.IOException If an error occurred while writing
*/
public abstract void println(long x) throws IOException;
/**
- * Print a floating-point number and then terminate the line. This method
- * behaves as though it invokes <code>{@link #print(float)}</code> and then
- * <code>{@link #println()}</code>.
+ * Print a floating-point number and then terminate the line. This method behaves as though it invokes
+ * <code>{@link #print(float)}</code> and then <code>{@link #println()}</code>.
*
- * @param x
- * the float to write
- * @throws java.io.IOException
- * If an error occurred while writing
+ * @param x the float to write
+ *
+ * @throws java.io.IOException If an error occurred while writing
*/
public abstract void println(float x) throws IOException;
/**
- * Print a double-precision floating-point number and then terminate the
- * line. This method behaves as though it invokes <code>{@link
- * #print(double)}</code> and
- * then <code>{@link #println()}</code>.
+ * Print a double-precision floating-point number and then terminate the line. This method behaves as though it
+ * invokes <code>{@link
+ * #print(double)}</code> and then <code>{@link #println()}</code>.
+ *
+ * @param x the double to write
*
- * @param x
- * the double to write
- * @throws java.io.IOException
- * If an error occurred while writing
+ * @throws java.io.IOException If an error occurred while writing
*/
public abstract void println(double x) throws IOException;
/**
- * Print an array of characters and then terminate the line. This method
- * behaves as though it invokes <code>print(char[])</code> and then
- * <code>println()</code>.
+ * Print an array of characters and then terminate the line. This method behaves as though it invokes
+ * <code>print(char[])</code> and then <code>println()</code>.
*
- * @param x
- * the char[] to write
- * @throws java.io.IOException
- * If an error occurred while writing
+ * @param x the char[] to write
+ *
+ * @throws java.io.IOException If an error occurred while writing
*/
public abstract void println(char x[]) throws IOException;
/**
- * Print a String and then terminate the line. This method behaves as though
- * it invokes <code>{@link #print(String)}</code> and then
- * <code>{@link #println()}</code>.
+ * Print a String and then terminate the line. This method behaves as though it invokes
+ * <code>{@link #print(String)}</code> and then <code>{@link #println()}</code>.
+ *
+ * @param x the String to write
*
- * @param x
- * the String to write
- * @throws java.io.IOException
- * If an error occurred while writing
+ * @throws java.io.IOException If an error occurred while writing
*/
public abstract void println(String x) throws IOException;
/**
- * Print an Object and then terminate the line. This method behaves as
- * though it invokes <code>{@link #print(Object)}</code> and then
- * <code>{@link #println()}</code>.
+ * Print an Object and then terminate the line. This method behaves as though it invokes
+ * <code>{@link #print(Object)}</code> and then <code>{@link #println()}</code>.
+ *
+ * @param x the Object to write
*
- * @param x
- * the Object to write
- * @throws java.io.IOException
- * If an error occurred while writing
+ * @throws java.io.IOException If an error occurred while writing
*/
public abstract void println(Object x) throws IOException;
/**
- * Clear the contents of the buffer. If the buffer has been already been
- * flushed then the clear operation shall throw an IOException to signal the
- * fact that some data has already been irrevocably written to the client
+ * Clear the contents of the buffer. If the buffer has been already been flushed then the clear operation shall
+ * throw an IOException to signal the fact that some data has already been irrevocably written to the client
* response stream.
*
- * @throws IOException
- * If an I/O error occurs
+ * @throws IOException If an I/O error occurs
*/
public abstract void clear() throws IOException;
/**
- * Clears the current contents of the buffer. Unlike clear(), this method
- * will not throw an IOException if the buffer has already been flushed. It
- * merely clears the current content of the buffer and returns.
+ * Clears the current contents of the buffer. Unlike clear(), this method will not throw an IOException if the
+ * buffer has already been flushed. It merely clears the current content of the buffer and returns.
*
- * @throws IOException
- * If an I/O error occurs
+ * @throws IOException If an I/O error occurs
*/
public abstract void clearBuffer() throws IOException;
/**
- * Flush the stream. If the stream has saved any characters from the various
- * write() methods in a buffer, write them immediately to their intended
- * destination. Then, if that destination is another character or byte
- * stream, flush it. Thus one flush() invocation will flush all the buffers
- * in a chain of Writers and OutputStreams.
+ * Flush the stream. If the stream has saved any characters from the various write() methods in a buffer, write them
+ * immediately to their intended destination. Then, if that destination is another character or byte stream, flush
+ * it. Thus one flush() invocation will flush all the buffers in a chain of Writers and OutputStreams.
* <p>
* The method may be invoked indirectly if the buffer size is exceeded.
* <p>
- * Once a stream has been closed, further write() or flush() invocations
- * will cause an IOException to be thrown.
+ * Once a stream has been closed, further write() or flush() invocations will cause an IOException to be thrown.
*
- * @exception IOException
- * If an I/O error occurs
+ * @exception IOException If an I/O error occurs
*/
@Override
public abstract void flush() throws IOException;
@@ -403,14 +341,12 @@ public abstract class JspWriter extends java.io.Writer {
/**
* Close the stream, flushing it first.
* <p>
- * This method needs not be invoked explicitly for the initial JspWriter as
- * the code generated by the JSP container will automatically include a call
- * to close().
+ * This method needs not be invoked explicitly for the initial JspWriter as the code generated by the JSP container
+ * will automatically include a call to close().
* <p>
* Closing a previously-closed stream, unlike flush(), has no effect.
*
- * @exception IOException
- * If an I/O error occurs
+ * @exception IOException If an I/O error occurs
*/
@Override
public abstract void close() throws IOException;
@@ -434,8 +370,7 @@ public abstract class JspWriter extends java.io.Writer {
/**
* This method indicates whether the JspWriter is autoFlushing.
*
- * @return if this JspWriter is auto flushing or throwing IOExceptions on
- * buffer overflow conditions
+ * @return if this JspWriter is auto flushing or throwing IOExceptions on buffer overflow conditions
*/
public boolean isAutoFlush() {
return autoFlush;
diff --git a/java/javax/servlet/jsp/PageContext.java b/java/javax/servlet/jsp/PageContext.java
index 9d8d7ecdbd..0a1ee44af9 100644
--- a/java/javax/servlet/jsp/PageContext.java
+++ b/java/javax/servlet/jsp/PageContext.java
@@ -30,101 +30,83 @@ import javax.servlet.jsp.tagext.BodyContent;
/**
* <p>
- * PageContext extends JspContext to provide useful context information for
- * when JSP technology is used in a Servlet environment.
+ * PageContext extends JspContext to provide useful context information for when JSP technology is used in a Servlet
+ * environment.
* <p>
- * A PageContext instance provides access to all the namespaces associated
- * with a JSP page, provides access to several page attributes, as well as
- * a layer above the implementation details. Implicit objects are added
- * to the pageContext automatically.
- *
- * <p> The <code> PageContext </code> class is an abstract class, designed to be
- * extended to provide implementation dependent implementations thereof, by
- * conformant JSP engine runtime environments. A PageContext instance is
- * obtained by a JSP implementation class by calling the
- * JspFactory.getPageContext() method, and is released by calling
+ * A PageContext instance provides access to all the namespaces associated with a JSP page, provides access to several
+ * page attributes, as well as a layer above the implementation details. Implicit objects are added to the pageContext
+ * automatically.
+ * <p>
+ * The <code> PageContext </code> class is an abstract class, designed to be extended to provide implementation
+ * dependent implementations thereof, by conformant JSP engine runtime environments. A PageContext instance is obtained
+ * by a JSP implementation class by calling the JspFactory.getPageContext() method, and is released by calling
* JspFactory.releasePageContext().
- *
- * <p> An example of how PageContext, JspFactory, and other classes can be
- * used within a JSP Page Implementation object is given elsewhere.
- *
* <p>
- * The PageContext provides a number of facilities to the page/component
- * author and page implementor, including:
+ * An example of how PageContext, JspFactory, and other classes can be used within a JSP Page Implementation object is
+ * given elsewhere.
+ * <p>
+ * The PageContext provides a number of facilities to the page/component author and page implementor, including:
* <ul>
* <li>a single API to manage the various scoped namespaces
* <li>a number of convenience API's to access various public objects
* <li>a mechanism to obtain the JspWriter for output
* <li>a mechanism to manage session usage by the page
- * <li>a mechanism to expose page directive attributes to the scripting
- * environment
- * <li>mechanisms to forward or include the current request to other active
- * components in the application
+ * <li>a mechanism to expose page directive attributes to the scripting environment
+ * <li>mechanisms to forward or include the current request to other active components in the application
* <li>a mechanism to handle errorpage exception processing
* </ul>
- *
- * <p><B>Methods Intended for Container Generated Code</B>
- * <p>Some methods are intended to be used by the code generated by the
- * container, not by code written by JSP page authors, or JSP tag library
- * authors.
- * <p>The methods supporting <B>lifecycle</B> are <code>initialize()</code>
- * and <code>release()</code>
- *
* <p>
- * The following methods enable the <B>management of nested</B> JspWriter
- * streams to implement Tag Extensions: <code>pushBody()</code>
- *
- * <p><B>Methods Intended for JSP authors</B>
+ * <B>Methods Intended for Container Generated Code</B>
* <p>
- * The following methods provide <B>convenient access</B> to implicit objects:
- * <code>getException()</code>, <code>getPage()</code>
- * <code>getRequest()</code>, <code>getResponse()</code>,
- * <code>getSession()</code>, <code>getServletConfig()</code>
- * and <code>getServletContext()</code>.
- *
+ * Some methods are intended to be used by the code generated by the container, not by code written by JSP page authors,
+ * or JSP tag library authors.
+ * <p>
+ * The methods supporting <B>lifecycle</B> are <code>initialize()</code> and <code>release()</code>
+ * <p>
+ * The following methods enable the <B>management of nested</B> JspWriter streams to implement Tag Extensions:
+ * <code>pushBody()</code>
* <p>
- * The following methods provide support for <B>forwarding, inclusion
- * and error handling</B>:
- * <code>forward()</code>, <code>include()</code>,
- * and <code>handlePageException()</code>.
+ * <B>Methods Intended for JSP authors</B>
+ * <p>
+ * The following methods provide <B>convenient access</B> to implicit objects: <code>getException()</code>,
+ * <code>getPage()</code> <code>getRequest()</code>, <code>getResponse()</code>, <code>getSession()</code>,
+ * <code>getServletConfig()</code> and <code>getServletContext()</code>.
+ * <p>
+ * The following methods provide support for <B>forwarding, inclusion and error handling</B>: <code>forward()</code>,
+ * <code>include()</code>, and <code>handlePageException()</code>.
*/
public abstract class PageContext extends JspContext {
/**
- * Sole constructor. (For invocation by subclass constructors,
- * typically implicit.)
+ * Sole constructor. (For invocation by subclass constructors, typically implicit.)
*/
public PageContext() {
// NOOP by default
}
/**
- * Page scope: (this is the default) the named reference remains available
- * in this PageContext until the return from the current Servlet.service()
- * invocation.
+ * Page scope: (this is the default) the named reference remains available in this PageContext until the return from
+ * the current Servlet.service() invocation.
*/
public static final int PAGE_SCOPE = 1;
/**
- * Request scope: the named reference remains available from the
- * ServletRequest associated with the Servlet until the current request
- * is completed.
+ * Request scope: the named reference remains available from the ServletRequest associated with the Servlet until
+ * the current request is completed.
*/
public static final int REQUEST_SCOPE = 2;
/**
- * Session scope (only valid if this page participates in a session):
- * the named reference remains available from the HttpSession (if any)
- * associated with the Servlet until the HttpSession is invalidated.
+ * Session scope (only valid if this page participates in a session): the named reference remains available from the
+ * HttpSession (if any) associated with the Servlet until the HttpSession is invalidated.
*/
public static final int SESSION_SCOPE = 3;
/**
- * Application scope: named reference remains available in the
- * ServletContext until it is reclaimed.
+ * Application scope: named reference remains available in the ServletContext until it is reclaimed.
*/
public static final int APPLICATION_SCOPE = 4;
@@ -177,45 +159,34 @@ public abstract class PageContext extends JspContext {
public static final String APPLICATION = "javax.servlet.jsp.jspApplication";
/**
- * Name used to store uncaught exception in ServletRequest attribute
- * list and PageContext name table.
+ * Name used to store uncaught exception in ServletRequest attribute list and PageContext name table.
*/
public static final String EXCEPTION = "javax.servlet.jsp.jspException";
/**
* <p>
- * The initialize method is called to initialize an uninitialized PageContext
- * so that it may be used by a JSP Implementation class to service an
- * incoming request and response within it's _jspService() method.
- *
+ * The initialize method is called to initialize an uninitialized PageContext so that it may be used by a JSP
+ * Implementation class to service an incoming request and response within it's _jspService() method.
* <p>
- * This method is typically called from JspFactory.getPageContext() in
- * order to initialize state.
- *
+ * This method is typically called from JspFactory.getPageContext() in order to initialize state.
* <p>
- * This method is required to create an initial JspWriter, and associate
- * the "out" name in page scope with this newly created object.
- *
+ * This method is required to create an initial JspWriter, and associate the "out" name in page scope with this
+ * newly created object.
* <p>
* This method should not be used by page or tag library authors.
*
- * @param servlet The Servlet that is associated with this PageContext
- * @param request The currently pending request for this Servlet
- * @param response The currently pending response for this Servlet
- * @param errorPageURL The value of the errorpage attribute from the page
- * directive or null
- * @param needsSession The value of the session attribute from the
- * page directive
- * @param bufferSize The value of the buffer attribute from the page
- * directive
- * @param autoFlush The value of the autoflush attribute from the page
- * directive
- *
- * @throws IOException during creation of JspWriter
- * @throws IllegalStateException if out not correctly initialized
- * @throws IllegalArgumentException If one of the given parameters
- * is invalid
+ * @param servlet The Servlet that is associated with this PageContext
+ * @param request The currently pending request for this Servlet
+ * @param response The currently pending response for this Servlet
+ * @param errorPageURL The value of the errorpage attribute from the page directive or null
+ * @param needsSession The value of the session attribute from the page directive
+ * @param bufferSize The value of the buffer attribute from the page directive
+ * @param autoFlush The value of the autoflush attribute from the page directive
+ *
+ * @throws IOException during creation of JspWriter
+ * @throws IllegalStateException if out not correctly initialized
+ * @throws IllegalArgumentException If one of the given parameters is invalid
*/
public abstract void initialize(Servlet servlet, ServletRequest request, ServletResponse response,
@@ -224,17 +195,13 @@ public abstract class PageContext extends JspContext {
/**
* <p>
- * This method shall "reset" the internal state of a PageContext, releasing
- * all internal references, and preparing the PageContext for potential
- * reuse by a later invocation of initialize(). This method is typically
- * called from JspFactory.releasePageContext().
- *
+ * This method shall "reset" the internal state of a PageContext, releasing all internal references, and preparing
+ * the PageContext for potential reuse by a later invocation of initialize(). This method is typically called from
+ * JspFactory.releasePageContext().
* <p>
* Subclasses shall envelope this method.
- *
* <p>
- * This method should not be used by page or tag library authors.
- *
+ * This method should not be used by page or tag library authors.
*/
public abstract void release();
@@ -248,11 +215,9 @@ public abstract class PageContext extends JspContext {
public abstract HttpSession getSession();
/**
- * The current value of the page object (In a Servlet environment,
- * this is an instance of javax.servlet.Servlet).
+ * The current value of the page object (In a Servlet environment, this is an instance of javax.servlet.Servlet).
*
- * @return the Page implementation class instance associated
- * with this PageContext
+ * @return the Page implementation class instance associated with this PageContext
*/
public abstract Object getPage();
@@ -300,192 +265,151 @@ public abstract class PageContext extends JspContext {
/**
* <p>
- * This method is used to re-direct, or "forward" the current
- * ServletRequest and ServletResponse to another active component in
- * the application.
+ * This method is used to re-direct, or "forward" the current ServletRequest and ServletResponse to another active
+ * component in the application.
* </p>
* <p>
- * If the <I> relativeUrlPath </I> begins with a "/" then the URL specified
- * is calculated relative to the DOCROOT of the <code> ServletContext </code>
- * for this JSP. If the path does not begin with a "/" then the URL
- * specified is calculated relative to the URL of the request that was
- * mapped to the calling JSP.
+ * If the <I> relativeUrlPath </I> begins with a "/" then the URL specified is calculated relative to the DOCROOT of
+ * the <code> ServletContext </code> for this JSP. If the path does not begin with a "/" then the URL specified is
+ * calculated relative to the URL of the request that was mapped to the calling JSP.
* </p>
* <p>
- * It is only valid to call this method from a <code> Thread </code>
- * executing within a <code> _jspService(...) </code> method of a JSP.
+ * It is only valid to call this method from a <code> Thread </code> executing within a
+ * <code> _jspService(...) </code> method of a JSP.
* </p>
* <p>
- * Once this method has been called successfully, it is illegal for the
- * calling <code> Thread </code> to attempt to modify the <code>
- * ServletResponse </code> object. Any such attempt to do so, shall result
- * in undefined behavior. Typically, callers immediately return from
- * <code> _jspService(...) </code> after calling this method.
+ * Once this method has been called successfully, it is illegal for the calling <code> Thread </code> to attempt to
+ * modify the <code>
+ * ServletResponse </code> object. Any such attempt to do so, shall result in undefined behavior. Typically, callers
+ * immediately return from <code> _jspService(...) </code> after calling this method.
* </p>
*
- * @param relativeUrlPath specifies the relative URL path to the target
- * resource as described above
+ * @param relativeUrlPath specifies the relative URL path to the target resource as described above
*
- * @throws IllegalStateException if <code> ServletResponse </code> is not
- * in a state where a forward can be performed
- * @throws ServletException if the page that was forwarded to throws
- * a ServletException
- * @throws IOException if an I/O error occurred while forwarding
+ * @throws IllegalStateException if <code> ServletResponse </code> is not in a state where a forward can be
+ * performed
+ * @throws ServletException if the page that was forwarded to throws a ServletException
+ * @throws IOException if an I/O error occurred while forwarding
*/
- public abstract void forward(String relativeUrlPath)
- throws ServletException, IOException;
+ public abstract void forward(String relativeUrlPath) throws ServletException, IOException;
/**
* <p>
- * Causes the resource specified to be processed as part of the current
- * ServletRequest and ServletResponse being processed by the calling Thread.
- * The output of the target resources processing of the request is written
- * directly to the ServletResponse output stream.
+ * Causes the resource specified to be processed as part of the current ServletRequest and ServletResponse being
+ * processed by the calling Thread. The output of the target resources processing of the request is written directly
+ * to the ServletResponse output stream.
* </p>
* <p>
- * The current JspWriter "out" for this JSP is flushed as a side-effect
- * of this call, prior to processing the include.
+ * The current JspWriter "out" for this JSP is flushed as a side-effect of this call, prior to processing the
+ * include.
* </p>
* <p>
- * If the <I> relativeUrlPath </I> begins with a "/" then the URL specified
- * is calculated relative to the DOCROOT of the <code>ServletContext</code>
- * for this JSP. If the path does not begin with a "/" then the URL
- * specified is calculated relative to the URL of the request that was
- * mapped to the calling JSP.
+ * If the <I> relativeUrlPath </I> begins with a "/" then the URL specified is calculated relative to the DOCROOT of
+ * the <code>ServletContext</code> for this JSP. If the path does not begin with a "/" then the URL specified is
+ * calculated relative to the URL of the request that was mapped to the calling JSP.
* </p>
* <p>
- * It is only valid to call this method from a <code> Thread </code>
- * executing within a <code> _jspService(...) </code> method of a JSP.
+ * It is only valid to call this method from a <code> Thread </code> executing within a
+ * <code> _jspService(...) </code> method of a JSP.
* </p>
*
- * @param relativeUrlPath specifies the relative URL path to the target
- * resource to be included
+ * @param relativeUrlPath specifies the relative URL path to the target resource to be included
*
- * @throws ServletException if the page that was forwarded to throws
- * a ServletException
- * @throws IOException if an I/O error occurred while forwarding
+ * @throws ServletException if the page that was forwarded to throws a ServletException
+ * @throws IOException if an I/O error occurred while forwarding
*/
- public abstract void include(String relativeUrlPath)
- throws ServletException, IOException;
+ public abstract void include(String relativeUrlPath) throws ServletException, IOException;
/**
* <p>
- * Causes the resource specified to be processed as part of the current
- * ServletRequest and ServletResponse being processed by the calling Thread.
- * The output of the target resources processing of the request is written
- * directly to the current JspWriter returned by a call to getOut().
+ * Causes the resource specified to be processed as part of the current ServletRequest and ServletResponse being
+ * processed by the calling Thread. The output of the target resources processing of the request is written directly
+ * to the current JspWriter returned by a call to getOut().
* </p>
* <p>
- * If flush is true, The current JspWriter "out" for this JSP
- * is flushed as a side-effect of this call, prior to processing
- * the include. Otherwise, the JspWriter "out" is not flushed.
+ * If flush is true, The current JspWriter "out" for this JSP is flushed as a side-effect of this call, prior to
+ * processing the include. Otherwise, the JspWriter "out" is not flushed.
* </p>
* <p>
- * If the <i>relativeUrlPath</i> begins with a "/" then the URL specified
- * is calculated relative to the DOCROOT of the <code>ServletContext</code>
- * for this JSP. If the path does not begin with a "/" then the URL
- * specified is calculated relative to the URL of the request that was
- * mapped to the calling JSP.
+ * If the <i>relativeUrlPath</i> begins with a "/" then the URL specified is calculated relative to the DOCROOT of
+ * the <code>ServletContext</code> for this JSP. If the path does not begin with a "/" then the URL specified is
+ * calculated relative to the URL of the request that was mapped to the calling JSP.
* </p>
* <p>
- * It is only valid to call this method from a <code> Thread </code>
- * executing within a <code> _jspService(...) </code> method of a JSP.
+ * It is only valid to call this method from a <code> Thread </code> executing within a
+ * <code> _jspService(...) </code> method of a JSP.
* </p>
*
- * @param relativeUrlPath specifies the relative URL path to the
- * target resource to be included
- * @param flush True if the JspWriter is to be flushed before the include,
- * or false if not.
+ * @param relativeUrlPath specifies the relative URL path to the target resource to be included
+ * @param flush True if the JspWriter is to be flushed before the include, or false if not.
+ *
+ * @throws ServletException if the page that was forwarded to throws a ServletException
+ * @throws IOException if an I/O error occurred while forwarding
*
- * @throws ServletException if the page that was forwarded to throws
- * a ServletException
- * @throws IOException if an I/O error occurred while forwarding
* @since JSP 2.0
*/
- public abstract void include(String relativeUrlPath, boolean flush)
- throws ServletException, IOException;
+ public abstract void include(String relativeUrlPath, boolean flush) throws ServletException, IOException;
/**
* <p>
- * This method is intended to process an unhandled 'page' level
- * exception by forwarding the exception to the specified
- * error page for this JSP. If forwarding is not possible (for
- * example because the response has already been committed), an
- * implementation dependent mechanism should be used to invoke
- * the error page (e.g. "including" the error page instead).
- *
+ * This method is intended to process an unhandled 'page' level exception by forwarding the exception to the
+ * specified error page for this JSP. If forwarding is not possible (for example because the response has already
+ * been committed), an implementation dependent mechanism should be used to invoke the error page (e.g. "including"
+ * the error page instead).
* <p>
- * If no error page is defined in the page, the exception should
- * be rethrown so that the standard servlet error handling
- * takes over.
- *
+ * If no error page is defined in the page, the exception should be rethrown so that the standard servlet error
+ * handling takes over.
* <p>
- * A JSP implementation class shall typically clean up any local state
- * prior to invoking this and will return immediately thereafter. It is
- * illegal to generate any output to the client, or to modify any
- * ServletResponse state after invoking this call.
- *
+ * A JSP implementation class shall typically clean up any local state prior to invoking this and will return
+ * immediately thereafter. It is illegal to generate any output to the client, or to modify any ServletResponse
+ * state after invoking this call.
* <p>
- * This method is kept for backwards compatibility reasons. Newly
- * generated code should use PageContext.handlePageException(Throwable).
+ * This method is kept for backwards compatibility reasons. Newly generated code should use
+ * PageContext.handlePageException(Throwable).
*
* @param e the exception to be handled
*
- * @throws ServletException if an error occurs while invoking the error page
- * @throws IOException if an I/O error occurred while invoking the error
- * page
+ * @throws ServletException if an error occurs while invoking the error page
+ * @throws IOException if an I/O error occurred while invoking the error page
* @throws NullPointerException if the exception is null
*
* @see #handlePageException(Throwable)
*/
- public abstract void handlePageException(Exception e)
- throws ServletException, IOException;
+ public abstract void handlePageException(Exception e) throws ServletException, IOException;
/**
* <p>
- * This method is intended to process an unhandled 'page' level
- * exception by forwarding the exception to the specified
- * error page for this JSP. If forwarding is not possible (for
- * example because the response has already been committed), an
- * implementation dependent mechanism should be used to invoke
- * the error page (e.g. "including" the error page instead).
- *
+ * This method is intended to process an unhandled 'page' level exception by forwarding the exception to the
+ * specified error page for this JSP. If forwarding is not possible (for example because the response has already
+ * been committed), an implementation dependent mechanism should be used to invoke the error page (e.g. "including"
+ * the error page instead).
* <p>
- * If no error page is defined in the page, the exception should
- * be rethrown so that the standard servlet error handling
- * takes over.
- *
+ * If no error page is defined in the page, the exception should be rethrown so that the standard servlet error
+ * handling takes over.
* <p>
- * This method is intended to process an unhandled "page" level exception
- * by redirecting the exception to either the specified error page for this
- * JSP, or if none was specified, to perform some implementation dependent
- * action.
- *
+ * This method is intended to process an unhandled "page" level exception by redirecting the exception to either the
+ * specified error page for this JSP, or if none was specified, to perform some implementation dependent action.
* <p>
- * A JSP implementation class shall typically clean up any local state
- * prior to invoking this and will return immediately thereafter. It is
- * illegal to generate any output to the client, or to modify any
- * ServletResponse state after invoking this call.
+ * A JSP implementation class shall typically clean up any local state prior to invoking this and will return
+ * immediately thereafter. It is illegal to generate any output to the client, or to modify any ServletResponse
+ * state after invoking this call.
*
* @param t the throwable to be handled
*
- * @throws ServletException if an error occurs while invoking the error page
- * @throws IOException if an I/O error occurred while invoking the error
- * page
+ * @throws ServletException if an error occurs while invoking the error page
+ * @throws IOException if an I/O error occurred while invoking the error page
* @throws NullPointerException if the exception is null
*
* @see #handlePageException(Exception)
*/
- public abstract void handlePageException(Throwable t)
- throws ServletException, IOException;
+ public abstract void handlePageException(Throwable t) throws ServletException, IOException;
/**
- * Return a new BodyContent object, save the current "out" JspWriter,
- * and update the value of the "out" attribute in the page scope
- * attribute namespace of the PageContext.
+ * Return a new BodyContent object, save the current "out" JspWriter, and update the value of the "out" attribute in
+ * the page scope attribute namespace of the PageContext.
*
* @return the new BodyContent
*/
@@ -498,33 +422,24 @@ public abstract class PageContext extends JspContext {
/**
* Provides convenient access to error information.
*
- * @return an ErrorData instance containing information about the
- * error, as obtained from the request attributes, as per the
- * Servlet specification. If this is not an error page (that is,
- * if the isErrorPage attribute of the page directive is not set
- * to "true"), the information is meaningless.
+ * @return an ErrorData instance containing information about the error, as obtained from the request attributes, as
+ * per the Servlet specification. If this is not an error page (that is, if the isErrorPage attribute of
+ * the page directive is not set to "true"), the information is meaningless.
*
* @since JSP 2.0
*/
public ErrorData getErrorData() {
int status = 0;
- Integer status_code = (Integer)getRequest().getAttribute(
- RequestDispatcher.ERROR_STATUS_CODE);
+ Integer status_code = (Integer) getRequest().getAttribute(RequestDispatcher.ERROR_STATUS_CODE);
// Avoid NPE if attribute is not set
if (status_code != null) {
status = status_code.intValue();
}
- return new ErrorData(
- (Throwable)getRequest().getAttribute(
- RequestDispatcher.ERROR_EXCEPTION),
- status,
- (String)getRequest().getAttribute(
- RequestDispatcher.ERROR_REQUEST_URI),
- (String)getRequest().getAttribute(
- RequestDispatcher.ERROR_SERVLET_NAME)
- );
+ return new ErrorData((Throwable) getRequest().getAttribute(RequestDispatcher.ERROR_EXCEPTION), status,
+ (String) getRequest().getAttribute(RequestDispatcher.ERROR_REQUEST_URI),
+ (String) getRequest().getAttribute(RequestDispatcher.ERROR_SERVLET_NAME));
}
}
diff --git a/java/javax/servlet/jsp/SkipPageException.java b/java/javax/servlet/jsp/SkipPageException.java
index 5d6488bce3..3bdabbc024 100644
--- a/java/javax/servlet/jsp/SkipPageException.java
+++ b/java/javax/servlet/jsp/SkipPageException.java
@@ -17,19 +17,17 @@
package javax.servlet.jsp;
/**
- * Exception to indicate the calling page must cease evaluation. Thrown by a
- * simple tag handler to indicate that the remainder of the page must not be
- * evaluated. The result is propagated back to the page in the case where one
- * tag invokes another (as can be the case with tag files). The effect is
- * similar to that of a Classic Tag Handler returning Tag.SKIP_PAGE from
- * doEndTag(). Jsp Fragments may also throw this exception. This exception
- * should not be thrown manually in a JSP page or tag file - the behavior is
- * undefined. The exception is intended to be thrown inside SimpleTag handlers
- * and in JSP fragments.
+ * Exception to indicate the calling page must cease evaluation. Thrown by a simple tag handler to indicate that the
+ * remainder of the page must not be evaluated. The result is propagated back to the page in the case where one tag
+ * invokes another (as can be the case with tag files). The effect is similar to that of a Classic Tag Handler returning
+ * Tag.SKIP_PAGE from doEndTag(). Jsp Fragments may also throw this exception. This exception should not be thrown
+ * manually in a JSP page or tag file - the behavior is undefined. The exception is intended to be thrown inside
+ * SimpleTag handlers and in JSP fragments.
*
* @see javax.servlet.jsp.tagext.SimpleTag#doTag
* @see javax.servlet.jsp.tagext.JspFragment#invoke
* @see javax.servlet.jsp.tagext.Tag#doEndTag
+ *
* @since JSP 2.0
*/
public class SkipPageException extends JspException {
@@ -46,8 +44,7 @@ public class SkipPageException extends JspException {
/**
* Creates a SkipPageException with the provided message.
*
- * @param message
- * the detail message
+ * @param message the detail message
*/
public SkipPageException(String message) {
super(message);
@@ -56,10 +53,8 @@ public class SkipPageException extends JspException {
/**
* Creates a SkipPageException with the provided message and root cause.
*
- * @param message
- * the detail message
- * @param rootCause
- * the originating cause of this exception
+ * @param message the detail message
+ * @param rootCause the originating cause of this exception
*/
public SkipPageException(String message, Throwable rootCause) {
super(message, rootCause);
@@ -68,8 +63,7 @@ public class SkipPageException extends JspException {
/**
* Creates a SkipPageException with the provided root cause.
*
- * @param rootCause
- * the originating cause of this exception
+ * @param rootCause the originating cause of this exception
*/
public SkipPageException(Throwable rootCause) {
super(rootCause);
diff --git a/java/javax/servlet/jsp/el/ELException.java b/java/javax/servlet/jsp/el/ELException.java
index cbff7c5b6d..183f5185f7 100644
--- a/java/javax/servlet/jsp/el/ELException.java
+++ b/java/javax/servlet/jsp/el/ELException.java
@@ -17,10 +17,10 @@
package javax.servlet.jsp.el;
/**
- * Represents any of the exception conditions that arise during the operation
- * evaluation of the evaluator.
+ * Represents any of the exception conditions that arise during the operation evaluation of the evaluator.
*
* @since JSP 2.0
+ *
* @deprecated As of JSP 2.1, replaced by javax.el.ELException
*/
@SuppressWarnings("dep-ann") // TCK signature test fails with annotation
@@ -38,8 +38,7 @@ public class ELException extends Exception {
/**
* Creates an ELException with the provided detail message.
*
- * @param pMessage
- * the detail message
+ * @param pMessage the detail message
**/
public ELException(String pMessage) {
super(pMessage);
@@ -48,8 +47,7 @@ public class ELException extends Exception {
/**
* Creates an ELException with the given root cause.
*
- * @param pRootCause
- * the originating cause of this exception
+ * @param pRootCause the originating cause of this exception
**/
public ELException(Throwable pRootCause) {
super(pRootCause);
@@ -59,10 +57,8 @@ public class ELException extends Exception {
/**
* Creates an ELException with the given detail message and root cause.
*
- * @param pMessage
- * the detail message
- * @param pRootCause
- * the originating cause of this exception
+ * @param pMessage the detail message
+ * @param pRootCause the originating cause of this exception
**/
public ELException(String pMessage, Throwable pRootCause) {
super(pMessage, pRootCause);
diff --git a/java/javax/servlet/jsp/el/ELParseException.java b/java/javax/servlet/jsp/el/ELParseException.java
index 151c4f3872..3cc73ad6c1 100644
--- a/java/javax/servlet/jsp/el/ELParseException.java
+++ b/java/javax/servlet/jsp/el/ELParseException.java
@@ -21,6 +21,7 @@ package javax.servlet.jsp.el;
* Represents a parsing error encountered while parsing an EL expression.
*
* @since JSP 2.0
+ *
* @deprecated As of JSP 2.1, replaced by javax.el.ELException
*/
@SuppressWarnings("dep-ann") // TCK signature test fails with annotation
@@ -32,8 +33,8 @@ public class ELParseException extends ELException {
/**
* Creates an ELParseException with no detail message.
*/
- public ELParseException () {
- super ();
+ public ELParseException() {
+ super();
}
@@ -42,7 +43,7 @@ public class ELParseException extends ELException {
*
* @param pMessage the detail message
*/
- public ELParseException (String pMessage) {
- super (pMessage);
+ public ELParseException(String pMessage) {
+ super(pMessage);
}
}
diff --git a/java/javax/servlet/jsp/el/Expression.java b/java/javax/servlet/jsp/el/Expression.java
index 8f0d7d137f..6ee4890ca9 100644
--- a/java/javax/servlet/jsp/el/Expression.java
+++ b/java/javax/servlet/jsp/el/Expression.java
@@ -18,35 +18,36 @@ package javax.servlet.jsp.el;
/**
- * <p>The abstract class for a prepared expression.</p>
- *
- * <p>An instance of an Expression can be obtained via from an
- * ExpressionEvaluator instance.</p>
- *
- * <p>An Expression may or not have done a syntactic parse of the expression.
- * A client invoking the evaluate() method should be ready for the case
- * where ELParseException exceptions are raised. </p>
+ * <p>
+ * The abstract class for a prepared expression.
+ * </p>
+ * <p>
+ * An instance of an Expression can be obtained via from an ExpressionEvaluator instance.
+ * </p>
+ * <p>
+ * An Expression may or not have done a syntactic parse of the expression. A client invoking the evaluate() method
+ * should be ready for the case where ELParseException exceptions are raised.
+ * </p>
*
* @since JSP 2.0
+ *
* @deprecated As of JSP 2.1, replaced by javax.el.ValueExpression
*/
@SuppressWarnings("dep-ann") // TCK signature test fails with annotation
public abstract class Expression {
/**
- * Evaluates an expression that was previously prepared. In some
- * implementations preparing an expression involves full syntactic
- * validation, but others may not do so. Evaluating the expression may
- * raise an ELParseException as well as other ELExceptions due to
- * run-time evaluation.
+ * Evaluates an expression that was previously prepared. In some implementations preparing an expression involves
+ * full syntactic validation, but others may not do so. Evaluating the expression may raise an ELParseException as
+ * well as other ELExceptions due to run-time evaluation.
+ *
+ * @param vResolver A VariableResolver instance that can be used at runtime to resolve the name of implicit objects
+ * into Objects.
*
- * @param vResolver A VariableResolver instance that can be used at
- * runtime to resolve the name of implicit objects into Objects.
* @return The result of the expression evaluation.
*
* @exception ELException Thrown if the expression evaluation failed.
*/
- public abstract Object evaluate( VariableResolver vResolver )
- throws ELException;
+ public abstract Object evaluate(VariableResolver vResolver) throws ELException;
}
diff --git a/java/javax/servlet/jsp/el/ExpressionEvaluator.java b/java/javax/servlet/jsp/el/ExpressionEvaluator.java
index 54c1cb6bcb..cd6ae76721 100644
--- a/java/javax/servlet/jsp/el/ExpressionEvaluator.java
+++ b/java/javax/servlet/jsp/el/ExpressionEvaluator.java
@@ -18,28 +18,23 @@ package javax.servlet.jsp.el;
/**
* <p>
- * The abstract base class for an expression-language evaluator. Classes that
- * implement an expression language expose their functionality via this abstract
- * class.
+ * The abstract base class for an expression-language evaluator. Classes that implement an expression language expose
+ * their functionality via this abstract class.
* </p>
* <p>
- * An instance of the ExpressionEvaluator can be obtained via the JspContext /
- * PageContext
+ * An instance of the ExpressionEvaluator can be obtained via the JspContext / PageContext
* </p>
* <p>
- * The parseExpression() and evaluate() methods must be thread-safe. That is,
- * multiple threads may call these methods on the same ExpressionEvaluator
- * object simultaneously. Implementations should synchronize access if they
- * depend on transient state. Implementations should not, however, assume that
- * only one object of each ExpressionEvaluator type will be instantiated; global
- * caching should therefore be static.
+ * The parseExpression() and evaluate() methods must be thread-safe. That is, multiple threads may call these methods on
+ * the same ExpressionEvaluator object simultaneously. Implementations should synchronize access if they depend on
+ * transient state. Implementations should not, however, assume that only one object of each ExpressionEvaluator type
+ * will be instantiated; global caching should therefore be static.
* </p>
* <p>
- * Only a single EL expression, starting with '${' and ending with '}', can be
- * parsed or evaluated at a time. EL expressions cannot be mixed with static
- * text. For example, attempting to parse or evaluate "
- * <code>abc${1+1}def${1+1}ghi</code>" or even "<code>${1+1}${1+1}</code>" will
- * cause an <code>ELException</code> to be thrown.
+ * Only a single EL expression, starting with '${' and ending with '}', can be parsed or evaluated at a time. EL
+ * expressions cannot be mixed with static text. For example, attempting to parse or evaluate "
+ * <code>abc${1+1}def${1+1}ghi</code>" or even "<code>${1+1}${1+1}</code>" will cause an <code>ELException</code> to be
+ * thrown.
* </p>
* <p>
* The following are examples of syntactically legal EL expressions:
@@ -51,6 +46,7 @@ package javax.servlet.jsp.el;
* </ul>
*
* @since JSP 2.0
+ *
* @deprecated As of JSP 2.1, replaced by javax.el.ExpressionFactory
*/
@SuppressWarnings("dep-ann")
@@ -58,57 +54,44 @@ package javax.servlet.jsp.el;
public abstract class ExpressionEvaluator {
/**
- * Prepare an expression for later evaluation. This method should perform
- * syntactic validation of the expression; if in doing so it detects errors,
- * it should raise an ELParseException.
+ * Prepare an expression for later evaluation. This method should perform syntactic validation of the expression; if
+ * in doing so it detects errors, it should raise an ELParseException.
+ *
+ * @param expression The expression to be evaluated.
+ * @param expectedType The expected type of the result of the evaluation
+ * @param fMapper A FunctionMapper to resolve functions found in the expression. It can be null, in which case
+ * no functions are supported for this invocation. The ExpressionEvaluator must not hold on
+ * to the FunctionMapper reference after returning from <code>parseExpression()</code>. The
+ * <code>Expression</code> object returned must invoke the same functions regardless of
+ * whether the mappings in the provided <code>FunctionMapper</code> instance change between
+ * calling <code>ExpressionEvaluator.parseExpression()</code> and
+ * <code>Expression.evaluate()</code>.
*
- * @param expression
- * The expression to be evaluated.
- * @param expectedType
- * The expected type of the result of the evaluation
- * @param fMapper
- * A FunctionMapper to resolve functions found in the expression.
- * It can be null, in which case no functions are supported for
- * this invocation. The ExpressionEvaluator must not hold on to
- * the FunctionMapper reference after returning from
- * <code>parseExpression()</code>. The <code>Expression</code>
- * object returned must invoke the same functions regardless of
- * whether the mappings in the provided
- * <code>FunctionMapper</code> instance change between calling
- * <code>ExpressionEvaluator.parseExpression()</code> and
- * <code>Expression.evaluate()</code>.
* @return The Expression object encapsulating the arguments.
- * @exception ELException
- * Thrown if parsing errors were found.
+ *
+ * @exception ELException Thrown if parsing errors were found.
*/
- public abstract Expression parseExpression(String expression,
- @SuppressWarnings("rawtypes")// TCK signature fails with generics
- Class expectedType, FunctionMapper fMapper) throws ELException;
+ public abstract Expression parseExpression(String expression, @SuppressWarnings("rawtypes") // TCK signature fails
+ // with generics
+ Class expectedType, FunctionMapper fMapper) throws ELException;
/**
- * Evaluates an expression. This method may perform some syntactic
- * validation and, if so, it should raise an ELParseException error if it
- * encounters syntactic errors. EL evaluation errors should cause an
- * ELException to be raised.
+ * Evaluates an expression. This method may perform some syntactic validation and, if so, it should raise an
+ * ELParseException error if it encounters syntactic errors. EL evaluation errors should cause an ELException to be
+ * raised.
+ *
+ * @param expression The expression to be evaluated.
+ * @param expectedType The expected type of the result of the evaluation
+ * @param vResolver A VariableResolver instance that can be used at runtime to resolve the name of implicit
+ * objects into Objects.
+ * @param fMapper A FunctionMapper to resolve functions found in the expression. It can be null, in which case
+ * no functions are supported for this invocation.
*
- * @param expression
- * The expression to be evaluated.
- * @param expectedType
- * The expected type of the result of the evaluation
- * @param vResolver
- * A VariableResolver instance that can be used at runtime to
- * resolve the name of implicit objects into Objects.
- * @param fMapper
- * A FunctionMapper to resolve functions found in the expression.
- * It can be null, in which case no functions are supported for
- * this invocation.
* @return The result of the expression evaluation.
- * @exception ELException
- * Thrown if the expression evaluation failed.
+ *
+ * @exception ELException Thrown if the expression evaluation failed.
*/
- public abstract Object evaluate(
- String expression,
- @SuppressWarnings("rawtypes")// TCK signature fails with generics
- Class expectedType, VariableResolver vResolver,
- FunctionMapper fMapper) throws ELException;
+ public abstract Object evaluate(String expression, @SuppressWarnings("rawtypes") // TCK signature fails with
+ // generics
+ Class expectedType, VariableResolver vResolver, FunctionMapper fMapper) throws ELException;
}
diff --git a/java/javax/servlet/jsp/el/FunctionMapper.java b/java/javax/servlet/jsp/el/FunctionMapper.java
index 3465c81f77..640fb77ea6 100644
--- a/java/javax/servlet/jsp/el/FunctionMapper.java
+++ b/java/javax/servlet/jsp/el/FunctionMapper.java
@@ -17,23 +17,27 @@
package javax.servlet.jsp.el;
/**
- * <p>The interface to a map between EL function names and methods.</p>
- *
- * <p>Classes implementing this interface may, for instance, consult tag library
- * information to resolve the map. </p>
+ * <p>
+ * The interface to a map between EL function names and methods.
+ * </p>
+ * <p>
+ * Classes implementing this interface may, for instance, consult tag library information to resolve the map.
+ * </p>
*
* @since JSP 2.0
+ *
* @deprecated As of JSP 2.1, replaced by javax.el.FunctionMapper
*/
@SuppressWarnings("dep-ann") // TCK signature test fails with annotation
public interface FunctionMapper {
/**
- * Resolves the specified local name and prefix into a Java.lang.Method.
- * Returns null if the prefix and local name are not found.
+ * Resolves the specified local name and prefix into a Java.lang.Method. Returns null if the prefix and local name
+ * are not found.
*
- * @param prefix the prefix of the function, or "" if no prefix.
+ * @param prefix the prefix of the function, or "" if no prefix.
* @param localName the short name of the function
- * @return the result of the method mapping. Null means no entry found.
+ *
+ * @return the result of the method mapping. Null means no entry found.
*/
java.lang.reflect.Method resolveFunction(String prefix, String localName);
}
diff --git a/java/javax/servlet/jsp/el/ImplicitObjectELResolver.java b/java/javax/servlet/jsp/el/ImplicitObjectELResolver.java
index c2533026eb..24116e2aeb 100644
--- a/java/javax/servlet/jsp/el/ImplicitObjectELResolver.java
+++ b/java/javax/servlet/jsp/el/ImplicitObjectELResolver.java
@@ -45,10 +45,8 @@ import javax.servlet.jsp.PageContext;
*/
public class ImplicitObjectELResolver extends ELResolver {
- private static final String[] SCOPE_NAMES = new String[] {
- "applicationScope", "cookie", "header", "headerValues",
- "initParam", "pageContext", "pageScope", "param", "paramValues",
- "requestScope", "sessionScope" };
+ private static final String[] SCOPE_NAMES = new String[] { "applicationScope", "cookie", "header", "headerValues",
+ "initParam", "pageContext", "pageScope", "param", "paramValues", "requestScope", "sessionScope" };
private static final int APPLICATIONSCOPE = 0;
@@ -87,8 +85,7 @@ public class ImplicitObjectELResolver extends ELResolver {
int idx = Arrays.binarySearch(SCOPE_NAMES, property.toString());
if (idx >= 0) {
- PageContext page = (PageContext) context
- .getContext(JspContext.class);
+ PageContext page = (PageContext) context.getContext(JspContext.class);
context.setPropertyResolved(base, property);
switch (idx) {
case APPLICATIONSCOPE:
@@ -134,8 +131,7 @@ public class ImplicitObjectELResolver extends ELResolver {
}
@Override
- public void setValue(ELContext context, Object base, Object property,
- Object value) {
+ public void setValue(ELContext context, Object base, Object property, Object value) {
Objects.requireNonNull(context);
if (base == null && property != null) {
@@ -291,14 +287,12 @@ public class ImplicitObjectELResolver extends ELResolver {
this.header = new ScopeMap<String>() {
@Override
protected Enumeration<String> getAttributeNames() {
- return ((HttpServletRequest) page.getRequest())
- .getHeaderNames();
+ return ((HttpServletRequest) page.getRequest()).getHeaderNames();
}
@Override
protected String getAttribute(String name) {
- return ((HttpServletRequest) page.getRequest())
- .getHeader(name);
+ return ((HttpServletRequest) page.getRequest()).getHeader(name);
}
};
}
@@ -310,8 +304,7 @@ public class ImplicitObjectELResolver extends ELResolver {
this.headerValues = new ScopeMap<String[]>() {
@Override
protected Enumeration<String> getAttributeNames() {
- return ((HttpServletRequest) page.getRequest())
- .getHeaderNames();
+ return ((HttpServletRequest) page.getRequest()).getHeaderNames();
}
@Override
@@ -368,8 +361,7 @@ public class ImplicitObjectELResolver extends ELResolver {
@Override
protected Enumeration<String> getAttributeNames() {
- return page.getAttributeNamesInScope(
- PageContext.PAGE_SCOPE);
+ return page.getAttributeNamesInScope(PageContext.PAGE_SCOPE);
}
@Override
@@ -447,8 +439,7 @@ public class ImplicitObjectELResolver extends ELResolver {
this.sessionScope = new ScopeMap<Object>() {
@Override
protected void setAttribute(String name, Object value) {
- ((HttpServletRequest) page.getRequest()).getSession()
- .setAttribute(name, value);
+ ((HttpServletRequest) page.getRequest()).getSession().setAttribute(name, value);
}
@Override
@@ -501,7 +492,7 @@ public class ImplicitObjectELResolver extends ELResolver {
@Override
public final Set<Map.Entry<String,V>> entrySet() {
Enumeration<String> e = getAttributeNames();
- Set<Map.Entry<String, V>> set = new HashSet<>();
+ Set<Map.Entry<String,V>> set = new HashSet<>();
if (e != null) {
while (e.hasMoreElements()) {
set.add(new ScopeEntry(e.nextElement()));
diff --git a/java/javax/servlet/jsp/el/ScopedAttributeELResolver.java b/java/javax/servlet/jsp/el/ScopedAttributeELResolver.java
index 6f709b3359..68f6ef4eb8 100644
--- a/java/javax/servlet/jsp/el/ScopedAttributeELResolver.java
+++ b/java/javax/servlet/jsp/el/ScopedAttributeELResolver.java
@@ -31,8 +31,7 @@ import javax.servlet.jsp.JspContext;
import javax.servlet.jsp.PageContext;
/**
- * An ELResolver for working with JSP scoped attributes which may have page,
- * request, session or application scope.
+ * An ELResolver for working with JSP scoped attributes which may have page, request, session or application scope.
*
* @since JSP 2.1
*/
@@ -47,7 +46,7 @@ public class ScopedAttributeELResolver extends ELResolver {
key = Class.forName("org.apache.el.parser.AstIdentifier");
} catch (Exception e) {
// Ignore: Expected if not running on Tomcat. Not a problem since
- // this just allows a short-cut.
+ // this just allows a short-cut.
}
AST_IDENTIFIER_KEY = key;
}
@@ -102,8 +101,8 @@ public class ScopedAttributeELResolver extends ELResolver {
if (clazz != null) {
try {
result = clazz.getField(key).get(null);
- } catch (IllegalArgumentException | IllegalAccessException |
- NoSuchFieldException | SecurityException e) {
+ } catch (IllegalArgumentException | IllegalAccessException | NoSuchFieldException |
+ SecurityException e) {
// Most (all?) of these should have been
// prevented by the checks when the import
// was defined.
diff --git a/java/javax/servlet/jsp/el/VariableResolver.java b/java/javax/servlet/jsp/el/VariableResolver.java
index b9a7754e32..0b33fe9498 100644
--- a/java/javax/servlet/jsp/el/VariableResolver.java
+++ b/java/javax/servlet/jsp/el/VariableResolver.java
@@ -18,18 +18,17 @@ package javax.servlet.jsp.el;
/**
* <p>
- * This class is used to customize the way an ExpressionEvaluator resolves
- * variable references at evaluation time. For example, instances of this class
- * can implement their own variable lookup mechanisms, or introduce the notion
- * of "implicit variables" which override any other variables. An instance of
- * this class should be passed when evaluating an expression.
+ * This class is used to customize the way an ExpressionEvaluator resolves variable references at evaluation time. For
+ * example, instances of this class can implement their own variable lookup mechanisms, or introduce the notion of
+ * "implicit variables" which override any other variables. An instance of this class should be passed when evaluating
+ * an expression.
* </p>
* <p>
- * An instance of this class includes the context against which resolution will
- * happen
+ * An instance of this class includes the context against which resolution will happen
* </p>
*
* @since JSP 2.0
+ *
* @deprecated As of JSP 2.1, replaced by javax.el.ELResolver
*/
@SuppressWarnings("dep-ann")
@@ -37,15 +36,13 @@ package javax.servlet.jsp.el;
public interface VariableResolver {
/**
- * Resolves the specified variable. Returns null if the variable is not
- * found.
+ * Resolves the specified variable. Returns null if the variable is not found.
+ *
+ * @param pName the name of the variable to resolve
*
- * @param pName
- * the name of the variable to resolve
* @return the result of the variable resolution
- * @throws ELException
- * if a failure occurred while trying to resolve the given
- * variable
+ *
+ * @throws ELException if a failure occurred while trying to resolve the given variable
*/
Object resolveVariable(String pName) throws ELException;
}
diff --git a/java/javax/servlet/jsp/tagext/BodyContent.java b/java/javax/servlet/jsp/tagext/BodyContent.java
index 92c23e2319..cb1b1697d5 100644
--- a/java/javax/servlet/jsp/tagext/BodyContent.java
+++ b/java/javax/servlet/jsp/tagext/BodyContent.java
@@ -23,34 +23,30 @@ import java.io.Writer;
import javax.servlet.jsp.JspWriter;
/**
- * An encapsulation of the evaluation of the body of an action so it is
- * available to a tag handler. BodyContent is a subclass of JspWriter.
+ * An encapsulation of the evaluation of the body of an action so it is available to a tag handler. BodyContent is a
+ * subclass of JspWriter.
* <p>
- * Note that the content of BodyContent is the result of evaluation, so it will
- * not contain actions and the like, but the result of their invocation.
+ * Note that the content of BodyContent is the result of evaluation, so it will not contain actions and the like, but
+ * the result of their invocation.
* <p>
- * BodyContent has methods to convert its contents into a String, to read its
- * contents, and to clear the contents.
+ * BodyContent has methods to convert its contents into a String, to read its contents, and to clear the contents.
* <p>
- * The buffer size of a BodyContent object is unbounded. A BodyContent object
- * cannot be in autoFlush mode. It is not possible to invoke flush on a
- * BodyContent object, as there is no backing stream.
+ * The buffer size of a BodyContent object is unbounded. A BodyContent object cannot be in autoFlush mode. It is not
+ * possible to invoke flush on a BodyContent object, as there is no backing stream.
* <p>
- * Instances of BodyContent are created by invoking the pushBody and popBody
- * methods of the PageContext class. A BodyContent is enclosed within another
- * JspWriter (maybe another BodyContent object) following the structure of their
+ * Instances of BodyContent are created by invoking the pushBody and popBody methods of the PageContext class. A
+ * BodyContent is enclosed within another JspWriter (maybe another BodyContent object) following the structure of their
* associated actions.
* <p>
- * A BodyContent is made available to a BodyTag through a setBodyContent() call.
- * The tag handler can use the object until after the call to doEndTag().
+ * A BodyContent is made available to a BodyTag through a setBodyContent() call. The tag handler can use the object
+ * until after the call to doEndTag().
*/
public abstract class BodyContent extends JspWriter {
/**
* Protected constructor. Unbounded buffer, no autoflushing.
*
- * @param e
- * the enclosing JspWriter
+ * @param e the enclosing JspWriter
*/
protected BodyContent(JspWriter e) {
super(UNBOUNDED_BUFFER, false);
@@ -60,11 +56,9 @@ public abstract class BodyContent extends JspWriter {
/**
* Redefined flush() so it is not legal.
* <p>
- * It is not valid to flush a BodyContent because there is no backing stream
- * behind it.
+ * It is not valid to flush a BodyContent because there is no backing stream behind it.
*
- * @throws IOException
- * always thrown
+ * @throws IOException always thrown
*/
@Override
public void flush() throws IOException {
@@ -98,15 +92,11 @@ public abstract class BodyContent extends JspWriter {
public abstract String getString();
/**
- * Write the contents of this BodyContent into a Writer. Subclasses may
- * optimize common invocation patterns.
+ * Write the contents of this BodyContent into a Writer. Subclasses may optimize common invocation patterns.
*
- * @param out
- * The writer into which to place the contents of this body
- * evaluation
- * @throws IOException
- * if an I/O error occurred while writing the contents of this
- * BodyContent to the given Writer
+ * @param out The writer into which to place the contents of this body evaluation
+ *
+ * @throws IOException if an I/O error occurred while writing the contents of this BodyContent to the given Writer
*/
public abstract void writeOut(Writer out) throws IOException;
diff --git a/java/javax/servlet/jsp/tagext/BodyTag.java b/java/javax/servlet/jsp/tagext/BodyTag.java
index f94733f699..19a79f74e0 100644
--- a/java/javax/servlet/jsp/tagext/BodyTag.java
+++ b/java/javax/servlet/jsp/tagext/BodyTag.java
@@ -20,142 +20,115 @@ import javax.servlet.jsp.JspException;
/**
- * The BodyTag interface extends IterationTag by defining additional methods
- * that let a tag handler manipulate the content of evaluating its body.
+ * The BodyTag interface extends IterationTag by defining additional methods that let a tag handler manipulate the
+ * content of evaluating its body.
* <p>
- * It is the responsibility of the tag handler to manipulate the body content.
- * For example the tag handler may take the body content, convert it into a
- * String using the bodyContent.getString method and then use it. Or the tag
- * handler may take the body content and write it out into its enclosing
- * JspWriter using the bodyContent.writeOut method.
+ * It is the responsibility of the tag handler to manipulate the body content. For example the tag handler may take the
+ * body content, convert it into a String using the bodyContent.getString method and then use it. Or the tag handler may
+ * take the body content and write it out into its enclosing JspWriter using the bodyContent.writeOut method.
* <p>
- * A tag handler that implements BodyTag is treated as one that implements
- * IterationTag, except that the doStartTag method can return SKIP_BODY,
- * EVAL_BODY_INCLUDE or EVAL_BODY_BUFFERED.
+ * A tag handler that implements BodyTag is treated as one that implements IterationTag, except that the doStartTag
+ * method can return SKIP_BODY, EVAL_BODY_INCLUDE or EVAL_BODY_BUFFERED.
* <p>
* If EVAL_BODY_INCLUDE is returned, then evaluation happens as in IterationTag.
* <p>
- * If EVAL_BODY_BUFFERED is returned, then a BodyContent object will be created
- * (by code generated by the JSP compiler) to capture the body evaluation. The
- * code generated by the JSP compiler obtains the BodyContent object by calling
- * the pushBody method of the current pageContext, which additionally has the
- * effect of saving the previous out value. The page compiler returns this
- * object by calling the popBody method of the PageContext class; the call also
- * restores the value of out.
+ * If EVAL_BODY_BUFFERED is returned, then a BodyContent object will be created (by code generated by the JSP compiler)
+ * to capture the body evaluation. The code generated by the JSP compiler obtains the BodyContent object by calling the
+ * pushBody method of the current pageContext, which additionally has the effect of saving the previous out value. The
+ * page compiler returns this object by calling the popBody method of the PageContext class; the call also restores the
+ * value of out.
* <p>
- * The interface provides one new property with a setter method and one new
- * action method.
+ * The interface provides one new property with a setter method and one new action method.
* <p>
* <B>Properties</B>
* <p>
- * There is a new property: bodyContent, to contain the BodyContent object,
- * where the JSP Page implementation object will place the evaluation (and
- * reevaluation, if appropriate) of the body. The setter method (setBodyContent)
- * will only be invoked if doStartTag() returns EVAL_BODY_BUFFERED and the
- * corresponding action element does not have an empty body.
+ * There is a new property: bodyContent, to contain the BodyContent object, where the JSP Page implementation object
+ * will place the evaluation (and reevaluation, if appropriate) of the body. The setter method (setBodyContent) will
+ * only be invoked if doStartTag() returns EVAL_BODY_BUFFERED and the corresponding action element does not have an
+ * empty body.
* <p>
* <B>Methods</B>
* <p>
- * In addition to the setter method for the bodyContent property, there is a new
- * action method: doInitBody(), which is invoked right after setBodyContent()
- * and before the body evaluation. This method is only invoked if doStartTag()
+ * In addition to the setter method for the bodyContent property, there is a new action method: doInitBody(), which is
+ * invoked right after setBodyContent() and before the body evaluation. This method is only invoked if doStartTag()
* returns EVAL_BODY_BUFFERED.
* <p>
* <B>Lifecycle</B>
* <p>
- * Lifecycle details are described by the transition diagram below. Exceptions
- * that are thrown during the computation of doStartTag(), setBodyContent(),
- * doInitBody(), BODY, doAfterBody() interrupt the execution sequence and are
- * propagated up the stack, unless the tag handler implements the
- * TryCatchFinally interface; see that interface for details.
+ * Lifecycle details are described by the transition diagram below. Exceptions that are thrown during the computation of
+ * doStartTag(), setBodyContent(), doInitBody(), BODY, doAfterBody() interrupt the execution sequence and are propagated
+ * up the stack, unless the tag handler implements the TryCatchFinally interface; see that interface for details.
* <p>
- * <IMG src="doc-files/BodyTagProtocol.gif"
- * alt="Lifecycle Details Transition Diagram for BodyTag">
+ * <IMG src="doc-files/BodyTagProtocol.gif" alt="Lifecycle Details Transition Diagram for BodyTag">
* <p>
* <B>Empty and Non-Empty Action</B>
* <p>
- * If the TagLibraryDescriptor file indicates that the action must always have
- * an empty element body, by an <body-content> entry of "empty", then the
- * doStartTag() method must return SKIP_BODY. Otherwise, the doStartTag() method
- * may return SKIP_BODY, EVAL_BODY_INCLUDE, or EVAL_BODY_BUFFERED.
+ * If the TagLibraryDescriptor file indicates that the action must always have an empty element body, by an
+ * <body-content> entry of "empty", then the doStartTag() method must return SKIP_BODY. Otherwise, the
+ * doStartTag() method may return SKIP_BODY, EVAL_BODY_INCLUDE, or EVAL_BODY_BUFFERED.
* <p>
- * Note that which methods are invoked after the doStartTag() depends on both
- * the return value and on if the custom action element is empty or not in the
- * JSP page, not how it's declared in the TLD.
+ * Note that which methods are invoked after the doStartTag() depends on both the return value and on if the custom
+ * action element is empty or not in the JSP page, not how it's declared in the TLD.
* <p>
- * If SKIP_BODY is returned the body is not evaluated, and doEndTag() is
- * invoked.
+ * If SKIP_BODY is returned the body is not evaluated, and doEndTag() is invoked.
* <p>
- * If EVAL_BODY_INCLUDE is returned, and the custom action element is not empty,
- * setBodyContent() is not invoked, doInitBody() is not invoked, the body is
- * evaluated and "passed through" to the current out, doAfterBody() is invoked
- * and then, after zero or more iterations, doEndTag() is invoked. If the custom
- * action element is empty, only doStart() and doEndTag() are invoked.
- * <p>
- * If EVAL_BODY_BUFFERED is returned, and the custom action element is not
- * empty, setBodyContent() is invoked, doInitBody() is invoked, the body is
- * evaluated, doAfterBody() is invoked, and then, after zero or more iterations,
- * doEndTag() is invoked. If the custom action element is empty, only doStart()
+ * If EVAL_BODY_INCLUDE is returned, and the custom action element is not empty, setBodyContent() is not invoked,
+ * doInitBody() is not invoked, the body is evaluated and "passed through" to the current out, doAfterBody() is invoked
+ * and then, after zero or more iterations, doEndTag() is invoked. If the custom action element is empty, only doStart()
* and doEndTag() are invoked.
+ * <p>
+ * If EVAL_BODY_BUFFERED is returned, and the custom action element is not empty, setBodyContent() is invoked,
+ * doInitBody() is invoked, the body is evaluated, doAfterBody() is invoked, and then, after zero or more iterations,
+ * doEndTag() is invoked. If the custom action element is empty, only doStart() and doEndTag() are invoked.
*/
public interface BodyTag extends IterationTag {
/**
- * Deprecated constant that has the same value as EVAL_BODY_BUFFERED and
- * EVAL_BODY_AGAIN. This name has been marked as deprecated to encourage the
- * use of the two different terms, which are much more descriptive.
+ * Deprecated constant that has the same value as EVAL_BODY_BUFFERED and EVAL_BODY_AGAIN. This name has been marked
+ * as deprecated to encourage the use of the two different terms, which are much more descriptive.
*
- * @deprecated As of Java JSP API 1.2, use BodyTag.EVAL_BODY_BUFFERED or
- * IterationTag.EVAL_BODY_AGAIN.
+ * @deprecated As of Java JSP API 1.2, use BodyTag.EVAL_BODY_BUFFERED or IterationTag.EVAL_BODY_AGAIN.
*/
@SuppressWarnings("dep-ann")
// TCK signature test fails with annotation
- int EVAL_BODY_TAG = 2;
+ int EVAL_BODY_TAG = 2;
/**
- * Request the creation of new buffer, a BodyContent on which to evaluate
- * the body of this tag. Returned from doStartTag when it implements
- * BodyTag. This is an illegal return value for doStartTag when the class
- * does not implement BodyTag.
+ * Request the creation of new buffer, a BodyContent on which to evaluate the body of this tag. Returned from
+ * doStartTag when it implements BodyTag. This is an illegal return value for doStartTag when the class does not
+ * implement BodyTag.
*/
int EVAL_BODY_BUFFERED = 2;
/**
- * Set the bodyContent property. This method is invoked by the JSP page
- * implementation object at most once per action invocation. This method
- * will be invoked before doInitBody. This method will not be invoked for
- * empty tags or for non-empty tags whose doStartTag() method returns
- * SKIP_BODY or EVAL_BODY_INCLUDE.
+ * Set the bodyContent property. This method is invoked by the JSP page implementation object at most once per
+ * action invocation. This method will be invoked before doInitBody. This method will not be invoked for empty tags
+ * or for non-empty tags whose doStartTag() method returns SKIP_BODY or EVAL_BODY_INCLUDE.
* <p>
- * When setBodyContent is invoked, the value of the implicit object out has
- * already been changed in the pageContext object. The BodyContent object
- * passed will have not data on it but may have been reused (and cleared)
- * from some previous invocation.
+ * When setBodyContent is invoked, the value of the implicit object out has already been changed in the pageContext
+ * object. The BodyContent object passed will have not data on it but may have been reused (and cleared) from some
+ * previous invocation.
* <p>
- * The BodyContent object is available and with the appropriate content
- * until after the invocation of the doEndTag method, at which case it may
- * be reused.
+ * The BodyContent object is available and with the appropriate content until after the invocation of the doEndTag
+ * method, at which case it may be reused.
+ *
+ * @param b the BodyContent
*
- * @param b
- * the BodyContent
* @see #doInitBody
* @see #doAfterBody
*/
void setBodyContent(BodyContent b);
/**
- * Prepare for evaluation of the body. This method is invoked by the JSP
- * page implementation object after setBodyContent and before the first time
- * the body is to be evaluated. This method will not be invoked for empty
- * tags or for non-empty tags whose doStartTag() method returns SKIP_BODY or
- * EVAL_BODY_INCLUDE.
+ * Prepare for evaluation of the body. This method is invoked by the JSP page implementation object after
+ * setBodyContent and before the first time the body is to be evaluated. This method will not be invoked for empty
+ * tags or for non-empty tags whose doStartTag() method returns SKIP_BODY or EVAL_BODY_INCLUDE.
* <p>
- * The JSP container will resynchronize the values of any AT_BEGIN and
- * NESTED variables (defined by the associated TagExtraInfo or TLD) after
- * the invocation of doInitBody().
+ * The JSP container will resynchronize the values of any AT_BEGIN and NESTED variables (defined by the associated
+ * TagExtraInfo or TLD) after the invocation of doInitBody().
+ *
+ * @throws JspException if an error occurred while processing this tag
*
- * @throws JspException
- * if an error occurred while processing this tag
* @see #doAfterBody
*/
void doInitBody() throws JspException;
diff --git a/java/javax/servlet/jsp/tagext/BodyTagSupport.java b/java/javax/servlet/jsp/tagext/BodyTagSupport.java
index ba2dfd321d..5314d79a9b 100644
--- a/java/javax/servlet/jsp/tagext/BodyTagSupport.java
+++ b/java/javax/servlet/jsp/tagext/BodyTagSupport.java
@@ -22,9 +22,8 @@ import javax.servlet.jsp.JspWriter;
/**
* A base class for defining tag handlers implementing BodyTag.
* <p>
- * The BodyTagSupport class implements the BodyTag interface and adds additional
- * convenience methods including getter methods for the bodyContent property and
- * methods to get at the previous out JspWriter.
+ * The BodyTagSupport class implements the BodyTag interface and adds additional convenience methods including getter
+ * methods for the bodyContent property and methods to get at the previous out JspWriter.
* <p>
* Many tag handlers will extend BodyTagSupport and only redefine a few methods.
*/
@@ -33,10 +32,8 @@ public class BodyTagSupport extends TagSupport implements BodyTag {
private static final long serialVersionUID = -7235752615580319833L;
/**
- * Default constructor, all subclasses are required to only define a public
- * constructor with the same signature, and to call the superclass
- * constructor. This constructor is called by the code generated by the JSP
- * translator.
+ * Default constructor, all subclasses are required to only define a public constructor with the same signature, and
+ * to call the superclass constructor. This constructor is called by the code generated by the JSP translator.
*/
public BodyTagSupport() {
super();
@@ -46,8 +43,9 @@ public class BodyTagSupport extends TagSupport implements BodyTag {
* Default processing of the start tag returning EVAL_BODY_BUFFERED.
*
* @return EVAL_BODY_BUFFERED
- * @throws JspException
- * if an error occurred while processing this tag
+ *
+ * @throws JspException if an error occurred while processing this tag
+ *
* @see BodyTag#doStartTag
*/
@Override
@@ -59,8 +57,9 @@ public class BodyTagSupport extends TagSupport implements BodyTag {
* Default processing of the end tag returning EVAL_PAGE.
*
* @return EVAL_PAGE
- * @throws JspException
- * if an error occurred while processing this tag
+ *
+ * @throws JspException if an error occurred while processing this tag
+ *
* @see Tag#doEndTag
*/
@Override
@@ -73,8 +72,8 @@ public class BodyTagSupport extends TagSupport implements BodyTag {
/**
* Prepare for evaluation of the body: stash the bodyContent away.
*
- * @param b
- * the BodyContent
+ * @param b the BodyContent
+ *
* @see #doAfterBody
* @see #doInitBody()
* @see BodyTag#setBodyContent
@@ -85,11 +84,10 @@ public class BodyTagSupport extends TagSupport implements BodyTag {
}
/**
- * Prepare for evaluation of the body just before the first body evaluation:
- * no action.
+ * Prepare for evaluation of the body just before the first body evaluation: no action.
+ *
+ * @throws JspException if an error occurred while processing this tag
*
- * @throws JspException
- * if an error occurred while processing this tag
* @see #setBodyContent
* @see #doAfterBody
* @see BodyTag#doInitBody
@@ -100,12 +98,13 @@ public class BodyTagSupport extends TagSupport implements BodyTag {
}
/**
- * After the body evaluation: do not reevaluate and continue with the page.
- * By default nothing is done with the bodyContent data (if any).
+ * After the body evaluation: do not reevaluate and continue with the page. By default nothing is done with the
+ * bodyContent data (if any).
*
* @return SKIP_BODY
- * @throws JspException
- * if an error occurred while processing this tag
+ *
+ * @throws JspException if an error occurred while processing this tag
+ *
* @see #doInitBody
* @see BodyTag#doAfterBody
*/
diff --git a/java/javax/servlet/jsp/tagext/DynamicAttributes.java b/java/javax/servlet/jsp/tagext/DynamicAttributes.java
index 1517e4e446..bb145c2d7d 100644
--- a/java/javax/servlet/jsp/tagext/DynamicAttributes.java
+++ b/java/javax/servlet/jsp/tagext/DynamicAttributes.java
@@ -19,31 +19,26 @@ package javax.servlet.jsp.tagext;
import javax.servlet.jsp.JspException;
/**
- * For a tag to declare that it accepts dynamic attributes, it must implement
- * this interface. The entry for the tag in the Tag Library Descriptor must
- * also be configured to indicate dynamic attributes are accepted.
- * <br>
- * For any attribute that is not declared in the Tag Library Descriptor for
- * this tag, instead of getting an error at translation time, the
- * <code>setDynamicAttribute()</code> method is called, with the name and
- * value of the attribute. It is the responsibility of the tag to
- * remember the names and values of the dynamic attributes.
+ * For a tag to declare that it accepts dynamic attributes, it must implement this interface. The entry for the tag in
+ * the Tag Library Descriptor must also be configured to indicate dynamic attributes are accepted. <br>
+ * For any attribute that is not declared in the Tag Library Descriptor for this tag, instead of getting an error at
+ * translation time, the <code>setDynamicAttribute()</code> method is called, with the name and value of the attribute.
+ * It is the responsibility of the tag to remember the names and values of the dynamic attributes.
*
* @since JSP 2.0
*/
public interface DynamicAttributes {
/**
- * Called when a tag declared to accept dynamic attributes is passed
- * an attribute that is not declared in the Tag Library Descriptor.
+ * Called when a tag declared to accept dynamic attributes is passed an attribute that is not declared in the Tag
+ * Library Descriptor.
*
- * @param uri the namespace of the attribute, or null if in the default
- * namespace.
+ * @param uri the namespace of the attribute, or null if in the default namespace.
* @param localName the name of the attribute being set.
- * @param value the value of the attribute
- * @throws JspException if the tag handler wishes to
- * signal that it does not accept the given attribute. The
- * container must not call doStartTag() or doTag() for this tag.
+ * @param value the value of the attribute
+ *
+ * @throws JspException if the tag handler wishes to signal that it does not accept the given attribute. The
+ * container must not call doStartTag() or doTag() for this tag.
*/
void setDynamicAttribute(String uri, String localName, Object value) throws JspException;
}
diff --git a/java/javax/servlet/jsp/tagext/FunctionInfo.java b/java/javax/servlet/jsp/tagext/FunctionInfo.java
index b8e957ed53..3e17b88f3e 100644
--- a/java/javax/servlet/jsp/tagext/FunctionInfo.java
+++ b/java/javax/servlet/jsp/tagext/FunctionInfo.java
@@ -17,8 +17,7 @@
package javax.servlet.jsp.tagext;
/**
- * Information for a function in a Tag Library.
- * This class is instantiated from the Tag Library Descriptor file (TLD)
+ * Information for a function in a Tag Library. This class is instantiated from the Tag Library Descriptor file (TLD)
* and is available only at translation time.
*
* @since JSP 2.0
@@ -28,8 +27,8 @@ public class FunctionInfo {
/**
* Constructor for FunctionInfo.
*
- * @param name The name of the function
- * @param klass The class of the function
+ * @param name The name of the function
+ * @param klass The class of the function
* @param signature The signature of the function
*/
diff --git a/java/javax/servlet/jsp/tagext/IterationTag.java b/java/javax/servlet/jsp/tagext/IterationTag.java
index 7e4eb54389..04a82174f7 100644
--- a/java/javax/servlet/jsp/tagext/IterationTag.java
+++ b/java/javax/servlet/jsp/tagext/IterationTag.java
@@ -20,99 +20,69 @@ import javax.servlet.jsp.JspException;
/**
- * The IterationTag interface extends Tag by defining one additional
- * method that controls the reevaluation of its body.
- *
- * <p> A tag handler that implements IterationTag is treated as one that
- * implements Tag regarding the doStartTag() and doEndTag() methods.
- * IterationTag provides a new method: <code>doAfterBody()</code>.
- *
- * <p> The doAfterBody() method is invoked after every body evaluation
- * to control whether the body will be reevaluated or not. If doAfterBody()
- * returns IterationTag.EVAL_BODY_AGAIN, then the body will be reevaluated.
- * If doAfterBody() returns Tag.SKIP_BODY, then the body will be skipped
- * and doEndTag() will be evaluated instead.
- *
- * <p><B>Properties</B>
- * There are no new properties in addition to those in Tag.
- *
- * <p><B>Methods</B>
- * There is one new methods: doAfterBody().
- *
- * <p><B>Lifecycle</B>
- *
- * <p> Lifecycle details are described by the transition diagram
- * below. Exceptions that are thrown during the computation of
- * doStartTag(), BODY and doAfterBody() interrupt the execution
- * sequence and are propagated up the stack, unless the tag handler
- * implements the TryCatchFinally interface; see that interface for
- * details.
- *
+ * The IterationTag interface extends Tag by defining one additional method that controls the reevaluation of its body.
* <p>
- * <IMG src="doc-files/IterationTagProtocol.gif"
- * alt="Lifecycle Details Transition Diagram for IterationTag">
- *
- * <p><B>Empty and Non-Empty Action</B>
- * <p> If the TagLibraryDescriptor file indicates that the action must
- * always have an empty element body, by a <body-content> entry of
- * "empty", then the doStartTag() method must return SKIP_BODY.
- *
- * <p>Note that which methods are invoked after the doStartTag() depends on
- * both the return value and on if the custom action element is empty
- * or not in the JSP page, not on how it's declared in the TLD.
- *
+ * A tag handler that implements IterationTag is treated as one that implements Tag regarding the doStartTag() and
+ * doEndTag() methods. IterationTag provides a new method: <code>doAfterBody()</code>.
* <p>
- * If SKIP_BODY is returned the body is not evaluated, and then doEndTag()
- * is invoked.
- *
+ * The doAfterBody() method is invoked after every body evaluation to control whether the body will be reevaluated or
+ * not. If doAfterBody() returns IterationTag.EVAL_BODY_AGAIN, then the body will be reevaluated. If doAfterBody()
+ * returns Tag.SKIP_BODY, then the body will be skipped and doEndTag() will be evaluated instead.
+ * <p>
+ * <B>Properties</B> There are no new properties in addition to those in Tag.
+ * <p>
+ * <B>Methods</B> There is one new methods: doAfterBody().
+ * <p>
+ * <B>Lifecycle</B>
* <p>
- * If EVAL_BODY_INCLUDE is returned, and the custom action element is not
- * empty, the body is evaluated and "passed through" to the current out,
- * then doAfterBody() is invoked and, after zero or more iterations,
- * doEndTag() is invoked.
+ * Lifecycle details are described by the transition diagram below. Exceptions that are thrown during the computation of
+ * doStartTag(), BODY and doAfterBody() interrupt the execution sequence and are propagated up the stack, unless the tag
+ * handler implements the TryCatchFinally interface; see that interface for details.
+ * <p>
+ * <IMG src="doc-files/IterationTagProtocol.gif" alt="Lifecycle Details Transition Diagram for IterationTag">
+ * <p>
+ * <B>Empty and Non-Empty Action</B>
+ * <p>
+ * If the TagLibraryDescriptor file indicates that the action must always have an empty element body, by a
+ * <body-content> entry of "empty", then the doStartTag() method must return SKIP_BODY.
+ * <p>
+ * Note that which methods are invoked after the doStartTag() depends on both the return value and on if the custom
+ * action element is empty or not in the JSP page, not on how it's declared in the TLD.
+ * <p>
+ * If SKIP_BODY is returned the body is not evaluated, and then doEndTag() is invoked.
+ * <p>
+ * If EVAL_BODY_INCLUDE is returned, and the custom action element is not empty, the body is evaluated and "passed
+ * through" to the current out, then doAfterBody() is invoked and, after zero or more iterations, doEndTag() is invoked.
*/
public interface IterationTag extends Tag {
/**
- * Request the reevaluation of some body.
- * Returned from doAfterBody.
- *
- * For compatibility with JSP 1.1, the value is carefully selected
- * to be the same as the, now deprecated, BodyTag.EVAL_BODY_TAG,
- *
+ * Request the reevaluation of some body. Returned from doAfterBody. For compatibility with JSP 1.1, the value is
+ * carefully selected to be the same as the, now deprecated, BodyTag.EVAL_BODY_TAG,
*/
int EVAL_BODY_AGAIN = 2;
/**
- * Process body (re)evaluation. This method is invoked by the
- * JSP Page implementation object after every evaluation of
- * the body into the BodyEvaluation object. The method is
- * not invoked if there is no body evaluation.
- *
+ * Process body (re)evaluation. This method is invoked by the JSP Page implementation object after every evaluation
+ * of the body into the BodyEvaluation object. The method is not invoked if there is no body evaluation.
* <p>
- * If doAfterBody returns EVAL_BODY_AGAIN, a new evaluation of the
- * body will happen (followed by another invocation of doAfterBody).
- * If doAfterBody returns SKIP_BODY, no more body evaluations will occur,
- * and the doEndTag method will be invoked.
- *
+ * If doAfterBody returns EVAL_BODY_AGAIN, a new evaluation of the body will happen (followed by another invocation
+ * of doAfterBody). If doAfterBody returns SKIP_BODY, no more body evaluations will occur, and the doEndTag method
+ * will be invoked.
* <p>
- * If this tag handler implements BodyTag and doAfterBody returns
- * SKIP_BODY, the value of out will be restored using the popBody
- * method in pageContext prior to invoking doEndTag.
- *
+ * If this tag handler implements BodyTag and doAfterBody returns SKIP_BODY, the value of out will be restored using
+ * the popBody method in pageContext prior to invoking doEndTag.
* <p>
- * The method re-invocations may be lead to different actions because
- * there might have been some changes to shared state, or because
- * of external computation.
- *
+ * The method re-invocations may be lead to different actions because there might have been some changes to shared
+ * state, or because of external computation.
* <p>
- * The JSP container will resynchronize the values of any AT_BEGIN and
- * NESTED variables (defined by the associated TagExtraInfo or TLD) after
- * the invocation of doAfterBody().
+ * The JSP container will resynchronize the values of any AT_BEGIN and NESTED variables (defined by the associated
+ * TagExtraInfo or TLD) after the invocation of doAfterBody().
*
* @return whether additional evaluations of the body are desired
+ *
* @throws JspException if an error occurred while processing this tag
*/
int doAfterBody() throws JspException;
diff --git a/java/javax/servlet/jsp/tagext/JspFragment.java b/java/javax/servlet/jsp/tagext/JspFragment.java
index e71f9eed06..5d9681b252 100644
--- a/java/javax/servlet/jsp/tagext/JspFragment.java
+++ b/java/javax/servlet/jsp/tagext/JspFragment.java
@@ -23,32 +23,24 @@ import javax.servlet.jsp.JspContext;
import javax.servlet.jsp.JspException;
/**
- * Encapsulates a portion of JSP code in an object that
- * can be invoked as many times as needed. JSP Fragments are defined
- * using JSP syntax as the body of a tag for an invocation to a SimpleTag
- * handler, or as the body of a <jsp:attribute> standard action
- * specifying the value of an attribute that is declared as a fragment,
- * or to be of type JspFragment in the TLD.
+ * Encapsulates a portion of JSP code in an object that can be invoked as many times as needed. JSP Fragments are
+ * defined using JSP syntax as the body of a tag for an invocation to a SimpleTag handler, or as the body of a
+ * <jsp:attribute> standard action specifying the value of an attribute that is declared as a fragment, or to be
+ * of type JspFragment in the TLD.
* <p>
- * The definition of the JSP fragment must only contain template
- * text and JSP action elements. In other words, it must not contain
- * scriptlets or scriptlet expressions. At translation time, the
- * container generates an implementation of the JspFragment abstract class
- * capable of executing the defined fragment.
+ * The definition of the JSP fragment must only contain template text and JSP action elements. In other words, it must
+ * not contain scriptlets or scriptlet expressions. At translation time, the container generates an implementation of
+ * the JspFragment abstract class capable of executing the defined fragment.
* <p>
- * A tag handler can invoke the fragment zero or more times, or
- * pass it along to other tags, before returning. To communicate values
- * to/from a JSP fragment, tag handlers store/retrieve values in
- * the JspContext associated with the fragment.
+ * A tag handler can invoke the fragment zero or more times, or pass it along to other tags, before returning. To
+ * communicate values to/from a JSP fragment, tag handlers store/retrieve values in the JspContext associated with the
+ * fragment.
* <p>
- * Note that tag library developers and page authors should not generate
- * JspFragment implementations manually.
+ * Note that tag library developers and page authors should not generate JspFragment implementations manually.
* <p>
- * <i>Implementation Note</i>: It is not necessary to generate a
- * separate class for each fragment. One possible implementation is
- * to generate a single helper class for each page that implements
- * JspFragment. Upon construction, a discriminator can be passed to
- * select which fragment that instance will execute.
+ * <i>Implementation Note</i>: It is not necessary to generate a separate class for each fragment. One possible
+ * implementation is to generate a single helper class for each page that implements JspFragment. Upon construction, a
+ * discriminator can be passed to select which fragment that instance will execute.
*
* @since JSP 2.0
*/
@@ -62,24 +54,20 @@ public abstract class JspFragment {
}
/**
- * Executes the fragment and directs all output to the given Writer,
- * or the JspWriter returned by the getOut() method of the JspContext
- * associated with the fragment if out is null.
+ * Executes the fragment and directs all output to the given Writer, or the JspWriter returned by the getOut()
+ * method of the JspContext associated with the fragment if out is null.
*
- * @param out The Writer to output the fragment to, or null if
- * output should be sent to JspContext.getOut().
- * @throws javax.servlet.jsp.JspException Thrown if an error occurred
- * while invoking this fragment.
- * @throws javax.servlet.jsp.SkipPageException Thrown if the page
- * that (either directly or indirectly) invoked the tag handler that
- * invoked this fragment is to cease evaluation. The container
- * must throw this exception if a Classic Tag Handler returned
- * Tag.SKIP_PAGE or if a Simple Tag Handler threw SkipPageException.
- * @throws java.io.IOException If there was an error writing to the
- * stream.
+ * @param out The Writer to output the fragment to, or null if output should be sent to JspContext.getOut().
+ *
+ * @throws javax.servlet.jsp.JspException Thrown if an error occurred while invoking this fragment.
+ * @throws javax.servlet.jsp.SkipPageException Thrown if the page that (either directly or indirectly) invoked the
+ * tag handler that invoked this fragment is to cease evaluation.
+ * The container must throw this exception if a Classic Tag Handler
+ * returned Tag.SKIP_PAGE or if a Simple Tag Handler threw
+ * SkipPageException.
+ * @throws java.io.IOException If there was an error writing to the stream.
*/
- public abstract void invoke( Writer out )
- throws JspException, IOException;
+ public abstract void invoke(Writer out) throws JspException, IOException;
/**
* Returns the JspContext that is bound to this JspFragment.
diff --git a/java/javax/servlet/jsp/tagext/JspIdConsumer.java b/java/javax/servlet/jsp/tagext/JspIdConsumer.java
index a5ba37d19e..e0192fbf14 100644
--- a/java/javax/servlet/jsp/tagext/JspIdConsumer.java
+++ b/java/javax/servlet/jsp/tagext/JspIdConsumer.java
@@ -17,8 +17,7 @@
package javax.servlet.jsp.tagext;
/**
- * Interface that allows tag handlers to be provided with a unique (within the
- * scope of the web application) ID.
+ * Interface that allows tag handlers to be provided with a unique (within the scope of the web application) ID.
*/
public interface JspIdConsumer {
diff --git a/java/javax/servlet/jsp/tagext/JspTag.java b/java/javax/servlet/jsp/tagext/JspTag.java
index 2bb39612d6..57f417740c 100644
--- a/java/javax/servlet/jsp/tagext/JspTag.java
+++ b/java/javax/servlet/jsp/tagext/JspTag.java
@@ -17,8 +17,7 @@
package javax.servlet.jsp.tagext;
/**
- * Serves as a base class for Tag and SimpleTag.
- * This is mostly for organizational and type-safety purposes.
+ * Serves as a base class for Tag and SimpleTag. This is mostly for organizational and type-safety purposes.
*
* @since JSP 2.0
*/
diff --git a/java/javax/servlet/jsp/tagext/PageData.java b/java/javax/servlet/jsp/tagext/PageData.java
index 7f1cb20a0d..c414b4f4c9 100644
--- a/java/javax/servlet/jsp/tagext/PageData.java
+++ b/java/javax/servlet/jsp/tagext/PageData.java
@@ -19,28 +19,23 @@ package javax.servlet.jsp.tagext;
import java.io.InputStream;
/**
- * Translation-time information on a JSP page. The information
- * corresponds to the XML view of the JSP page.
- *
+ * Translation-time information on a JSP page. The information corresponds to the XML view of the JSP page.
* <p>
- * Objects of this type are generated by the JSP translator, e.g.
- * when being passed to a TagLibraryValidator instance.
+ * Objects of this type are generated by the JSP translator, e.g. when being passed to a TagLibraryValidator instance.
*/
public abstract class PageData {
/**
- * Sole constructor. (For invocation by subclass constructors,
- * typically implicit.)
+ * Sole constructor. (For invocation by subclass constructors, typically implicit.)
*/
public PageData() {
// NOOP by default
}
/**
- * Returns an input stream on the XML view of a JSP page.
- * The stream is encoded in UTF-8. Recall that the XML view of a
- * JSP page has the include directives expanded.
+ * Returns an input stream on the XML view of a JSP page. The stream is encoded in UTF-8. Recall that the XML view
+ * of a JSP page has the include directives expanded.
*
* @return An input stream on the document.
*/
diff --git a/java/javax/servlet/jsp/tagext/SimpleTag.java b/java/javax/servlet/jsp/tagext/SimpleTag.java
index 6b47b2b0d6..2867907b6d 100644
--- a/java/javax/servlet/jsp/tagext/SimpleTag.java
+++ b/java/javax/servlet/jsp/tagext/SimpleTag.java
@@ -20,92 +20,74 @@ import javax.servlet.jsp.JspContext;
/**
* Interface for defining Simple Tag Handlers.
- *
- * <p>Simple Tag Handlers differ from Classic Tag Handlers in that instead
- * of supporting <code>doStartTag()</code> and <code>doEndTag()</code>,
- * the <code>SimpleTag</code> interface provides a simple
- * <code>doTag()</code> method, which is called once and only once for any
- * given tag invocation. All tag logic, iteration, body evaluations, etc.
- * are to be performed in this single method. Thus, simple tag handlers
- * have the equivalent power of <code>BodyTag</code>, but with a much
- * simpler lifecycle and interface.</p>
- *
- * <p>To support body content, the <code>setJspBody()</code>
- * method is provided. The container invokes the <code>setJspBody()</code>
- * method with a <code>JspFragment</code> object encapsulating the body of
- * the tag. The tag handler implementation can call
- * <code>invoke()</code> on that fragment to evaluate the body as
- * many times as it needs.</p>
- *
- * <p>A SimpleTag handler must have a public no-args constructor. Most
- * SimpleTag handlers should extend SimpleTagSupport.</p>
- *
- * <p><b>Lifecycle</b></p>
- *
- * <p>The following is a non-normative, brief overview of the
- * SimpleTag lifecycle. Refer to the JSP Specification for details.</p>
- *
+ * <p>
+ * Simple Tag Handlers differ from Classic Tag Handlers in that instead of supporting <code>doStartTag()</code> and
+ * <code>doEndTag()</code>, the <code>SimpleTag</code> interface provides a simple <code>doTag()</code> method, which is
+ * called once and only once for any given tag invocation. All tag logic, iteration, body evaluations, etc. are to be
+ * performed in this single method. Thus, simple tag handlers have the equivalent power of <code>BodyTag</code>, but
+ * with a much simpler lifecycle and interface.
+ * </p>
+ * <p>
+ * To support body content, the <code>setJspBody()</code> method is provided. The container invokes the
+ * <code>setJspBody()</code> method with a <code>JspFragment</code> object encapsulating the body of the tag. The tag
+ * handler implementation can call <code>invoke()</code> on that fragment to evaluate the body as many times as it
+ * needs.
+ * </p>
+ * <p>
+ * A SimpleTag handler must have a public no-args constructor. Most SimpleTag handlers should extend SimpleTagSupport.
+ * </p>
+ * <p>
+ * <b>Lifecycle</b>
+ * </p>
+ * <p>
+ * The following is a non-normative, brief overview of the SimpleTag lifecycle. Refer to the JSP Specification for
+ * details.
+ * </p>
* <ol>
- * <li>A new tag handler instance is created each time by the container
- * by calling the provided zero-args constructor. Unlike classic
- * tag handlers, simple tag handlers are never cached and reused by
- * the JSP container.</li>
- * <li>The <code>setJspContext()</code> and <code>setParent()</code>
- * methods are called by the container. The <code>setParent()</code>
- * method is only called if the element is nested within another tag
- * invocation.</li>
- * <li>The setters for each attribute defined for this tag are called
- * by the container.</li>
- * <li>If a body exists, the <code>setJspBody()</code> method is called
- * by the container to set the body of this tag, as a
- * <code>JspFragment</code>. If the action element is empty in
- * the page, this method is not called at all.</li>
- * <li>The <code>doTag()</code> method is called by the container. All
- * tag logic, iteration, body evaluations, etc. occur in this
- * method.</li>
- * <li>The <code>doTag()</code> method returns and all variables are
- * synchronized.</li>
+ * <li>A new tag handler instance is created each time by the container by calling the provided zero-args constructor.
+ * Unlike classic tag handlers, simple tag handlers are never cached and reused by the JSP container.</li>
+ * <li>The <code>setJspContext()</code> and <code>setParent()</code> methods are called by the container. The
+ * <code>setParent()</code> method is only called if the element is nested within another tag invocation.</li>
+ * <li>The setters for each attribute defined for this tag are called by the container.</li>
+ * <li>If a body exists, the <code>setJspBody()</code> method is called by the container to set the body of this tag, as
+ * a <code>JspFragment</code>. If the action element is empty in the page, this method is not called at all.</li>
+ * <li>The <code>doTag()</code> method is called by the container. All tag logic, iteration, body evaluations, etc.
+ * occur in this method.</li>
+ * <li>The <code>doTag()</code> method returns and all variables are synchronized.</li>
* </ol>
*
* @see SimpleTagSupport
+ *
* @since JSP 2.0
*/
public interface SimpleTag extends JspTag {
/**
- * Called by the container to invoke this tag.
- * The implementation of this method is provided by the tag library
+ * Called by the container to invoke this tag. The implementation of this method is provided by the tag library
* developer, and handles all tag processing, body iteration, etc.
- *
* <p>
- * The JSP container will resynchronize any AT_BEGIN and AT_END
- * variables (defined by the associated tag file, TagExtraInfo, or TLD)
- * after the invocation of doTag().
+ * The JSP container will resynchronize any AT_BEGIN and AT_END variables (defined by the associated tag file,
+ * TagExtraInfo, or TLD) after the invocation of doTag().
*
- * @throws javax.servlet.jsp.JspException If an error occurred
- * while processing this tag.
- * @throws javax.servlet.jsp.SkipPageException If the page that
- * (either directly or indirectly) invoked this tag is to
- * cease evaluation. A Simple Tag Handler generated from a
- * tag file must throw this exception if an invoked Classic
- * Tag Handler returned SKIP_PAGE or if an invoked Simple
- * Tag Handler threw SkipPageException or if an invoked Jsp Fragment
- * threw a SkipPageException.
- * @throws java.io.IOException If there was an error writing to the
- * output stream.
+ * @throws javax.servlet.jsp.JspException If an error occurred while processing this tag.
+ * @throws javax.servlet.jsp.SkipPageException If the page that (either directly or indirectly) invoked this tag is
+ * to cease evaluation. A Simple Tag Handler generated from a tag
+ * file must throw this exception if an invoked Classic Tag Handler
+ * returned SKIP_PAGE or if an invoked Simple Tag Handler threw
+ * SkipPageException or if an invoked Jsp Fragment threw a
+ * SkipPageException.
+ * @throws java.io.IOException If there was an error writing to the output stream.
*/
- void doTag()
- throws javax.servlet.jsp.JspException, java.io.IOException;
+ void doTag() throws javax.servlet.jsp.JspException, java.io.IOException;
/**
* Sets the parent of this tag, for collaboration purposes.
* <p>
- * The container invokes this method only if this tag invocation is
- * nested within another tag invocation.
+ * The container invokes this method only if this tag invocation is nested within another tag invocation.
*
* @param parent the tag that encloses this tag
*/
- void setParent( JspTag parent );
+ void setParent(JspTag parent);
/**
* Returns the parent of this tag, for collaboration purposes.
@@ -115,26 +97,24 @@ public interface SimpleTag extends JspTag {
JspTag getParent();
/**
- * Called by the container to provide this tag handler with
- * the <code>JspContext</code> for this invocation.
- * An implementation should save this value.
+ * Called by the container to provide this tag handler with the <code>JspContext</code> for this invocation. An
+ * implementation should save this value.
*
* @param pc the page context for this invocation
+ *
* @see Tag#setPageContext
*/
- void setJspContext( JspContext pc );
+ void setJspContext(JspContext pc);
/**
- * Provides the body of this tag as a JspFragment object, able to be
- * invoked zero or more times by the tag handler.
+ * Provides the body of this tag as a JspFragment object, able to be invoked zero or more times by the tag handler.
* <p>
- * This method is invoked by the JSP page implementation
- * object prior to <code>doTag()</code>. If the action element is
- * empty in the page, this method is not called at all.
+ * This method is invoked by the JSP page implementation object prior to <code>doTag()</code>. If the action element
+ * is empty in the page, this method is not called at all.
*
* @param jspBody The fragment encapsulating the body of this tag.
*/
- void setJspBody( JspFragment jspBody );
+ void setJspBody(JspFragment jspBody);
}
diff --git a/java/javax/servlet/jsp/tagext/SimpleTagSupport.java b/java/javax/servlet/jsp/tagext/SimpleTagSupport.java
index 47a37d4ede..a5786e70cd 100644
--- a/java/javax/servlet/jsp/tagext/SimpleTagSupport.java
+++ b/java/javax/servlet/jsp/tagext/SimpleTagSupport.java
@@ -24,11 +24,9 @@ import javax.servlet.jsp.JspException;
/**
* A base class for defining tag handlers implementing SimpleTag.
* <p>
- * The SimpleTagSupport class is a utility class intended to be used
- * as the base class for new simple tag handlers. The SimpleTagSupport
- * class implements the SimpleTag interface and adds additional
- * convenience methods including getter methods for the properties in
- * SimpleTag.
+ * The SimpleTagSupport class is a utility class intended to be used as the base class for new simple tag handlers. The
+ * SimpleTagSupport class implements the SimpleTag interface and adds additional convenience methods including getter
+ * methods for the properties in SimpleTag.
*
* @since JSP 2.0
*/
@@ -43,8 +41,7 @@ public class SimpleTagSupport implements SimpleTag {
private JspFragment jspBody;
/**
- * Sole constructor. (For invocation by subclass constructors,
- * typically implicit.)
+ * Sole constructor. (For invocation by subclass constructors, typically implicit.)
*/
public SimpleTagSupport() {
// NOOP by default
@@ -53,17 +50,17 @@ public class SimpleTagSupport implements SimpleTag {
/**
* Default processing of the tag does nothing.
*
- * @throws JspException Subclasses can throw JspException to indicate
- * an error occurred while processing this tag.
- * @throws javax.servlet.jsp.SkipPageException If the page that
- * (either directly or indirectly) invoked this tag is to
- * cease evaluation. A Simple Tag Handler generated from a
- * tag file must throw this exception if an invoked Classic
- * Tag Handler returned SKIP_PAGE or if an invoked Simple
- * Tag Handler threw SkipPageException or if an invoked Jsp Fragment
- * threw a SkipPageException.
- * @throws IOException Subclasses can throw IOException if there was
- * an error writing to the output stream
+ * @throws JspException Subclasses can throw JspException to indicate an error occurred while
+ * processing this tag.
+ * @throws javax.servlet.jsp.SkipPageException If the page that (either directly or indirectly) invoked this tag is
+ * to cease evaluation. A Simple Tag Handler generated from a tag
+ * file must throw this exception if an invoked Classic Tag Handler
+ * returned SKIP_PAGE or if an invoked Simple Tag Handler threw
+ * SkipPageException or if an invoked Jsp Fragment threw a
+ * SkipPageException.
+ * @throws IOException Subclasses can throw IOException if there was an error writing to the
+ * output stream
+ *
* @see SimpleTag#doTag()
*/
@Override
@@ -74,13 +71,12 @@ public class SimpleTagSupport implements SimpleTag {
/**
* Sets the parent of this tag, for collaboration purposes.
* <p>
- * The container invokes this method only if this tag invocation is
- * nested within another tag invocation.
+ * The container invokes this method only if this tag invocation is nested within another tag invocation.
*
* @param parent the tag that encloses this tag
*/
@Override
- public void setParent( JspTag parent ) {
+ public void setParent(JspTag parent) {
this.parentTag = parent;
}
@@ -95,21 +91,20 @@ public class SimpleTagSupport implements SimpleTag {
}
/**
- * Stores the provided JSP context in the private jspContext field.
- * Subclasses can access the <code>JspContext</code> via
- * <code>getJspContext()</code>.
+ * Stores the provided JSP context in the private jspContext field. Subclasses can access the
+ * <code>JspContext</code> via <code>getJspContext()</code>.
*
* @param pc the page context for this invocation
+ *
* @see SimpleTag#setJspContext
*/
@Override
- public void setJspContext( JspContext pc ) {
+ public void setJspContext(JspContext pc) {
this.jspContext = pc;
}
/**
- * Returns the page context passed in by the container via
- * setJspContext.
+ * Returns the page context passed in by the container via setJspContext.
*
* @return the page context for this invocation
*/
@@ -120,79 +115,63 @@ public class SimpleTagSupport implements SimpleTag {
/**
* Stores the provided JspFragment.
*
- * @param jspBody The fragment encapsulating the body of this tag.
- * If the action element is empty in the page, this method is
- * not called at all.
+ * @param jspBody The fragment encapsulating the body of this tag. If the action element is empty in the page, this
+ * method is not called at all.
+ *
* @see SimpleTag#setJspBody
*/
@Override
- public void setJspBody( JspFragment jspBody ) {
+ public void setJspBody(JspFragment jspBody) {
this.jspBody = jspBody;
}
/**
* Returns the body passed in by the container via setJspBody.
*
- * @return the fragment encapsulating the body of this tag, or
- * null if the action element is empty in the page.
+ * @return the fragment encapsulating the body of this tag, or null if the action element is empty in the page.
*/
protected JspFragment getJspBody() {
return this.jspBody;
}
/**
- * Find the instance of a given class type that is closest to a given
- * instance.
- * This method uses the getParent method from the Tag and/or SimpleTag
- * interfaces. This method is used for coordination among
- * cooperating tags.
- *
- * <p> For every instance of TagAdapter
- * encountered while traversing the ancestors, the tag handler returned by
- * <code>TagAdapter.getAdaptee()</code> - instead of the TagAdapter itself -
- * is compared to <code>klass</code>. If the tag handler matches, it - and
- * not its TagAdapter - is returned.
- *
+ * Find the instance of a given class type that is closest to a given instance. This method uses the getParent
+ * method from the Tag and/or SimpleTag interfaces. This method is used for coordination among cooperating tags.
* <p>
- * The current version of the specification only provides one formal
- * way of indicating the observable type of a tag handler: its
- * tag handler implementation class, described in the tag-class
- * subelement of the tag element. This is extended in an
- * informal manner by allowing the tag library author to
- * indicate in the description subelement an observable type.
- * The type should be a subtype of the tag handler implementation
- * class or void.
- * This additional constraint can be exploited by a
- * specialized container that knows about that specific tag library,
- * as in the case of the JSP standard tag library.
- *
+ * For every instance of TagAdapter encountered while traversing the ancestors, the tag handler returned by
+ * <code>TagAdapter.getAdaptee()</code> - instead of the TagAdapter itself - is compared to <code>klass</code>. If
+ * the tag handler matches, it - and not its TagAdapter - is returned.
* <p>
- * When a tag library author provides information on the
- * observable type of a tag handler, client programmatic code
- * should adhere to that constraint. Specifically, the Class
- * passed to findAncestorWithClass should be a subtype of the
- * observable type.
- *
+ * The current version of the specification only provides one formal way of indicating the observable type of a tag
+ * handler: its tag handler implementation class, described in the tag-class subelement of the tag element. This is
+ * extended in an informal manner by allowing the tag library author to indicate in the description subelement an
+ * observable type. The type should be a subtype of the tag handler implementation class or void. This additional
+ * constraint can be exploited by a specialized container that knows about that specific tag library, as in the case
+ * of the JSP standard tag library.
+ * <p>
+ * When a tag library author provides information on the observable type of a tag handler, client programmatic code
+ * should adhere to that constraint. Specifically, the Class passed to findAncestorWithClass should be a subtype of
+ * the observable type.
*
- * @param from The instance from where to start looking.
+ * @param from The instance from where to start looking.
* @param klass The subclass of JspTag or interface to be matched
- * @return the nearest ancestor that implements the interface
- * or is an instance of the class specified
+ *
+ * @return the nearest ancestor that implements the interface or is an instance of the class specified
*/
public static final JspTag findAncestorWithClass(JspTag from, Class<?> klass) {
boolean isInterface = false;
- if (from == null || klass == null || (!JspTag.class.isAssignableFrom(klass) &&
- !(isInterface = klass.isInterface()))) {
+ if (from == null || klass == null ||
+ (!JspTag.class.isAssignableFrom(klass) && !(isInterface = klass.isInterface()))) {
return null;
}
for (;;) {
JspTag parent = null;
- if( from instanceof SimpleTag ) {
- parent = ((SimpleTag)from).getParent();
- } else if( from instanceof Tag ) {
- parent = ((Tag)from).getParent();
+ if (from instanceof SimpleTag) {
+ parent = ((SimpleTag) from).getParent();
+ } else if (from instanceof Tag) {
+ parent = ((Tag) from).getParent();
}
if (parent == null) {
return null;
@@ -202,8 +181,7 @@ public class SimpleTagSupport implements SimpleTag {
parent = ((TagAdapter) parent).getAdaptee();
}
- if ((isInterface && klass.isInstance(parent)) ||
- klass.isAssignableFrom(parent.getClass())) {
+ if ((isInterface && klass.isInstance(parent)) || klass.isAssignableFrom(parent.getClass())) {
return parent;
}
diff --git a/java/javax/servlet/jsp/tagext/Tag.java b/java/javax/servlet/jsp/tagext/Tag.java
index 2cf00e1ab7..4d8d5b2122 100644
--- a/java/javax/servlet/jsp/tagext/Tag.java
+++ b/java/javax/servlet/jsp/tagext/Tag.java
@@ -21,99 +21,91 @@ import javax.servlet.jsp.PageContext;
/**
- * The interface of a classic tag handler that does not want to manipulate
- * its body. The Tag interface defines the basic protocol between a Tag
- * handler and JSP page implementation class. It defines the life cycle
- * and the methods to be invoked at start and end tag.
- *
- * <p><B>Properties</B></p>
- *
- * <p>The Tag interface specifies the setter and getter methods for the core
- * pageContext and parent properties.</p>
- *
- * <p>The JSP page implementation object invokes setPageContext and
- * setParent, in that order, before invoking doStartTag() or doEndTag().</p>
- *
- * <p><B>Methods</B></p>
- *
- * <p>There are two main actions: doStartTag and doEndTag. Once all
- * appropriate properties have been initialized, the doStartTag and
- * doEndTag methods can be invoked on the tag handler. Between these
- * invocations, the tag handler is assumed to hold a state that must
- * be preserved. After the doEndTag invocation, the tag handler is
- * available for further invocations (and it is expected to have
- * retained its properties).</p>
- *
- * <p><B>Lifecycle</B></p>
- *
- * <p>Lifecycle details are described by the transition diagram below,
- * with the following comments:</p>
+ * The interface of a classic tag handler that does not want to manipulate its body. The Tag interface defines the basic
+ * protocol between a Tag handler and JSP page implementation class. It defines the life cycle and the methods to be
+ * invoked at start and end tag.
+ * <p>
+ * <B>Properties</B>
+ * </p>
+ * <p>
+ * The Tag interface specifies the setter and getter methods for the core pageContext and parent properties.
+ * </p>
+ * <p>
+ * The JSP page implementation object invokes setPageContext and setParent, in that order, before invoking doStartTag()
+ * or doEndTag().
+ * </p>
+ * <p>
+ * <B>Methods</B>
+ * </p>
+ * <p>
+ * There are two main actions: doStartTag and doEndTag. Once all appropriate properties have been initialized, the
+ * doStartTag and doEndTag methods can be invoked on the tag handler. Between these invocations, the tag handler is
+ * assumed to hold a state that must be preserved. After the doEndTag invocation, the tag handler is available for
+ * further invocations (and it is expected to have retained its properties).
+ * </p>
+ * <p>
+ * <B>Lifecycle</B>
+ * </p>
+ * <p>
+ * Lifecycle details are described by the transition diagram below, with the following comments:
+ * </p>
* <ul>
- * <li> [1] This transition is intended to be for releasing long-term data.
- * no guarantees are assumed on whether any properties have been retained
- * or not.
- * <li> [2] This transition happens if and only if the tag ends normally
- * without raising an exception
- * <li> [3] Some setters may be called again before a tag handler is
- * reused. For instance, <code>setParent()</code> is called if it's
- * reused within the same page but at a different level,
- * <code>setPageContext()</code> is called if it's used in another page,
- * and attribute setters are called if the values differ or are expressed
- * as request-time attribute values.
- * <li> Check the TryCatchFinally interface for additional details related
- * to exception handling and resource management.
+ * <li>[1] This transition is intended to be for releasing long-term data. no guarantees are assumed on whether any
+ * properties have been retained or not.
+ * <li>[2] This transition happens if and only if the tag ends normally without raising an exception
+ * <li>[3] Some setters may be called again before a tag handler is reused. For instance, <code>setParent()</code> is
+ * called if it's reused within the same page but at a different level, <code>setPageContext()</code> is called if it's
+ * used in another page, and attribute setters are called if the values differ or are expressed as request-time
+ * attribute values.
+ * <li>Check the TryCatchFinally interface for additional details related to exception handling and resource management.
* </ul>
- *
- * <IMG src="doc-files/TagProtocol.gif"
- * alt="Lifecycle Details Transition Diagram for Tag">
- *
- * <p>Once all invocations on the tag handler
- * are completed, the release method is invoked on it. Once a release
- * method is invoked <em>all</em> properties, including parent and
- * pageContext, are assumed to have been reset to an unspecified value.
- * The page compiler guarantees that release() will be invoked on the Tag
- * handler before the handler is released to the GC.</p>
- *
- * <p><B>Empty and Non-Empty Action</B></p>
- * <p>If the TagLibraryDescriptor file indicates that the action must
- * always have an empty action, by an <body-content> entry of "empty",
- * then the doStartTag() method must return SKIP_BODY.</p>
- *
- * <p>Otherwise, the doStartTag() method may return SKIP_BODY or
- * EVAL_BODY_INCLUDE.</p>
- *
- * <p>If SKIP_BODY is returned the body, if present, is not evaluated.</p>
- *
- * <p>If EVAL_BODY_INCLUDE is returned, the body is evaluated and
- * "passed through" to the current out.</p>
+ * <IMG src="doc-files/TagProtocol.gif" alt="Lifecycle Details Transition Diagram for Tag">
+ * <p>
+ * Once all invocations on the tag handler are completed, the release method is invoked on it. Once a release method is
+ * invoked <em>all</em> properties, including parent and pageContext, are assumed to have been reset to an unspecified
+ * value. The page compiler guarantees that release() will be invoked on the Tag handler before the handler is released
+ * to the GC.
+ * </p>
+ * <p>
+ * <B>Empty and Non-Empty Action</B>
+ * </p>
+ * <p>
+ * If the TagLibraryDescriptor file indicates that the action must always have an empty action, by an
+ * <body-content> entry of "empty", then the doStartTag() method must return SKIP_BODY.
+ * </p>
+ * <p>
+ * Otherwise, the doStartTag() method may return SKIP_BODY or EVAL_BODY_INCLUDE.
+ * </p>
+ * <p>
+ * If SKIP_BODY is returned the body, if present, is not evaluated.
+ * </p>
+ * <p>
+ * If EVAL_BODY_INCLUDE is returned, the body is evaluated and "passed through" to the current out.
+ * </p>
*/
public interface Tag extends JspTag {
/**
- * Skip body evaluation.
- * Valid return value for doStartTag and doAfterBody.
+ * Skip body evaluation. Valid return value for doStartTag and doAfterBody.
*/
int SKIP_BODY = 0;
/**
- * Evaluate body into existing out stream.
- * Valid return value for doStartTag.
+ * Evaluate body into existing out stream. Valid return value for doStartTag.
*/
int EVAL_BODY_INCLUDE = 1;
/**
- * Skip the rest of the page.
- * Valid return value for doEndTag.
+ * Skip the rest of the page. Valid return value for doEndTag.
*/
int SKIP_PAGE = 5;
/**
- * Continue evaluating the page.
- * Valid return value for doEndTag().
+ * Continue evaluating the page. Valid return value for doEndTag().
*/
int EVAL_PAGE = 6;
@@ -122,12 +114,10 @@ public interface Tag extends JspTag {
/**
- * Set the current page context.
- * This method is invoked by the JSP page implementation object
- * prior to doStartTag().
+ * Set the current page context. This method is invoked by the JSP page implementation object prior to doStartTag().
* <p>
- * This value is *not* reset by doEndTag() and must be explicitly reset
- * by a page implementation if it changes between calls to doStartTag().
+ * This value is *not* reset by doEndTag() and must be explicitly reset by a page implementation if it changes
+ * between calls to doStartTag().
*
* @param pc The page context for this tag handler.
*/
@@ -136,11 +126,10 @@ public interface Tag extends JspTag {
/**
- * Set the parent (closest enclosing tag handler) of this tag handler.
- * Invoked by the JSP page implementation object prior to doStartTag().
+ * Set the parent (closest enclosing tag handler) of this tag handler. Invoked by the JSP page implementation object
+ * prior to doStartTag().
* <p>
- * This value is *not* reset by doEndTag() and must be explicitly reset
- * by a page implementation.
+ * This value is *not* reset by doEndTag() and must be explicitly reset by a page implementation.
*
* @param t The parent tag, or null.
*/
@@ -151,27 +140,20 @@ public interface Tag extends JspTag {
/**
* Get the parent (closest enclosing tag handler) for this tag handler.
- *
* <p>
- * The getParent() method can be used to navigate the nested tag
- * handler structure at runtime for cooperation among custom actions;
- * for example, the findAncestorWithClass() method in TagSupport
- * provides a convenient way of doing this.
- *
+ * The getParent() method can be used to navigate the nested tag handler structure at runtime for cooperation among
+ * custom actions; for example, the findAncestorWithClass() method in TagSupport provides a convenient way of doing
+ * this.
* <p>
- * The current version of the specification only provides one formal
- * way of indicating the observable type of a tag handler: its
- * tag handler implementation class, described in the tag-class
- * sub-element of the tag element. This is extended in an
- * informal manner by allowing the tag library author to
- * indicate in the description sub-element an observable type.
- * The type should be a sub-type of the tag handler implementation
- * class or void.
- * This additional constraint can be exploited by a
- * specialized container that knows about that specific tag library,
- * as in the case of the JSP standard tag library.
+ * The current version of the specification only provides one formal way of indicating the observable type of a tag
+ * handler: its tag handler implementation class, described in the tag-class sub-element of the tag element. This is
+ * extended in an informal manner by allowing the tag library author to indicate in the description sub-element an
+ * observable type. The type should be a sub-type of the tag handler implementation class or void. This additional
+ * constraint can be exploited by a specialized container that knows about that specific tag library, as in the case
+ * of the JSP standard tag library.
*
* @return the current parent, or null if none.
+ *
* @see TagSupport#findAncestorWithClass
*/
@@ -182,40 +164,28 @@ public interface Tag extends JspTag {
/**
- * Process the start tag for this instance.
- * This method is invoked by the JSP page implementation object.
- *
+ * Process the start tag for this instance. This method is invoked by the JSP page implementation object.
* <p>
- * The doStartTag method assumes that the properties pageContext and
- * parent have been set. It also assumes that any properties exposed as
- * attributes have been set too. When this method is invoked, the body
- * has not yet been evaluated.
- *
+ * The doStartTag method assumes that the properties pageContext and parent have been set. It also assumes that any
+ * properties exposed as attributes have been set too. When this method is invoked, the body has not yet been
+ * evaluated.
* <p>
- * This method returns Tag.EVAL_BODY_INCLUDE or
- * BodyTag.EVAL_BODY_BUFFERED to indicate
- * that the body of the action should be evaluated or SKIP_BODY to
- * indicate otherwise.
- *
+ * This method returns Tag.EVAL_BODY_INCLUDE or BodyTag.EVAL_BODY_BUFFERED to indicate that the body of the action
+ * should be evaluated or SKIP_BODY to indicate otherwise.
* <p>
- * When a Tag returns EVAL_BODY_INCLUDE the result of evaluating
- * the body (if any) is included into the current "out" JspWriter as it
- * happens and then doEndTag() is invoked.
- *
+ * When a Tag returns EVAL_BODY_INCLUDE the result of evaluating the body (if any) is included into the current
+ * "out" JspWriter as it happens and then doEndTag() is invoked.
* <p>
- * BodyTag.EVAL_BODY_BUFFERED is only valid if the tag handler
- * implements BodyTag.
- *
+ * BodyTag.EVAL_BODY_BUFFERED is only valid if the tag handler implements BodyTag.
* <p>
- * The JSP container will resynchronize the values of any AT_BEGIN and
- * NESTED variables (defined by the associated TagExtraInfo or TLD)
- * after the invocation of doStartTag(), except for a tag handler
- * implementing BodyTag whose doStartTag() method returns
- * BodyTag.EVAL_BODY_BUFFERED.
+ * The JSP container will resynchronize the values of any AT_BEGIN and NESTED variables (defined by the associated
+ * TagExtraInfo or TLD) after the invocation of doStartTag(), except for a tag handler implementing BodyTag whose
+ * doStartTag() method returns BodyTag.EVAL_BODY_BUFFERED.
+ *
+ * @return EVAL_BODY_INCLUDE if the tag wants to process body, SKIP_BODY if it does not want to process it.
*
- * @return EVAL_BODY_INCLUDE if the tag wants to process body, SKIP_BODY
- * if it does not want to process it.
* @throws JspException if an error occurred while processing this tag
+ *
* @see BodyTag
*/
@@ -223,39 +193,31 @@ public interface Tag extends JspTag {
/**
- * Process the end tag for this instance.
- * This method is invoked by the JSP page implementation object
- * on all Tag handlers.
- *
+ * Process the end tag for this instance. This method is invoked by the JSP page implementation object on all Tag
+ * handlers.
* <p>
- * This method will be called after returning from doStartTag. The
- * body of the action may or may not have been evaluated, depending on
- * the return value of doStartTag.
- *
+ * This method will be called after returning from doStartTag. The body of the action may or may not have been
+ * evaluated, depending on the return value of doStartTag.
* <p>
- * If this method returns EVAL_PAGE, the rest of the page continues
- * to be evaluated. If this method returns SKIP_PAGE, the rest of
- * the page is not evaluated, the request is completed, and
- * the doEndTag() methods of enclosing tags are not invoked. If this
- * request was forwarded or included from another page (or Servlet),
- * only the current page evaluation is stopped.
- *
+ * If this method returns EVAL_PAGE, the rest of the page continues to be evaluated. If this method returns
+ * SKIP_PAGE, the rest of the page is not evaluated, the request is completed, and the doEndTag() methods of
+ * enclosing tags are not invoked. If this request was forwarded or included from another page (or Servlet), only
+ * the current page evaluation is stopped.
* <p>
- * The JSP container will resynchronize the values of any AT_BEGIN and
- * AT_END variables (defined by the associated TagExtraInfo or TLD)
- * after the invocation of doEndTag().
+ * The JSP container will resynchronize the values of any AT_BEGIN and AT_END variables (defined by the associated
+ * TagExtraInfo or TLD) after the invocation of doEndTag().
*
* @return indication of whether to continue evaluating the JSP page.
+ *
* @throws JspException if an error occurred while processing this tag
*/
int doEndTag() throws JspException;
/**
- * Called on a Tag handler to release state.
- * The page compiler guarantees that JSP page implementation
- * objects will invoke this method on all tag handlers,
- * but there may be multiple invocations on doStartTag and doEndTag in between.
+ * Called on a Tag handler to release state. The page compiler guarantees that JSP page implementation objects will
+ * invoke this method on all tag handlers, but there may be multiple invocations on doStartTag and doEndTag in
+ * between.
*/
void release();
diff --git a/java/javax/servlet/jsp/tagext/TagAdapter.java b/java/javax/servlet/jsp/tagext/TagAdapter.java
index 736cfabb3f..09fd923092 100644
--- a/java/javax/servlet/jsp/tagext/TagAdapter.java
+++ b/java/javax/servlet/jsp/tagext/TagAdapter.java
@@ -20,15 +20,13 @@ import javax.servlet.jsp.JspException;
import javax.servlet.jsp.PageContext;
/**
- * Wraps any SimpleTag and exposes it using a Tag interface. This is used to
- * allow collaboration between classic Tag handlers and SimpleTag handlers.
+ * Wraps any SimpleTag and exposes it using a Tag interface. This is used to allow collaboration between classic Tag
+ * handlers and SimpleTag handlers.
* <p>
- * Because SimpleTag does not extend Tag, and because Tag.setParent() only
- * accepts a Tag instance, a classic tag handler (one that implements Tag)
- * cannot have a SimpleTag as its parent. To remedy this, a TagAdapter is
- * created to wrap the SimpleTag parent, and the adapter is passed to
- * setParent() instead. A classic Tag Handler can call getAdaptee() to retrieve
- * the encapsulated SimpleTag instance.
+ * Because SimpleTag does not extend Tag, and because Tag.setParent() only accepts a Tag instance, a classic tag handler
+ * (one that implements Tag) cannot have a SimpleTag as its parent. To remedy this, a TagAdapter is created to wrap the
+ * SimpleTag parent, and the adapter is passed to setParent() instead. A classic Tag Handler can call getAdaptee() to
+ * retrieve the encapsulated SimpleTag instance.
*
* @since JSP 2.0
*/
@@ -43,11 +41,9 @@ public class TagAdapter implements Tag {
private boolean parentDetermined;
/**
- * Creates a new TagAdapter that wraps the given SimpleTag and returns the
- * parent tag when getParent() is called.
+ * Creates a new TagAdapter that wraps the given SimpleTag and returns the parent tag when getParent() is called.
*
- * @param adaptee
- * The SimpleTag being adapted as a Tag.
+ * @param adaptee The SimpleTag being adapted as a Tag.
*/
public TagAdapter(SimpleTag adaptee) {
if (adaptee == null) {
@@ -60,37 +56,31 @@ public class TagAdapter implements Tag {
/**
* Must not be called.
*
- * @param pc
- * ignored.
- * @throws UnsupportedOperationException
- * Must not be called
+ * @param pc ignored.
+ *
+ * @throws UnsupportedOperationException Must not be called
*/
@Override
public void setPageContext(PageContext pc) {
- throw new UnsupportedOperationException(
- "Illegal to invoke setPageContext() on TagAdapter wrapper");
+ throw new UnsupportedOperationException("Illegal to invoke setPageContext() on TagAdapter wrapper");
}
/**
- * Must not be called. The parent of this tag is always
- * getAdaptee().getParent().
+ * Must not be called. The parent of this tag is always getAdaptee().getParent().
+ *
+ * @param parentTag ignored.
*
- * @param parentTag
- * ignored.
- * @throws UnsupportedOperationException
- * Must not be called.
+ * @throws UnsupportedOperationException Must not be called.
*/
@Override
public void setParent(Tag parentTag) {
- throw new UnsupportedOperationException(
- "Illegal to invoke setParent() on TagAdapter wrapper");
+ throw new UnsupportedOperationException("Illegal to invoke setParent() on TagAdapter wrapper");
}
/**
- * Returns the parent of this tag, which is always getAdaptee().getParent().
- * This will either be the enclosing Tag (if getAdaptee().getParent()
- * implements Tag), or an adapter to the enclosing Tag (if
- * getAdaptee().getParent() does not implement Tag).
+ * Returns the parent of this tag, which is always getAdaptee().getParent(). This will either be the enclosing Tag
+ * (if getAdaptee().getParent() implements Tag), or an adapter to the enclosing Tag (if getAdaptee().getParent()
+ * does not implement Tag).
*
* @return The parent of the tag being adapted.
*/
@@ -113,9 +103,8 @@ public class TagAdapter implements Tag {
}
/**
- * Gets the tag that is being adapted to the Tag interface. This should be
- * an instance of SimpleTag in JSP 2.0, but room is left for other kinds of
- * tags in future spec versions.
+ * Gets the tag that is being adapted to the Tag interface. This should be an instance of SimpleTag in JSP 2.0, but
+ * room is left for other kinds of tags in future spec versions.
*
* @return the tag that is being adapted
*/
@@ -127,41 +116,35 @@ public class TagAdapter implements Tag {
* Must not be called.
*
* @return always throws UnsupportedOperationException
- * @throws UnsupportedOperationException
- * Must not be called
- * @throws JspException
- * never thrown
+ *
+ * @throws UnsupportedOperationException Must not be called
+ * @throws JspException never thrown
*/
@Override
public int doStartTag() throws JspException {
- throw new UnsupportedOperationException(
- "Illegal to invoke doStartTag() on TagAdapter wrapper");
+ throw new UnsupportedOperationException("Illegal to invoke doStartTag() on TagAdapter wrapper");
}
/**
* Must not be called.
*
* @return always throws UnsupportedOperationException
- * @throws UnsupportedOperationException
- * Must not be called
- * @throws JspException
- * never thrown
+ *
+ * @throws UnsupportedOperationException Must not be called
+ * @throws JspException never thrown
*/
@Override
public int doEndTag() throws JspException {
- throw new UnsupportedOperationException(
- "Illegal to invoke doEndTag() on TagAdapter wrapper");
+ throw new UnsupportedOperationException("Illegal to invoke doEndTag() on TagAdapter wrapper");
}
/**
* Must not be called.
*
- * @throws UnsupportedOperationException
- * Must not be called
+ * @throws UnsupportedOperationException Must not be called
*/
@Override
public void release() {
- throw new UnsupportedOperationException(
- "Illegal to invoke release() on TagAdapter wrapper");
+ throw new UnsupportedOperationException("Illegal to invoke release() on TagAdapter wrapper");
}
}
diff --git a/java/javax/servlet/jsp/tagext/TagAttributeInfo.java b/java/javax/servlet/jsp/tagext/TagAttributeInfo.java
index 55545c2a6a..ab1b08bb39 100644
--- a/java/javax/servlet/jsp/tagext/TagAttributeInfo.java
+++ b/java/javax/servlet/jsp/tagext/TagAttributeInfo.java
@@ -17,100 +17,72 @@
package javax.servlet.jsp.tagext;
/**
- * Information on the attributes of a Tag, available at translation time. This
- * class is instantiated from the Tag Library Descriptor file (TLD).
- *
+ * Information on the attributes of a Tag, available at translation time. This class is instantiated from the Tag
+ * Library Descriptor file (TLD).
* <p>
- * Only the information needed to generate code is included here. Other
- * information like SCHEMA for validation belongs elsewhere.
+ * Only the information needed to generate code is included here. Other information like SCHEMA for validation belongs
+ * elsewhere.
*/
public class TagAttributeInfo {
/**
- * "id" is wired in to be ID. There is no real benefit in having it be
- * something else IDREFs are not handled any differently.
+ * "id" is wired in to be ID. There is no real benefit in having it be something else IDREFs are not handled any
+ * differently.
*/
public static final String ID = "id";
/**
- * Constructor for TagAttributeInfo. This class is to be instantiated only
- * from the TagLibrary code under request from some JSP code that is parsing
- * a TLD (Tag Library Descriptor).
+ * Constructor for TagAttributeInfo. This class is to be instantiated only from the TagLibrary code under request
+ * from some JSP code that is parsing a TLD (Tag Library Descriptor).
*
- * @param name
- * The name of the attribute.
- * @param required
- * If this attribute is required in tag instances.
- * @param type
- * The name of the type of the attribute.
- * @param reqTime
- * Whether this attribute holds a request-time Attribute.
+ * @param name The name of the attribute.
+ * @param required If this attribute is required in tag instances.
+ * @param type The name of the type of the attribute.
+ * @param reqTime Whether this attribute holds a request-time Attribute.
*/
- public TagAttributeInfo(String name, boolean required, String type,
- boolean reqTime) {
+ public TagAttributeInfo(String name, boolean required, String type, boolean reqTime) {
this(name, required, type, reqTime, false);
}
/**
- * JSP 2.0 Constructor for TagAttributeInfo. This class is to be
- * instantiated only from the TagLibrary code under request from some JSP
- * code that is parsing a TLD (Tag Library Descriptor).
+ * JSP 2.0 Constructor for TagAttributeInfo. This class is to be instantiated only from the TagLibrary code under
+ * request from some JSP code that is parsing a TLD (Tag Library Descriptor).
*
- * @param name
- * The name of the attribute.
- * @param required
- * If this attribute is required in tag instances.
- * @param type
- * The name of the type of the attribute.
- * @param reqTime
- * Whether this attribute holds a request-time Attribute.
- * @param fragment
- * Whether this attribute is of type JspFragment
+ * @param name The name of the attribute.
+ * @param required If this attribute is required in tag instances.
+ * @param type The name of the type of the attribute.
+ * @param reqTime Whether this attribute holds a request-time Attribute.
+ * @param fragment Whether this attribute is of type JspFragment
*
* @since JSP 2.0
*/
- public TagAttributeInfo(String name, boolean required, String type,
- boolean reqTime, boolean fragment) {
+ public TagAttributeInfo(String name, boolean required, String type, boolean reqTime, boolean fragment) {
this(name, required, type, reqTime, fragment, null, false, false, null, null);
}
/**
- * JSP 2.1 Constructor for TagAttributeInfo. This class is to be
- * instantiated only from the TagLibrary code under request from some JSP
- * code that is parsing a TLD (Tag Library Descriptor).
+ * JSP 2.1 Constructor for TagAttributeInfo. This class is to be instantiated only from the TagLibrary code under
+ * request from some JSP code that is parsing a TLD (Tag Library Descriptor).
*
- * @param name
- * The name of the attribute.
- * @param required
- * If this attribute is required in tag instances.
- * @param type
- * The name of the type of the attribute.
- * @param reqTime
- * Whether this attribute holds a request-time Attribute.
- * @param fragment
- * Whether this attribute is of type JspFragment
- * @param description
- * Description of this attribute
- * @param deferredValue
- * Does this attribute accept value expressions (written as
- * Strings) as attribute values the evaluation of which is
- * deferred until calculated by the tag
- * @param deferredMethod
- * Does this attribute accept method expressions (written as
- * Strings) as attribute values the evaluation of which is
- * deferred until calculated by the tag
- * @param expectedTypeName
- * The expected type when the deferred value is evaluated
- * @param methodSignature
- * The expected method signature if a deferred method
+ * @param name The name of the attribute.
+ * @param required If this attribute is required in tag instances.
+ * @param type The name of the type of the attribute.
+ * @param reqTime Whether this attribute holds a request-time Attribute.
+ * @param fragment Whether this attribute is of type JspFragment
+ * @param description Description of this attribute
+ * @param deferredValue Does this attribute accept value expressions (written as Strings) as attribute values the
+ * evaluation of which is deferred until calculated by the tag
+ * @param deferredMethod Does this attribute accept method expressions (written as Strings) as attribute values
+ * the evaluation of which is deferred until calculated by the tag
+ * @param expectedTypeName The expected type when the deferred value is evaluated
+ * @param methodSignature The expected method signature if a deferred method
*
* @since JSP 2.1
*/
- public TagAttributeInfo(String name, boolean required, String type,
- boolean reqTime, boolean fragment, String description,
- boolean deferredValue, boolean deferredMethod,
- String expectedTypeName, String methodSignature) {
+ public TagAttributeInfo(String name, boolean required, String type, boolean reqTime, boolean fragment,
+ String description, boolean deferredValue, boolean deferredMethod, String expectedTypeName,
+ String methodSignature) {
this.name = name;
this.required = required;
this.type = type;
@@ -160,11 +132,10 @@ public class TagAttributeInfo {
}
/**
- * Convenience static method that goes through an array of TagAttributeInfo
- * objects and looks for "id".
+ * Convenience static method that goes through an array of TagAttributeInfo objects and looks for "id".
+ *
+ * @param tagAttributeInfos An array of TagAttributeInfo
*
- * @param tagAttributeInfos
- * An array of TagAttributeInfo
* @return The TagAttributeInfo reference with name "id"
*/
public static TagAttributeInfo getIdAttribute(TagAttributeInfo[] tagAttributeInfos) {
@@ -188,8 +159,7 @@ public class TagAttributeInfo {
}
/**
- * Returns a String representation of this TagAttributeInfo, suitable for
- * debugging purposes.
+ * Returns a String representation of this TagAttributeInfo, suitable for debugging purposes.
*
* @return a String representation of this TagAttributeInfo
*/
@@ -240,8 +210,7 @@ public class TagAttributeInfo {
/**
* Does the attribute expect to be passed a deferred method?
*
- * @return {@code true} if a deferred method expression is expected,
- * otherwise {@code false}
+ * @return {@code true} if a deferred method expression is expected, otherwise {@code false}
*/
public boolean isDeferredMethod() {
return deferredMethod;
@@ -250,8 +219,7 @@ public class TagAttributeInfo {
/**
* Does the attribute expect to be passed a deferred value?
*
- * @return {@code true} if a deferred value expression is expected,
- * otherwise {@code false}
+ * @return {@code true} if a deferred value expression is expected, otherwise {@code false}
*/
public boolean isDeferredValue() {
return deferredValue;
@@ -276,11 +244,9 @@ public class TagAttributeInfo {
}
/**
- * If this is a deferred method attribute, obtain the expected method
- * signature.
+ * If this is a deferred method attribute, obtain the expected method signature.
*
- * @return The expected method signature or {@code null} if this attribute
- * is not a deferred method attribute
+ * @return The expected method signature or {@code null} if this attribute is not a deferred method attribute
*/
public String getMethodSignature() {
return methodSignature;
diff --git a/java/javax/servlet/jsp/tagext/TagData.java b/java/javax/servlet/jsp/tagext/TagData.java
index d603811228..4ea79fd05f 100644
--- a/java/javax/servlet/jsp/tagext/TagData.java
+++ b/java/javax/servlet/jsp/tagext/TagData.java
@@ -20,19 +20,16 @@ import java.util.Hashtable;
/**
* The (translation-time only) attribute/value information for a tag instance.
- *
* <p>
- * TagData is only used as an argument to the isValid, validate, and
- * getVariableInfo methods of TagExtraInfo, which are invoked at
- * translation time.
+ * TagData is only used as an argument to the isValid, validate, and getVariableInfo methods of TagExtraInfo, which are
+ * invoked at translation time.
*/
public class TagData implements Cloneable {
/**
- * Distinguished value for an attribute to indicate its value
- * is a request-time expression (which is not yet available because
- * TagData instances are used at translation-time).
+ * Distinguished value for an attribute to indicate its value is a request-time expression (which is not yet
+ * available because TagData instances are used at translation-time).
*/
public static final Object REQUEST_TIME_VALUE = new Object();
@@ -40,18 +37,17 @@ public class TagData implements Cloneable {
/**
* Constructor for TagData.
- *
* <p>
* A typical constructor may be
+ *
* <pre>
- * static final Object[][] att = {{"connection", "conn0"}, {"id", "query0"}};
+ * static final Object[][] att = { { "connection", "conn0" }, { "id", "query0" } };
* static final TagData td = new TagData(att);
* </pre>
*
- * All values must be Strings except for those holding the
- * distinguished object REQUEST_TIME_VALUE.
+ * All values must be Strings except for those holding the distinguished object REQUEST_TIME_VALUE.
*
- * @param atts the static attribute and values. May be null.
+ * @param atts the static attribute and values. May be null.
*/
public TagData(Object[] atts[]) {
if (atts == null) {
@@ -68,22 +64,18 @@ public class TagData implements Cloneable {
}
/**
- * Constructor for a TagData.
- *
- * If you already have the attributes in a hashtable, use this
- * constructor.
+ * Constructor for a TagData. If you already have the attributes in a hashtable, use this constructor.
*
* @param attrs A hashtable to get the values from.
*/
- public TagData(Hashtable<String, Object> attrs) {
+ public TagData(Hashtable<String,Object> attrs) {
this.attributes = attrs;
}
/**
* The value of the tag's id attribute.
*
- * @return the value of the tag's id attribute, or null if no such
- * attribute was specified.
+ * @return the value of the tag's id attribute, or null if no such attribute was specified.
*/
public String getId() {
@@ -91,18 +83,15 @@ public class TagData implements Cloneable {
}
/**
- * The value of the attribute.
- * If a static value is specified for an attribute that accepts a
- * request-time attribute expression then that static value is returned,
- * even if the value is provided in the body of a <jsp:attribute>
- * action. The distinguished object REQUEST_TIME_VALUE is only returned if
- * the value is specified as a request-time attribute expression
- * or via the <jsp:attribute> action with a body that contains
- * dynamic content (scriptlets, scripting expressions, EL expressions,
- * standard actions, or custom actions). Returns null if the attribute
- * is not set.
+ * The value of the attribute. If a static value is specified for an attribute that accepts a request-time attribute
+ * expression then that static value is returned, even if the value is provided in the body of a
+ * <jsp:attribute> action. The distinguished object REQUEST_TIME_VALUE is only returned if the value is
+ * specified as a request-time attribute expression or via the <jsp:attribute> action with a body that
+ * contains dynamic content (scriptlets, scripting expressions, EL expressions, standard actions, or custom
+ * actions). Returns null if the attribute is not set.
*
* @param attName the name of the attribute
+ *
* @return the attribute's value
*/
@@ -114,10 +103,9 @@ public class TagData implements Cloneable {
* Set the value of an attribute.
*
* @param attName the name of the attribute
- * @param value the value.
+ * @param value the value.
*/
- public void setAttribute(String attName,
- Object value) {
+ public void setAttribute(String attName, Object value) {
attributes.put(attName, value);
}
@@ -125,7 +113,9 @@ public class TagData implements Cloneable {
* Get the value for a given attribute.
*
* @param attName the name of the attribute
+ *
* @return the attribute value string
+ *
* @throws ClassCastException if attribute value is not a String
*/
@@ -148,5 +138,5 @@ public class TagData implements Cloneable {
// private data
- private final Hashtable<String, Object> attributes; // the tagname/value map
+ private final Hashtable<String,Object> attributes; // the tagname/value map
}
diff --git a/java/javax/servlet/jsp/tagext/TagExtraInfo.java b/java/javax/servlet/jsp/tagext/TagExtraInfo.java
index 98e0413395..9431cabdc1 100644
--- a/java/javax/servlet/jsp/tagext/TagExtraInfo.java
+++ b/java/javax/servlet/jsp/tagext/TagExtraInfo.java
@@ -17,70 +17,60 @@
package javax.servlet.jsp.tagext;
/**
- * Optional class provided by the tag library author to describe additional
- * translation-time information not described in the TLD.
- * The TagExtraInfo class is mentioned in the Tag Library Descriptor file (TLD).
- *
+ * Optional class provided by the tag library author to describe additional translation-time information not described
+ * in the TLD. The TagExtraInfo class is mentioned in the Tag Library Descriptor file (TLD).
* <p>
* This class can be used:
* <ul>
- * <li> to indicate that the tag defines scripting variables
- * <li> to perform translation-time validation of the tag attributes.
+ * <li>to indicate that the tag defines scripting variables
+ * <li>to perform translation-time validation of the tag attributes.
* </ul>
- *
* <p>
- * It is the responsibility of the JSP translator that the initial value
- * to be returned by calls to getTagInfo() corresponds to a TagInfo
- * object for the tag being translated. If an explicit call to
- * setTagInfo() is done, then the object passed will be returned in
- * subsequent calls to getTagInfo().
- *
+ * It is the responsibility of the JSP translator that the initial value to be returned by calls to getTagInfo()
+ * corresponds to a TagInfo object for the tag being translated. If an explicit call to setTagInfo() is done, then the
+ * object passed will be returned in subsequent calls to getTagInfo().
* <p>
- * The only way to affect the value returned by getTagInfo()
- * is through a setTagInfo() call, and thus, TagExtraInfo.setTagInfo() is
- * to be called by the JSP translator, with a TagInfo object that
- * corresponds to the tag being translated. The call should happen before
- * any invocation on validate() and before any invocation on
+ * The only way to affect the value returned by getTagInfo() is through a setTagInfo() call, and thus,
+ * TagExtraInfo.setTagInfo() is to be called by the JSP translator, with a TagInfo object that corresponds to the tag
+ * being translated. The call should happen before any invocation on validate() and before any invocation on
* getVariableInfo().
- *
* <p>
- * <b>NOTE:</b> It is a (translation time) error for a tag definition
- * in a TLD with one or more variable subelements to have an associated
- * TagExtraInfo implementation that returns a VariableInfo array with
- * one or more elements from a call to getVariableInfo().
+ * <b>NOTE:</b> It is a (translation time) error for a tag definition in a TLD with one or more variable subelements to
+ * have an associated TagExtraInfo implementation that returns a VariableInfo array with one or more elements from a
+ * call to getVariableInfo().
*/
public abstract class TagExtraInfo {
/**
- * Sole constructor. (For invocation by subclass constructors,
- * typically implicit.)
+ * Sole constructor. (For invocation by subclass constructors, typically implicit.)
*/
public TagExtraInfo() {
// NOOP by default
}
/**
- * information on scripting variables defined by the tag associated with
- * this TagExtraInfo instance.
- * Request-time attributes are indicated as such in the TagData parameter.
+ * information on scripting variables defined by the tag associated with this TagExtraInfo instance. Request-time
+ * attributes are indicated as such in the TagData parameter.
*
* @param data The TagData instance.
- * @return An array of VariableInfo data, or null or a zero length array
- * if no scripting variables are to be defined.
+ *
+ * @return An array of VariableInfo data, or null or a zero length array if no scripting variables are to be
+ * defined.
*/
public VariableInfo[] getVariableInfo(TagData data) {
return ZERO_VARIABLE_INFO;
}
/**
- * Translation-time validation of the attributes.
- * Request-time attributes are indicated as such in the TagData parameter.
- * Note that the preferred way to do validation is with the validate()
- * method, since it can return more detailed information.
+ * Translation-time validation of the attributes. Request-time attributes are indicated as such in the TagData
+ * parameter. Note that the preferred way to do validation is with the validate() method, since it can return more
+ * detailed information.
*
* @param data The TagData instance.
+ *
* @return Whether this tag instance is valid.
+ *
* @see TagExtraInfo#validate
*/
@@ -89,28 +79,26 @@ public abstract class TagExtraInfo {
}
/**
- * Translation-time validation of the attributes.
- * Request-time attributes are indicated as such in the TagData parameter.
- * Because of the higher quality validation messages possible,
- * this is the preferred way to do validation (although isValid()
- * still works).
- *
- * <p>JSP 2.0 and higher containers call validate() instead of isValid().
- * The default implementation of this method is to call isValid(). If
- * isValid() returns false, a generic ValidationMessage[] is returned
- * indicating isValid() returned false.</p>
+ * Translation-time validation of the attributes. Request-time attributes are indicated as such in the TagData
+ * parameter. Because of the higher quality validation messages possible, this is the preferred way to do validation
+ * (although isValid() still works).
+ * <p>
+ * JSP 2.0 and higher containers call validate() instead of isValid(). The default implementation of this method is
+ * to call isValid(). If isValid() returns false, a generic ValidationMessage[] is returned indicating isValid()
+ * returned false.
+ * </p>
*
* @param data The TagData instance.
- * @return A null object, or zero length array if no errors, an
- * array of ValidationMessages otherwise.
+ *
+ * @return A null object, or zero length array if no errors, an array of ValidationMessages otherwise.
+ *
* @since JSP 2.0
*/
- public ValidationMessage[] validate( TagData data ) {
+ public ValidationMessage[] validate(TagData data) {
ValidationMessage[] result = null;
- if( !isValid( data ) ) {
- result = new ValidationMessage[] {
- new ValidationMessage( data.getId(), "isValid() == false" ) };
+ if (!isValid(data)) {
+ result = new ValidationMessage[] { new ValidationMessage(data.getId(), "isValid() == false") };
}
return result;
@@ -135,9 +123,9 @@ public abstract class TagExtraInfo {
}
// private data
- private TagInfo tagInfo;
+ private TagInfo tagInfo;
// zero length VariableInfo array
- private static final VariableInfo[] ZERO_VARIABLE_INFO = { };
+ private static final VariableInfo[] ZERO_VARIABLE_INFO = {};
}
diff --git a/java/javax/servlet/jsp/tagext/TagFileInfo.java b/java/javax/servlet/jsp/tagext/TagFileInfo.java
index 0432afcaf4..a254fc5456 100644
--- a/java/javax/servlet/jsp/tagext/TagFileInfo.java
+++ b/java/javax/servlet/jsp/tagext/TagFileInfo.java
@@ -17,32 +17,24 @@
package javax.servlet.jsp.tagext;
/**
- * Tag information for a tag file in a Tag Library;
- * This class is instantiated from the Tag Library Descriptor file (TLD)
- * and is available only at translation time.
+ * Tag information for a tag file in a Tag Library; This class is instantiated from the Tag Library Descriptor file
+ * (TLD) and is available only at translation time.
*
* @since JSP 2.0
*/
public class TagFileInfo {
/**
- * Constructor for TagFileInfo from data in the JSP 2.0 format for TLD.
- * This class is to be instantiated only from the TagLibrary code
- * under request from some JSP code that is parsing a
- * TLD (Tag Library Descriptor).
+ * Constructor for TagFileInfo from data in the JSP 2.0 format for TLD. This class is to be instantiated only from
+ * the TagLibrary code under request from some JSP code that is parsing a TLD (Tag Library Descriptor). Note that,
+ * since TagLibraryInfo reflects both TLD information and taglib directive information, a TagFileInfo instance is
+ * dependent on a taglib directive. This is probably a design error, which may be fixed in the future.
*
- * Note that, since TagLibraryInfo reflects both TLD information
- * and taglib directive information, a TagFileInfo instance is
- * dependent on a taglib directive. This is probably a
- * design error, which may be fixed in the future.
- *
- * @param name The unique action name of this tag
- * @param path Where to find the .tag file implementing this
- * action, relative to the location of the TLD file.
- * @param tagInfo The detailed information about this tag, as parsed
- * from the directives in the tag file.
+ * @param name The unique action name of this tag
+ * @param path Where to find the .tag file implementing this action, relative to the location of the TLD file.
+ * @param tagInfo The detailed information about this tag, as parsed from the directives in the tag file.
*/
- public TagFileInfo( String name, String path, TagInfo tagInfo ) {
+ public TagFileInfo(String name, String path, TagInfo tagInfo) {
this.name = name;
this.path = path;
this.tagInfo = tagInfo;
@@ -60,16 +52,15 @@ public class TagFileInfo {
/**
* Where to find the .tag file implementing this action.
*
- * @return The path of the tag file, relative to the TLD, or "." if
- * the tag file was defined in an implicit tag file.
+ * @return The path of the tag file, relative to the TLD, or "." if the tag file was defined in an implicit tag
+ * file.
*/
public String getPath() {
return path;
}
/**
- * Returns information about this tag, parsed from the directives
- * in the tag file.
+ * Returns information about this tag, parsed from the directives in the tag file.
*
* @return a TagInfo object containing information about this tag
*/
diff --git a/java/javax/servlet/jsp/tagext/TagInfo.java b/java/javax/servlet/jsp/tagext/TagInfo.java
index 3129a7e2aa..40c19c2d3d 100644
--- a/java/javax/servlet/jsp/tagext/TagInfo.java
+++ b/java/javax/servlet/jsp/tagext/TagInfo.java
@@ -17,9 +17,8 @@
package javax.servlet.jsp.tagext;
/**
- * Tag information for a tag in a Tag Library;
- * This class is instantiated from the Tag Library Descriptor file (TLD)
- * and is available only at translation time.
+ * Tag information for a tag in a Tag Library; This class is instantiated from the Tag Library Descriptor file (TLD) and
+ * is available only at translation time.
*/
public class TagInfo {
@@ -48,39 +47,27 @@ public class TagInfo {
public static final String BODY_CONTENT_SCRIPTLESS = "scriptless";
/**
- * Constructor for TagInfo from data in the JSP 1.1 format for TLD.
- * This class is to be instantiated only from the TagLibrary code
- * under request from some JSP code that is parsing a
- * TLD (Tag Library Descriptor).
- *
- * Note that, since TagLibraryInfo reflects both TLD information
- * and taglib directive information, a TagInfo instance is
- * dependent on a taglib directive. This is probably a
- * design error, which may be fixed in the future.
- *
- * @param tagName The name of this tag
- * @param tagClassName The name of the tag handler class
- * @param bodycontent Information on the body content of these tags
- * @param infoString The (optional) string information for this tag
- * @param taglib The instance of the tag library that contains us.
- * @param tagExtraInfo The instance providing extra Tag info. May be null
- * @param attributeInfo An array of AttributeInfo data from descriptor.
- * May be null;
+ * Constructor for TagInfo from data in the JSP 1.1 format for TLD. This class is to be instantiated only from the
+ * TagLibrary code under request from some JSP code that is parsing a TLD (Tag Library Descriptor). Note that, since
+ * TagLibraryInfo reflects both TLD information and taglib directive information, a TagInfo instance is dependent on
+ * a taglib directive. This is probably a design error, which may be fixed in the future.
*
+ * @param tagName The name of this tag
+ * @param tagClassName The name of the tag handler class
+ * @param bodycontent Information on the body content of these tags
+ * @param infoString The (optional) string information for this tag
+ * @param taglib The instance of the tag library that contains us.
+ * @param tagExtraInfo The instance providing extra Tag info. May be null
+ * @param attributeInfo An array of AttributeInfo data from descriptor. May be null;
*/
- public TagInfo(String tagName,
- String tagClassName,
- String bodycontent,
- String infoString,
- TagLibraryInfo taglib,
- TagExtraInfo tagExtraInfo,
- TagAttributeInfo[] attributeInfo) {
- this.tagName = tagName;
- this.tagClassName = tagClassName;
- this.bodyContent = bodycontent;
- this.infoString = infoString;
- this.tagLibrary = taglib;
- this.tagExtraInfo = tagExtraInfo;
+ public TagInfo(String tagName, String tagClassName, String bodycontent, String infoString, TagLibraryInfo taglib,
+ TagExtraInfo tagExtraInfo, TagAttributeInfo[] attributeInfo) {
+ this.tagName = tagName;
+ this.tagClassName = tagClassName;
+ this.bodyContent = bodycontent;
+ this.infoString = infoString;
+ this.tagLibrary = taglib;
+ this.tagExtraInfo = tagExtraInfo;
this.attributeInfo = attributeInfo;
// Use defaults for unspecified values
@@ -96,46 +83,32 @@ public class TagInfo {
}
/**
- * Constructor for TagInfo from data in the JSP 1.2 format for TLD.
- * This class is to be instantiated only from the TagLibrary code
- * under request from some JSP code that is parsing a
- * TLD (Tag Library Descriptor).
- *
- * Note that, since TagLibraryInfo reflects both TLD information
- * and taglib directive information, a TagInfo instance is
- * dependent on a taglib directive. This is probably a
- * design error, which may be fixed in the future.
+ * Constructor for TagInfo from data in the JSP 1.2 format for TLD. This class is to be instantiated only from the
+ * TagLibrary code under request from some JSP code that is parsing a TLD (Tag Library Descriptor). Note that, since
+ * TagLibraryInfo reflects both TLD information and taglib directive information, a TagInfo instance is dependent on
+ * a taglib directive. This is probably a design error, which may be fixed in the future.
*
- * @param tagName The name of this tag
- * @param tagClassName The name of the tag handler class
- * @param bodycontent Information on the body content of these tags
- * @param infoString The (optional) string information for this tag
- * @param taglib The instance of the tag library that contains us.
- * @param tagExtraInfo The instance providing extra Tag info. May be null
- * @param attributeInfo An array of AttributeInfo data from descriptor.
- * May be null;
- * @param displayName A short name to be displayed by tools
- * @param smallIcon Path to a small icon to be displayed by tools
- * @param largeIcon Path to a large icon to be displayed by tools
- * @param tvi An array of a TagVariableInfo (or null)
+ * @param tagName The name of this tag
+ * @param tagClassName The name of the tag handler class
+ * @param bodycontent Information on the body content of these tags
+ * @param infoString The (optional) string information for this tag
+ * @param taglib The instance of the tag library that contains us.
+ * @param tagExtraInfo The instance providing extra Tag info. May be null
+ * @param attributeInfo An array of AttributeInfo data from descriptor. May be null;
+ * @param displayName A short name to be displayed by tools
+ * @param smallIcon Path to a small icon to be displayed by tools
+ * @param largeIcon Path to a large icon to be displayed by tools
+ * @param tvi An array of a TagVariableInfo (or null)
*/
- public TagInfo(String tagName,
- String tagClassName,
- String bodycontent,
- String infoString,
- TagLibraryInfo taglib,
- TagExtraInfo tagExtraInfo,
- TagAttributeInfo[] attributeInfo,
- String displayName,
- String smallIcon,
- String largeIcon,
- TagVariableInfo[] tvi) {
- this.tagName = tagName;
- this.tagClassName = tagClassName;
- this.bodyContent = bodycontent;
- this.infoString = infoString;
- this.tagLibrary = taglib;
- this.tagExtraInfo = tagExtraInfo;
+ public TagInfo(String tagName, String tagClassName, String bodycontent, String infoString, TagLibraryInfo taglib,
+ TagExtraInfo tagExtraInfo, TagAttributeInfo[] attributeInfo, String displayName, String smallIcon,
+ String largeIcon, TagVariableInfo[] tvi) {
+ this.tagName = tagName;
+ this.tagClassName = tagClassName;
+ this.bodyContent = bodycontent;
+ this.infoString = infoString;
+ this.tagLibrary = taglib;
+ this.tagExtraInfo = tagExtraInfo;
this.attributeInfo = attributeInfo;
this.displayName = displayName;
this.smallIcon = smallIcon;
@@ -151,50 +124,35 @@ public class TagInfo {
}
/**
- * Constructor for TagInfo from data in the JSP 2.0 format for TLD.
- * This class is to be instantiated only from the TagLibrary code
- * under request from some JSP code that is parsing a
- * TLD (Tag Library Descriptor).
+ * Constructor for TagInfo from data in the JSP 2.0 format for TLD. This class is to be instantiated only from the
+ * TagLibrary code under request from some JSP code that is parsing a TLD (Tag Library Descriptor). Note that, since
+ * TagLibraryInfo reflects both TLD information and taglib directive information, a TagInfo instance is dependent on
+ * a taglib directive. This is probably a design error, which may be fixed in the future.
*
- * Note that, since TagLibraryInfo reflects both TLD information
- * and taglib directive information, a TagInfo instance is
- * dependent on a taglib directive. This is probably a
- * design error, which may be fixed in the future.
- *
- * @param tagName The name of this tag
- * @param tagClassName The name of the tag handler class
- * @param bodycontent Information on the body content of these tags
- * @param infoString The (optional) string information for this tag
- * @param taglib The instance of the tag library that contains us.
- * @param tagExtraInfo The instance providing extra Tag info. May be null
- * @param attributeInfo An array of AttributeInfo data from descriptor.
- * May be null;
- * @param displayName A short name to be displayed by tools
- * @param smallIcon Path to a small icon to be displayed by tools
- * @param largeIcon Path to a large icon to be displayed by tools
- * @param tvi An array of a TagVariableInfo (or null)
+ * @param tagName The name of this tag
+ * @param tagClassName The name of the tag handler class
+ * @param bodycontent Information on the body content of these tags
+ * @param infoString The (optional) string information for this tag
+ * @param taglib The instance of the tag library that contains us.
+ * @param tagExtraInfo The instance providing extra Tag info. May be null
+ * @param attributeInfo An array of AttributeInfo data from descriptor. May be null;
+ * @param displayName A short name to be displayed by tools
+ * @param smallIcon Path to a small icon to be displayed by tools
+ * @param largeIcon Path to a large icon to be displayed by tools
+ * @param tvi An array of a TagVariableInfo (or null)
* @param dynamicAttributes True if supports dynamic attributes
*
* @since JSP 2.0
*/
- public TagInfo(String tagName,
- String tagClassName,
- String bodycontent,
- String infoString,
- TagLibraryInfo taglib,
- TagExtraInfo tagExtraInfo,
- TagAttributeInfo[] attributeInfo,
- String displayName,
- String smallIcon,
- String largeIcon,
- TagVariableInfo[] tvi,
- boolean dynamicAttributes) {
- this.tagName = tagName;
- this.tagClassName = tagClassName;
- this.bodyContent = bodycontent;
- this.infoString = infoString;
- this.tagLibrary = taglib;
- this.tagExtraInfo = tagExtraInfo;
+ public TagInfo(String tagName, String tagClassName, String bodycontent, String infoString, TagLibraryInfo taglib,
+ TagExtraInfo tagExtraInfo, TagAttributeInfo[] attributeInfo, String displayName, String smallIcon,
+ String largeIcon, TagVariableInfo[] tvi, boolean dynamicAttributes) {
+ this.tagName = tagName;
+ this.tagClassName = tagClassName;
+ this.bodyContent = bodycontent;
+ this.infoString = infoString;
+ this.tagLibrary = taglib;
+ this.tagExtraInfo = tagExtraInfo;
this.attributeInfo = attributeInfo;
this.displayName = displayName;
this.smallIcon = smallIcon;
@@ -217,40 +175,38 @@ public class TagInfo {
}
/**
- * Attribute information (in the TLD) on this tag.
- * The return is an array describing the attributes of this tag, as
+ * Attribute information (in the TLD) on this tag. The return is an array describing the attributes of this tag, as
* indicated in the TLD.
*
- * @return The array of TagAttributeInfo for this tag, or a
- * zero-length array if the tag has no attributes.
+ * @return The array of TagAttributeInfo for this tag, or a zero-length array if the tag has no attributes.
*/
public TagAttributeInfo[] getAttributes() {
return attributeInfo;
}
/**
- * Information on the scripting objects created by this tag at runtime.
- * This is a convenience method on the associated TagExtraInfo class.
+ * Information on the scripting objects created by this tag at runtime. This is a convenience method on the
+ * associated TagExtraInfo class.
*
* @param data TagData describing this action.
- * @return if a TagExtraInfo object is associated with this TagInfo, the
- * result of getTagExtraInfo().getVariableInfo( data ), otherwise
- * null.
+ *
+ * @return if a TagExtraInfo object is associated with this TagInfo, the result of
+ * getTagExtraInfo().getVariableInfo( data ), otherwise null.
*/
public VariableInfo[] getVariableInfo(TagData data) {
VariableInfo[] result = null;
TagExtraInfo tei = getTagExtraInfo();
if (tei != null) {
- result = tei.getVariableInfo( data );
+ result = tei.getVariableInfo(data);
}
return result;
}
/**
- * Translation-time validation of the attributes.
- * This is a convenience method on the associated TagExtraInfo class.
+ * Translation-time validation of the attributes. This is a convenience method on the associated TagExtraInfo class.
*
* @param data The translation-time TagData instance.
+ *
* @return Whether the data is valid.
*/
public boolean isValid(TagData data) {
@@ -262,20 +218,20 @@ public class TagInfo {
}
/**
- * Translation-time validation of the attributes.
- * This is a convenience method on the associated TagExtraInfo class.
+ * Translation-time validation of the attributes. This is a convenience method on the associated TagExtraInfo class.
*
* @param data The translation-time TagData instance.
- * @return A null object, or zero length array if no errors, an
- * array of ValidationMessages otherwise.
+ *
+ * @return A null object, or zero length array if no errors, an array of ValidationMessages otherwise.
+ *
* @since JSP 2.0
*/
- public ValidationMessage[] validate( TagData data ) {
+ public ValidationMessage[] validate(TagData data) {
TagExtraInfo tei = getTagExtraInfo();
- if( tei == null ) {
+ if (tei == null) {
return null;
}
- return tei.validate( data );
+ return tei.validate(data);
}
/**
@@ -310,9 +266,8 @@ public class TagInfo {
/**
- * The bodycontent information for this tag.
- * If the bodycontent is not defined for this
- * tag, the default of JSP will be returned.
+ * The bodycontent information for this tag. If the bodycontent is not defined for this tag, the default of JSP will
+ * be returned.
*
* @return the body content string.
*/
@@ -325,8 +280,7 @@ public class TagInfo {
/**
* The information string for the tag.
*
- * @return the info string, or null if
- * not defined
+ * @return the info string, or null if not defined
*/
public String getInfoString() {
@@ -335,16 +289,10 @@ public class TagInfo {
/**
- * Set the TagLibraryInfo property.
- *
- * Note that a TagLibraryInfo element is dependent
- * not just on the TLD information but also on the
- * specific taglib instance used. This means that
- * a fair amount of work needs to be done to construct
- * and initialize TagLib objects.
- *
- * If used carefully, this setter can be used to avoid having to
- * create new TagInfo elements for each taglib directive.
+ * Set the TagLibraryInfo property. Note that a TagLibraryInfo element is dependent not just on the TLD information
+ * but also on the specific taglib instance used. This means that a fair amount of work needs to be done to
+ * construct and initialize TagLib objects. If used carefully, this setter can be used to avoid having to create new
+ * TagInfo elements for each taglib directive.
*
* @param tl the TagLibraryInfo to assign
*/
@@ -370,8 +318,7 @@ public class TagInfo {
/**
* Get the displayName.
*
- * @return A short name to be displayed by tools,
- * or null if not defined
+ * @return A short name to be displayed by tools, or null if not defined
*/
public String getDisplayName() {
@@ -381,8 +328,7 @@ public class TagInfo {
/**
* Get the path to the small icon.
*
- * @return Path to a small icon to be displayed by tools,
- * or null if not defined
+ * @return Path to a small icon to be displayed by tools, or null if not defined
*/
public String getSmallIcon() {
@@ -392,8 +338,7 @@ public class TagInfo {
/**
* Get the path to the large icon.
*
- * @return Path to a large icon to be displayed by tools,
- * or null if not defined
+ * @return Path to a large icon to be displayed by tools, or null if not defined
*/
public String getLargeIcon() {
@@ -403,9 +348,8 @@ public class TagInfo {
/**
* Get TagVariableInfo objects associated with this TagInfo.
*
- * @return Array of TagVariableInfo objects corresponding to
- * variables declared by this tag, or a zero length
- * array if no variables have been declared
+ * @return Array of TagVariableInfo objects corresponding to variables declared by this tag, or a zero length array
+ * if no variables have been declared
*/
public TagVariableInfo[] getTagVariableInfos() {
@@ -419,6 +363,7 @@ public class TagInfo {
* Get dynamicAttributes associated with this TagInfo.
*
* @return True if tag handler supports dynamic attributes
+ *
* @since JSP 2.0
*/
public boolean hasDynamicAttributes() {
@@ -428,21 +373,21 @@ public class TagInfo {
/*
* private fields for 1.1 info
*/
- private final String tagName; // the name of the tag
- private final String tagClassName;
- private final String bodyContent;
- private final String infoString;
- private TagLibraryInfo tagLibrary;
- private TagExtraInfo tagExtraInfo; // instance of TagExtraInfo
+ private final String tagName; // the name of the tag
+ private final String tagClassName;
+ private final String bodyContent;
+ private final String infoString;
+ private TagLibraryInfo tagLibrary;
+ private TagExtraInfo tagExtraInfo; // instance of TagExtraInfo
private final TagAttributeInfo[] attributeInfo;
/*
* private fields for 1.2 info
*/
- private final String displayName;
- private final String smallIcon;
- private final String largeIcon;
- private final TagVariableInfo[] tagVariableInfo;
+ private final String displayName;
+ private final String smallIcon;
+ private final String largeIcon;
+ private final TagVariableInfo[] tagVariableInfo;
/*
* Additional private fields for 2.0 info
diff --git a/java/javax/servlet/jsp/tagext/TagLibraryInfo.java b/java/javax/servlet/jsp/tagext/TagLibraryInfo.java
index ef626374c0..d3274c011e 100644
--- a/java/javax/servlet/jsp/tagext/TagLibraryInfo.java
+++ b/java/javax/servlet/jsp/tagext/TagLibraryInfo.java
@@ -18,20 +18,16 @@ package javax.servlet.jsp.tagext;
/**
- * Translation-time information associated with a taglib directive, and its
- * underlying TLD file. Most of the information is directly from the TLD, except
- * for the prefix and the uri values used in the taglib directive
+ * Translation-time information associated with a taglib directive, and its underlying TLD file. Most of the information
+ * is directly from the TLD, except for the prefix and the uri values used in the taglib directive
*/
public abstract class TagLibraryInfo {
/**
- * Constructor. This will invoke the constructors for TagInfo, and
- * TagAttributeInfo after parsing the TLD file.
+ * Constructor. This will invoke the constructors for TagInfo, and TagAttributeInfo after parsing the TLD file.
*
- * @param prefix
- * the prefix actually used by the taglib directive
- * @param uri
- * the URI actually used by the taglib directive
+ * @param prefix the prefix actually used by the taglib directive
+ * @param uri the URI actually used by the taglib directive
*/
protected TagLibraryInfo(String prefix, String uri) {
this.prefix = prefix;
@@ -41,8 +37,7 @@ public abstract class TagLibraryInfo {
// ==== methods accessing taglib information =======
/**
- * The value of the uri attribute from the taglib directive for this
- * library.
+ * The value of the uri attribute from the taglib directive for this library.
*
* @return the value of the uri attribute
*/
@@ -62,9 +57,8 @@ public abstract class TagLibraryInfo {
// ==== methods using the TLD data =======
/**
- * The preferred short name (prefix) as indicated in the TLD. This may be
- * used by authoring tools as the preferred prefix to use when creating an
- * taglib directive for this library.
+ * The preferred short name (prefix) as indicated in the TLD. This may be used by authoring tools as the preferred
+ * prefix to use when creating an taglib directive for this library.
*
* @return the preferred short name for the library
*/
@@ -73,9 +67,8 @@ public abstract class TagLibraryInfo {
}
/**
- * The "reliable" URN indicated in the TLD (the uri element). This may be
- * used by authoring tools as a global identifier to use when creating a
- * taglib directive for this library.
+ * The "reliable" URN indicated in the TLD (the uri element). This may be used by authoring tools as a global
+ * identifier to use when creating a taglib directive for this library.
*
* @return a reliable URN to a TLD like this
*/
@@ -96,6 +89,7 @@ public abstract class TagLibraryInfo {
* A string describing the required version of the JSP container.
*
* @return the (minimal) required version of the JSP container.
+ *
* @see javax.servlet.jsp.JspEngineInfo
*/
public String getRequiredVersion() {
@@ -105,9 +99,8 @@ public abstract class TagLibraryInfo {
/**
* An array describing the tags that are defined in this tag library.
*
- * @return the TagInfo objects corresponding to the tags defined by this tag
- * library, or a zero length array if this tag library defines no
- * tags
+ * @return the TagInfo objects corresponding to the tags defined by this tag library, or a zero length array if this
+ * tag library defines no tags
*/
public TagInfo[] getTags() {
return tags;
@@ -116,9 +109,9 @@ public abstract class TagLibraryInfo {
/**
* An array describing the tag files that are defined in this tag library.
*
- * @return the TagFileInfo objects corresponding to the tag files defined by
- * this tag library, or a zero length array if this tag library
- * defines no tags files
+ * @return the TagFileInfo objects corresponding to the tag files defined by this tag library, or a zero length
+ * array if this tag library defines no tags files
+ *
* @since JSP 2.0
*/
public TagFileInfo[] getTagFiles() {
@@ -126,13 +119,11 @@ public abstract class TagLibraryInfo {
}
/**
- * Get the TagInfo for a given tag name, looking through all the tags in
- * this tag library.
+ * Get the TagInfo for a given tag name, looking through all the tags in this tag library.
+ *
+ * @param shortname The short name (no prefix) of the tag
*
- * @param shortname
- * The short name (no prefix) of the tag
- * @return the TagInfo for the tag with the specified short name, or null if
- * no such tag is found
+ * @return the TagInfo for the tag with the specified short name, or null if no such tag is found
*/
public TagInfo getTag(String shortname) {
TagInfo tags[] = getTags();
@@ -150,13 +141,12 @@ public abstract class TagLibraryInfo {
}
/**
- * Get the TagFileInfo for a given tag name, looking through all the tag
- * files in this tag library.
+ * Get the TagFileInfo for a given tag name, looking through all the tag files in this tag library.
+ *
+ * @param shortname The short name (no prefix) of the tag
+ *
+ * @return the TagFileInfo for the specified Tag file, or null if no Tag file is found
*
- * @param shortname
- * The short name (no prefix) of the tag
- * @return the TagFileInfo for the specified Tag file, or null if no Tag
- * file is found
* @since JSP 2.0
*/
public TagFileInfo getTagFile(String shortname) {
@@ -177,8 +167,9 @@ public abstract class TagLibraryInfo {
/**
* An array describing the functions that are defined in this tag library.
*
- * @return the functions defined in this tag library, or a zero length array
- * if the tag library defines no functions.
+ * @return the functions defined in this tag library, or a zero length array if the tag library defines no
+ * functions.
+ *
* @since JSP 2.0
*/
public FunctionInfo[] getFunctions() {
@@ -186,13 +177,12 @@ public abstract class TagLibraryInfo {
}
/**
- * Get the FunctionInfo for a given function name, looking through all the
- * functions in this tag library.
+ * Get the FunctionInfo for a given function name, looking through all the functions in this tag library.
+ *
+ * @param name The name (no prefix) of the function
+ *
+ * @return the FunctionInfo for the function with the given name, or null if no such function exists
*
- * @param name
- * The name (no prefix) of the function
- * @return the FunctionInfo for the function with the given name, or null if
- * no such function exists
* @since JSP 2.0
*/
public FunctionInfo getFunction(String name) {
@@ -210,17 +200,15 @@ public abstract class TagLibraryInfo {
}
/**
- * Returns an array of TagLibraryInfo objects representing the entire set of
- * tag libraries (including this TagLibraryInfo) imported by taglib
- * directives in the translation unit that references this TagLibraryInfo.
- * If a tag library is imported more than once and bound to different
- * prefixes, only the TagLibraryInfo bound to the first prefix must be
- * included in the returned array.
+ * Returns an array of TagLibraryInfo objects representing the entire set of tag libraries (including this
+ * TagLibraryInfo) imported by taglib directives in the translation unit that references this TagLibraryInfo. If a
+ * tag library is imported more than once and bound to different prefixes, only the TagLibraryInfo bound to the
+ * first prefix must be included in the returned array.
+ *
+ * @return Array of TagLibraryInfo objects representing the entire set of tag libraries (including this
+ * TagLibraryInfo) imported by taglib directives in the translation unit that references this
+ * TagLibraryInfo.
*
- * @return Array of TagLibraryInfo objects representing the entire set of
- * tag libraries (including this TagLibraryInfo) imported by taglib
- * directives in the translation unit that references this
- * TagLibraryInfo.
* @since JSP 2.1
*/
public abstract javax.servlet.jsp.tagext.TagLibraryInfo[] getTagLibraryInfos();
@@ -233,8 +221,7 @@ public abstract class TagLibraryInfo {
protected String prefix;
/**
- * The value of the uri attribute from the taglib directive for this
- * library.
+ * The value of the uri attribute from the taglib directive for this library.
*/
protected String uri;
diff --git a/java/javax/servlet/jsp/tagext/TagLibraryValidator.java b/java/javax/servlet/jsp/tagext/TagLibraryValidator.java
index 5d57e5b888..f2cf1aed76 100644
--- a/java/javax/servlet/jsp/tagext/TagLibraryValidator.java
+++ b/java/javax/servlet/jsp/tagext/TagLibraryValidator.java
@@ -21,111 +21,79 @@ import java.util.HashMap;
import java.util.Map;
/**
- * Translation-time validator class for a JSP page.
- * A validator operates on the XML view associated with the JSP page.
- *
+ * Translation-time validator class for a JSP page. A validator operates on the XML view associated with the JSP page.
* <p>
- * The TLD file associates a TagLibraryValidator class and some init
- * arguments with a tag library.
- *
+ * The TLD file associates a TagLibraryValidator class and some init arguments with a tag library.
* <p>
- * The JSP container is responsible for locating an appropriate
- * instance of the appropriate subclass by
- *
+ * The JSP container is responsible for locating an appropriate instance of the appropriate subclass by
* <ul>
- * <li> new a fresh instance, or reuse an available one
- * <li> invoke the setInitParams(Map) method on the instance
+ * <li>new a fresh instance, or reuse an available one
+ * <li>invoke the setInitParams(Map) method on the instance
* </ul>
- *
- * once initialized, the validate(String, String, PageData) method will
- * be invoked, where the first two arguments are the prefix
- * and uri for this tag library in the XML View. The prefix is intended
- * to make it easier to produce an error message. However, it is not
- * always accurate. In the case where a single URI is mapped to more
- * than one prefix in the XML view, the prefix of the first URI is provided.
- * Therefore, to provide high quality error messages in cases where the
- * tag elements themselves are checked, the prefix parameter should be
- * ignored and the actual prefix of the element should be used instead.
- * TagLibraryValidators should always use the uri to identify elements
- * as belonging to the tag library, not the prefix.
- *
+ * once initialized, the validate(String, String, PageData) method will be invoked, where the first two arguments are
+ * the prefix and uri for this tag library in the XML View. The prefix is intended to make it easier to produce an error
+ * message. However, it is not always accurate. In the case where a single URI is mapped to more than one prefix in the
+ * XML view, the prefix of the first URI is provided. Therefore, to provide high quality error messages in cases where
+ * the tag elements themselves are checked, the prefix parameter should be ignored and the actual prefix of the element
+ * should be used instead. TagLibraryValidators should always use the uri to identify elements as belonging to the tag
+ * library, not the prefix.
* <p>
- * A TagLibraryValidator instance
- * may create auxiliary objects internally to perform
- * the validation (e.g. an XSchema validator) and may reuse it for all
- * the pages in a given translation run.
- *
+ * A TagLibraryValidator instance may create auxiliary objects internally to perform the validation (e.g. an XSchema
+ * validator) and may reuse it for all the pages in a given translation run.
* <p>
- * The JSP container is not guaranteed to serialize invocations of
- * validate() method, and TagLibraryValidators should perform any
- * synchronization they may require.
- *
+ * The JSP container is not guaranteed to serialize invocations of validate() method, and TagLibraryValidators should
+ * perform any synchronization they may require.
* <p>
- * As of JSP 2.0, a JSP container must provide a jsp:id attribute to
- * provide higher quality validation errors.
- * The container will track the JSP pages
- * as passed to the container, and will assign to each element
- * a unique "id", which is passed as the value of the jsp:id
- * attribute. Each XML element in the XML view available will
- * be extended with this attribute. The TagLibraryValidator
- * can then use the attribute in one or more ValidationMessage
- * objects. The container then, in turn, can use these
- * values to provide more precise information on the location
- * of an error.
- *
+ * As of JSP 2.0, a JSP container must provide a jsp:id attribute to provide higher quality validation errors. The
+ * container will track the JSP pages as passed to the container, and will assign to each element a unique "id", which
+ * is passed as the value of the jsp:id attribute. Each XML element in the XML view available will be extended with this
+ * attribute. The TagLibraryValidator can then use the attribute in one or more ValidationMessage objects. The container
+ * then, in turn, can use these values to provide more precise information on the location of an error.
* <p>
- * The actual prefix of the <code>id</code> attribute may or may not be
- * <code>jsp</code> but it will always map to the namespace
- * <code>http://java.sun.com/JSP/Page</code>. A TagLibraryValidator
- * implementation must rely on the uri, not the prefix, of the <code>id</code>
- * attribute.
+ * The actual prefix of the <code>id</code> attribute may or may not be <code>jsp</code> but it will always map to the
+ * namespace <code>http://java.sun.com/JSP/Page</code>. A TagLibraryValidator implementation must rely on the uri, not
+ * the prefix, of the <code>id</code> attribute.
*/
public abstract class TagLibraryValidator {
/**
- * Sole constructor. (For invocation by subclass constructors,
- * typically implicit.)
+ * Sole constructor. (For invocation by subclass constructors, typically implicit.)
*/
public TagLibraryValidator() {
// NOOP by default
}
/**
- * Set the init data in the TLD for this validator.
- * Parameter names are keys, and parameter values are the values.
+ * Set the init data in the TLD for this validator. Parameter names are keys, and parameter values are the values.
*
* @param map A Map describing the init parameters
*/
- public void setInitParameters(Map<String, Object> map) {
+ public void setInitParameters(Map<String,Object> map) {
initParameters = Collections.unmodifiableMap(new HashMap<>(map));
}
/**
- * Get the init parameters data as an immutable Map.
- * Parameter names are keys, and parameter values are the values.
+ * Get the init parameters data as an immutable Map. Parameter names are keys, and parameter values are the values.
*
* @return The init parameters as an immutable map.
*/
- public Map<String, Object> getInitParameters() {
+ public Map<String,Object> getInitParameters() {
return initParameters;
}
/**
- * Validate a JSP page.
- * This will get invoked once per unique tag library URI in the
- * XML view. This method will return null if the page is valid; otherwise
- * the method should return an array of ValidationMessage objects.
- * An array of length zero is also interpreted as no errors.
+ * Validate a JSP page. This will get invoked once per unique tag library URI in the XML view. This method will
+ * return null if the page is valid; otherwise the method should return an array of ValidationMessage objects. An
+ * array of length zero is also interpreted as no errors.
+ *
+ * @param prefix the first prefix with which the tag library is associated, in the XML view. Note that some tags may
+ * use a different prefix if the namespace is redefined.
+ * @param uri the tag library's unique identifier
+ * @param page the JspData page object
*
- * @param prefix the first prefix with which the tag library is
- * associated, in the XML view. Note that some tags may use
- * a different prefix if the namespace is redefined.
- * @param uri the tag library's unique identifier
- * @param page the JspData page object
- * @return A null object, or zero length array if no errors, an array
- * of ValidationMessages otherwise.
+ * @return A null object, or zero length array if no errors, an array of ValidationMessages otherwise.
*/
public ValidationMessage[] validate(String prefix, String uri, PageData page) {
return null;
@@ -139,6 +107,6 @@ public abstract class TagLibraryValidator {
}
// Private data
- private Map<String, Object> initParameters;
+ private Map<String,Object> initParameters;
}
diff --git a/java/javax/servlet/jsp/tagext/TagSupport.java b/java/javax/servlet/jsp/tagext/TagSupport.java
index d28165bbd2..62eebb8b12 100644
--- a/java/javax/servlet/jsp/tagext/TagSupport.java
+++ b/java/javax/servlet/jsp/tagext/TagSupport.java
@@ -27,58 +27,41 @@ import javax.servlet.jsp.PageContext;
/**
* A base class for defining new tag handlers implementing Tag.
- *
- * <p> The TagSupport class is a utility class intended to be used as
- * the base class for new tag handlers. The TagSupport class
- * implements the Tag and IterationTag interfaces and adds additional
- * convenience methods including getter methods for the properties in
- * Tag. TagSupport has one static method that is included to
- * facilitate coordination among cooperating tags.
- *
- * <p> Many tag handlers will extend TagSupport and only redefine a
- * few methods.
+ * <p>
+ * The TagSupport class is a utility class intended to be used as the base class for new tag handlers. The TagSupport
+ * class implements the Tag and IterationTag interfaces and adds additional convenience methods including getter methods
+ * for the properties in Tag. TagSupport has one static method that is included to facilitate coordination among
+ * cooperating tags.
+ * <p>
+ * Many tag handlers will extend TagSupport and only redefine a few methods.
*/
public class TagSupport implements IterationTag, Serializable {
private static final long serialVersionUID = 1L;
/**
- * Find the instance of a given class type that is closest to a given
- * instance.
- * This method uses the getParent method from the Tag
- * interface.
- * This method is used for coordination among cooperating tags.
- *
+ * Find the instance of a given class type that is closest to a given instance. This method uses the getParent
+ * method from the Tag interface. This method is used for coordination among cooperating tags.
* <p>
- * The current version of the specification only provides one formal
- * way of indicating the observable type of a tag handler: its
- * tag handler implementation class, described in the tag-class
- * subelement of the tag element. This is extended in an
- * informal manner by allowing the tag library author to
- * indicate in the description subelement an observable type.
- * The type should be a subtype of the tag handler implementation
- * class or void.
- * This additional constraint can be exploited by a
- * specialized container that knows about that specific tag library,
- * as in the case of the JSP standard tag library.
- *
+ * The current version of the specification only provides one formal way of indicating the observable type of a tag
+ * handler: its tag handler implementation class, described in the tag-class subelement of the tag element. This is
+ * extended in an informal manner by allowing the tag library author to indicate in the description subelement an
+ * observable type. The type should be a subtype of the tag handler implementation class or void. This additional
+ * constraint can be exploited by a specialized container that knows about that specific tag library, as in the case
+ * of the JSP standard tag library.
* <p>
- * When a tag library author provides information on the
- * observable type of a tag handler, client programmatic code
- * should adhere to that constraint. Specifically, the Class
- * passed to findAncestorWithClass should be a subtype of the
- * observable type.
+ * When a tag library author provides information on the observable type of a tag handler, client programmatic code
+ * should adhere to that constraint. Specifically, the Class passed to findAncestorWithClass should be a subtype of
+ * the observable type.
*
- *
- * @param from The instance from where to start looking.
+ * @param from The instance from where to start looking.
* @param klass The subclass of Tag or interface to be matched
- * @return the nearest ancestor that implements the interface
- * or is an instance of the class specified
+ *
+ * @return the nearest ancestor that implements the interface or is an instance of the class specified
*/
public static final Tag findAncestorWithClass(Tag from,
// TCK signature test fails with generics
- @SuppressWarnings("rawtypes")
- Class klass) {
+ @SuppressWarnings("rawtypes") Class klass) {
boolean isInterface = false;
if (from == null || klass == null ||
@@ -93,8 +76,7 @@ public class TagSupport implements IterationTag, Serializable {
return null;
}
- if ((isInterface && klass.isInstance(tag)) ||
- ((Class<?>)klass).isAssignableFrom(tag.getClass())) {
+ if ((isInterface && klass.isInstance(tag)) || ((Class<?>) klass).isAssignableFrom(tag.getClass())) {
return tag;
}
from = tag;
@@ -102,12 +84,8 @@ public class TagSupport implements IterationTag, Serializable {
}
/**
- * Default constructor, all subclasses are required to define only
- * a public constructor with the same signature, and to call the
- * superclass constructor.
- *
- * This constructor is called by the code generated by the JSP
- * translator.
+ * Default constructor, all subclasses are required to define only a public constructor with the same signature, and
+ * to call the superclass constructor. This constructor is called by the code generated by the JSP translator.
*/
public TagSupport() {
// NOOP by default
@@ -117,6 +95,7 @@ public class TagSupport implements IterationTag, Serializable {
* Default processing of the start tag, returning SKIP_BODY.
*
* @return SKIP_BODY
+ *
* @throws JspException if an error occurs while processing this tag
*
* @see Tag#doStartTag()
@@ -130,6 +109,7 @@ public class TagSupport implements IterationTag, Serializable {
* Default processing of the end tag returning EVAL_PAGE.
*
* @return EVAL_PAGE
+ *
* @throws JspException if an error occurs while processing this tag
*
* @see Tag#doEndTag()
@@ -144,6 +124,7 @@ public class TagSupport implements IterationTag, Serializable {
* Default processing for a body.
*
* @return SKIP_BODY
+ *
* @throws JspException if an error occurs while processing this tag
*
* @see IterationTag#doAfterBody()
@@ -165,7 +146,7 @@ public class TagSupport implements IterationTag, Serializable {
public void release() {
parent = null;
id = null;
- if( values != null ) {
+ if (values != null) {
values.clear();
}
values = null;
@@ -175,6 +156,7 @@ public class TagSupport implements IterationTag, Serializable {
* Set the nesting tag of this tag.
*
* @param t The parent Tag.
+ *
* @see Tag#setParent(Tag)
*/
@Override
@@ -184,6 +166,7 @@ public class TagSupport implements IterationTag, Serializable {
/**
* The Tag instance most closely enclosing this tag instance.
+ *
* @see Tag#getParent()
*
* @return the parent tag instance or null
@@ -215,6 +198,7 @@ public class TagSupport implements IterationTag, Serializable {
* Set the page context.
*
* @param pageContext The PageContext.
+ *
* @see Tag#setPageContext
*/
@Override
@@ -239,6 +223,7 @@ public class TagSupport implements IterationTag, Serializable {
* Get a the value associated with a key.
*
* @param k The string key.
+ *
* @return The value associated with the key, or null.
*/
public Object getValue(String k) {
@@ -262,8 +247,8 @@ public class TagSupport implements IterationTag, Serializable {
/**
* Enumerate the keys for the values kept by this tag handler.
*
- * @return An enumeration of all the keys for the values set,
- * or null or an empty Enumeration if no values have been set.
+ * @return An enumeration of all the keys for the values set, or null or an empty Enumeration if no values have been
+ * set.
*/
public Enumeration<String> getValues() {
if (values == null) {
@@ -280,7 +265,7 @@ public class TagSupport implements IterationTag, Serializable {
/**
* Map of object values keyed by Strings for this tag.
*/
- private Map<String, Object> values;
+ private Map<String,Object> values;
/**
* The value of the id attribute of this tag; or null.
diff --git a/java/javax/servlet/jsp/tagext/TagVariableInfo.java b/java/javax/servlet/jsp/tagext/TagVariableInfo.java
index 70ac7bf387..06d77531d0 100644
--- a/java/javax/servlet/jsp/tagext/TagVariableInfo.java
+++ b/java/javax/servlet/jsp/tagext/TagVariableInfo.java
@@ -17,29 +17,22 @@
package javax.servlet.jsp.tagext;
/**
- * Variable information for a tag in a Tag Library; This class is instantiated
- * from the Tag Library Descriptor file (TLD) and is available only at
- * translation time. This object should be immutable. This information is only
- * available in JSP 1.2 format TLDs or above.
+ * Variable information for a tag in a Tag Library; This class is instantiated from the Tag Library Descriptor file
+ * (TLD) and is available only at translation time. This object should be immutable. This information is only available
+ * in JSP 1.2 format TLDs or above.
*/
public class TagVariableInfo {
/**
* Constructor for TagVariableInfo.
*
- * @param nameGiven
- * value of <name-given>
- * @param nameFromAttribute
- * value of <name-from-attribute>
- * @param className
- * value of <variable-class>
- * @param declare
- * value of <declare>
- * @param scope
- * value of <scope>
+ * @param nameGiven value of <name-given>
+ * @param nameFromAttribute value of <name-from-attribute>
+ * @param className value of <variable-class>
+ * @param declare value of <declare>
+ * @param scope value of <scope>
*/
- public TagVariableInfo(String nameGiven, String nameFromAttribute,
- String className, boolean declare, int scope) {
+ public TagVariableInfo(String nameGiven, String nameFromAttribute, String className, boolean declare, int scope) {
this.nameGiven = nameGiven;
this.nameFromAttribute = nameFromAttribute;
this.className = className;
@@ -57,10 +50,8 @@ public class TagVariableInfo {
}
/**
- * The body of the <name-from-attribute> element. This is the name of
- * an attribute whose (translation-time) value will give the name of the
- * variable. One of <name-given> or <name-from-attribute> is
- * required.
+ * The body of the <name-from-attribute> element. This is the name of an attribute whose (translation-time)
+ * value will give the name of the variable. One of <name-given> or <name-from-attribute> is required.
*
* @return The attribute whose value defines the variable name
*/
@@ -71,8 +62,7 @@ public class TagVariableInfo {
/**
* The body of the <variable-class> element.
*
- * @return The name of the class of the variable or 'java.lang.String' if
- * not defined in the TLD.
+ * @return The name of the class of the variable or 'java.lang.String' if not defined in the TLD.
*/
public String getClassName() {
return className;
@@ -81,8 +71,7 @@ public class TagVariableInfo {
/**
* The body of the <declare> element.
*
- * @return Whether the variable is to be declared or not. If not defined in
- * the TLD, 'true' will be returned.
+ * @return Whether the variable is to be declared or not. If not defined in the TLD, 'true' will be returned.
*/
public boolean getDeclare() {
return declare;
@@ -91,8 +80,7 @@ public class TagVariableInfo {
/**
* The body of the <scope> element.
*
- * @return The scope to give the variable. NESTED scope will be returned if
- * not defined in the TLD.
+ * @return The scope to give the variable. NESTED scope will be returned if not defined in the TLD.
*/
public int getScope() {
return scope;
diff --git a/java/javax/servlet/jsp/tagext/TryCatchFinally.java b/java/javax/servlet/jsp/tagext/TryCatchFinally.java
index d324b89b7f..16f299e485 100644
--- a/java/javax/servlet/jsp/tagext/TryCatchFinally.java
+++ b/java/javax/servlet/jsp/tagext/TryCatchFinally.java
@@ -17,13 +17,12 @@
package javax.servlet.jsp.tagext;
-
/**
- * The auxiliary interface of a Tag, IterationTag or BodyTag tag
- * handler that wants additional hooks for managing resources.
- *
- * <p>This interface provides two new methods: doCatch(Throwable)
- * and doFinally(). The prototypical invocation is as follows:
+ * The auxiliary interface of a Tag, IterationTag or BodyTag tag handler that wants additional hooks for managing
+ * resources.
+ * <p>
+ * This interface provides two new methods: doCatch(Throwable) and doFinally(). The prototypical invocation is as
+ * follows:
*
* <pre>
* h = get a Tag(); // get a tag handler, perhaps from pool
@@ -54,43 +53,33 @@ package javax.servlet.jsp.tagext;
public interface TryCatchFinally {
/**
- * Invoked if a Throwable occurs while evaluating the BODY
- * inside a tag or in any of the following methods:
- * Tag.doStartTag(), Tag.doEndTag(),
- * IterationTag.doAfterBody() and BodyTag.doInitBody().
- *
- * <p>This method is not invoked if the Throwable occurs during
- * one of the setter methods.
- *
- * <p>This method may throw an exception (the same or a new one)
- * that will be propagated further up the nest chain. If an exception
- * is thrown, doFinally() will be invoked.
- *
- * <p>This method is intended to be used to respond to an exceptional
- * condition.
+ * Invoked if a Throwable occurs while evaluating the BODY inside a tag or in any of the following methods:
+ * Tag.doStartTag(), Tag.doEndTag(), IterationTag.doAfterBody() and BodyTag.doInitBody().
+ * <p>
+ * This method is not invoked if the Throwable occurs during one of the setter methods.
+ * <p>
+ * This method may throw an exception (the same or a new one) that will be propagated further up the nest chain. If
+ * an exception is thrown, doFinally() will be invoked.
+ * <p>
+ * This method is intended to be used to respond to an exceptional condition.
*
* @param t The throwable exception navigating through this tag.
- * @throws Throwable if the exception is to be rethrown further up
- * the nest chain.
+ *
+ * @throws Throwable if the exception is to be rethrown further up the nest chain.
*/
void doCatch(Throwable t) throws Throwable;
/**
- * Invoked in all cases after doEndTag() for any class implementing
- * Tag, IterationTag or BodyTag. This method is invoked even if
- * an exception has occurred in the BODY of the tag,
- * or in any of the following methods:
- * Tag.doStartTag(), Tag.doEndTag(),
- * IterationTag.doAfterBody() and BodyTag.doInitBody().
- *
- * <p>This method is not invoked if the Throwable occurs during
- * one of the setter methods.
- *
- * <p>This method should not throw an Exception.
- *
- * <p>This method is intended to maintain per-invocation data
- * integrity and resource management actions.
+ * Invoked in all cases after doEndTag() for any class implementing Tag, IterationTag or BodyTag. This method is
+ * invoked even if an exception has occurred in the BODY of the tag, or in any of the following methods:
+ * Tag.doStartTag(), Tag.doEndTag(), IterationTag.doAfterBody() and BodyTag.doInitBody().
+ * <p>
+ * This method is not invoked if the Throwable occurs during one of the setter methods.
+ * <p>
+ * This method should not throw an Exception.
+ * <p>
+ * This method is intended to maintain per-invocation data integrity and resource management actions.
*/
void doFinally();
diff --git a/java/javax/servlet/jsp/tagext/ValidationMessage.java b/java/javax/servlet/jsp/tagext/ValidationMessage.java
index 4c0b34c98b..bf273f4079 100644
--- a/java/javax/servlet/jsp/tagext/ValidationMessage.java
+++ b/java/javax/servlet/jsp/tagext/ValidationMessage.java
@@ -19,34 +19,25 @@ package javax.servlet.jsp.tagext;
/**
* A validation message from either TagLibraryValidator or TagExtraInfo.
* <p>
- * As of JSP 2.0, a JSP container must support a jsp:id attribute to provide
- * higher quality validation errors. The container will track the JSP pages as
- * passed to the container, and will assign to each element a unique "id", which
- * is passed as the value of the jsp:id attribute. Each XML element in the XML
- * view available will be extended with this attribute. The TagLibraryValidator
- * can then use the attribute in one or more ValidationMessage objects. The
- * container then, in turn, can use these values to provide more precise
- * information on the location of an error.
+ * As of JSP 2.0, a JSP container must support a jsp:id attribute to provide higher quality validation errors. The
+ * container will track the JSP pages as passed to the container, and will assign to each element a unique "id", which
+ * is passed as the value of the jsp:id attribute. Each XML element in the XML view available will be extended with this
+ * attribute. The TagLibraryValidator can then use the attribute in one or more ValidationMessage objects. The container
+ * then, in turn, can use these values to provide more precise information on the location of an error.
* <p>
- * The actual prefix of the <code>id</code> attribute may or may not be
- * <code>jsp</code> but it will always map to the namespace
- * <code>http://java.sun.com/JSP/Page</code>. A TagLibraryValidator
- * implementation must rely on the uri, not the prefix, of the <code>id</code>
- * attribute.
+ * The actual prefix of the <code>id</code> attribute may or may not be <code>jsp</code> but it will always map to the
+ * namespace <code>http://java.sun.com/JSP/Page</code>. A TagLibraryValidator implementation must rely on the uri, not
+ * the prefix, of the <code>id</code> attribute.
*/
public class ValidationMessage {
/**
- * Create a ValidationMessage. The message String should be non-null. The
- * value of id may be null, if the message is not specific to any XML
- * element, or if no jsp:id attributes were passed on. If non-null, the
- * value of id must be the value of a jsp:id attribute for the PageData
- * passed into the validate() method.
+ * Create a ValidationMessage. The message String should be non-null. The value of id may be null, if the message is
+ * not specific to any XML element, or if no jsp:id attributes were passed on. If non-null, the value of id must be
+ * the value of a jsp:id attribute for the PageData passed into the validate() method.
*
- * @param id
- * Either null, or the value of a jsp:id attribute.
- * @param message
- * A localized validation message.
+ * @param id Either null, or the value of a jsp:id attribute.
+ * @param message A localized validation message.
*/
public ValidationMessage(String id, String message) {
this.id = id;
diff --git a/java/javax/servlet/jsp/tagext/VariableInfo.java b/java/javax/servlet/jsp/tagext/VariableInfo.java
index 78591f4728..655ba366e5 100644
--- a/java/javax/servlet/jsp/tagext/VariableInfo.java
+++ b/java/javax/servlet/jsp/tagext/VariableInfo.java
@@ -17,76 +17,61 @@
package javax.servlet.jsp.tagext;
/**
- * Information on the scripting variables that are created/modified by a tag (at
- * run-time). This information is provided by TagExtraInfo classes and it is
- * used by the translation phase of JSP.
+ * Information on the scripting variables that are created/modified by a tag (at run-time). This information is provided
+ * by TagExtraInfo classes and it is used by the translation phase of JSP.
* <p>
- * Scripting variables generated by a custom action have an associated scope of
- * either AT_BEGIN, NESTED, or AT_END.
+ * Scripting variables generated by a custom action have an associated scope of either AT_BEGIN, NESTED, or AT_END.
* <p>
- * The class name (VariableInfo.getClassName) in the returned objects is used to
- * determine the types of the scripting variables. Note that because scripting
- * variables are assigned their values from scoped attributes which cannot be of
- * primitive types, "boxed" types such as
- * <code>java.lang.Integer</code> must be used instead of primitives.
+ * The class name (VariableInfo.getClassName) in the returned objects is used to determine the types of the scripting
+ * variables. Note that because scripting variables are assigned their values from scoped attributes which cannot be of
+ * primitive types, "boxed" types such as <code>java.lang.Integer</code> must be used instead of primitives.
* <p>
* The class name may be a Fully Qualified Class Name, or a short class name.
* <p>
- * If a Fully Qualified Class Name is provided, it should refer to a class that
- * should be in the CLASSPATH for the Web Application (see Servlet 2.4
- * specification - essentially it is WEB-INF/lib and WEB-INF/classes). Failure
- * to be so will lead to a translation-time error.
+ * If a Fully Qualified Class Name is provided, it should refer to a class that should be in the CLASSPATH for the Web
+ * Application (see Servlet 2.4 specification - essentially it is WEB-INF/lib and WEB-INF/classes). Failure to be so
+ * will lead to a translation-time error.
* <p>
- * If a short class name is given in the VariableInfo objects, then the class
- * name must be that of a public class in the context of the import directives
- * of the page where the custom action appears. The class must also be in the
- * CLASSPATH for the Web Application (see Servlet 2.4 specification -
- * essentially it is WEB-INF/lib and WEB-INF/classes). Failure to be so will
- * lead to a translation-time error.
+ * If a short class name is given in the VariableInfo objects, then the class name must be that of a public class in the
+ * context of the import directives of the page where the custom action appears. The class must also be in the CLASSPATH
+ * for the Web Application (see Servlet 2.4 specification - essentially it is WEB-INF/lib and WEB-INF/classes). Failure
+ * to be so will lead to a translation-time error.
* <p>
* <B>Usage Comments</B>
* <p>
- * Frequently a fully qualified class name will refer to a class that is known
- * to the tag library and thus, delivered in the same JAR file as the tag
- * handlers. In most other remaining cases it will refer to a class that is in
- * the platform on which the JSP processor is built (like J2EE). Using fully
- * qualified class names in this manner makes the usage relatively resistant to
- * configuration errors.
+ * Frequently a fully qualified class name will refer to a class that is known to the tag library and thus, delivered in
+ * the same JAR file as the tag handlers. In most other remaining cases it will refer to a class that is in the platform
+ * on which the JSP processor is built (like J2EE). Using fully qualified class names in this manner makes the usage
+ * relatively resistant to configuration errors.
* <p>
- * A short name is usually generated by the tag library based on some attributes
- * passed through from the custom action user (the author), and it is thus less
- * robust: for instance a missing import directive in the referring JSP page
- * will lead to an invalid short name class and a translation error.
+ * A short name is usually generated by the tag library based on some attributes passed through from the custom action
+ * user (the author), and it is thus less robust: for instance a missing import directive in the referring JSP page will
+ * lead to an invalid short name class and a translation error.
* <p>
* <B>Synchronization Protocol</B>
* <p>
- * The result of the invocation on getVariableInfo is an array of VariableInfo
- * objects. Each such object describes a scripting variable by providing its
- * name, its type, whether the variable is new or not, and what its scope is.
- * Scope is best described through a picture:
+ * The result of the invocation on getVariableInfo is an array of VariableInfo objects. Each such object describes a
+ * scripting variable by providing its name, its type, whether the variable is new or not, and what its scope is. Scope
+ * is best described through a picture:
* <p>
- * <IMG src="doc-files/VariableInfo-1.gif"
- * alt="NESTED, AT_BEGIN and AT_END Variable Scopes">
+ * <IMG src="doc-files/VariableInfo-1.gif" alt="NESTED, AT_BEGIN and AT_END Variable Scopes">
* <p>
* The JSP 2.0 specification defines the interpretation of 3 values:
* <ul>
- * <li>NESTED, if the scripting variable is available between the start tag and
- * the end tag of the action that defines it.
- * <li>AT_BEGIN, if the scripting variable is available from the start tag of
- * the action that defines it until the end of the scope.
- * <li>AT_END, if the scripting variable is available after the end tag of the
- * action that defines it until the end of the scope.
+ * <li>NESTED, if the scripting variable is available between the start tag and the end tag of the action that defines
+ * it.
+ * <li>AT_BEGIN, if the scripting variable is available from the start tag of the action that defines it until the end
+ * of the scope.
+ * <li>AT_END, if the scripting variable is available after the end tag of the action that defines it until the end of
+ * the scope.
* </ul>
- * The scope value for a variable implies what methods may affect its value and
- * thus where synchronization is needed as illustrated by the table below.
- * <b>Note:</b> the synchronization of the variable(s) will occur <em>after</em>
- * the respective method has been called. <blockquote>
+ * The scope value for a variable implies what methods may affect its value and thus where synchronization is needed as
+ * illustrated by the table below. <b>Note:</b> the synchronization of the variable(s) will occur <em>after</em> the
+ * respective method has been called. <blockquote>
* <table style="background-color:#999999">
- * <caption>Variable Synchronization Points</caption>
- * <tbody>
+ * <caption>Variable Synchronization Points</caption> <tbody>
* <tr>
- * <td colspan="6" style="background-color:#999999">
- * <u><b>Variable Synchronization Points</b></u><br>
+ * <td colspan="6" style="background-color:#999999"><u><b>Variable Synchronization Points</b></u><br>
* </td>
* </tr>
* <tr>
@@ -128,11 +113,9 @@ package javax.servlet.jsp.tagext;
* <tr>
* <td style="background-color:#c0c0c0"><b>BodyTag<br>
* </b></td>
- * <td style="background-color:#ffffff">AT_BEGIN,
- * NESTED<sup>1</sup><br>
+ * <td style="background-color:#ffffff">AT_BEGIN, NESTED<sup>1</sup><br>
* </td>
- * <td style="background-color:#ffffff">AT_BEGIN,
- * NESTED<sup>1</sup><br>
+ * <td style="background-color:#ffffff">AT_BEGIN, NESTED<sup>1</sup><br>
* </td>
* <td style="background-color:#ffffff">AT_BEGIN, NESTED<br>
* </td>
@@ -157,21 +140,18 @@ package javax.servlet.jsp.tagext;
* </tr>
* </tbody>
* </table>
- * <sup>1</sup> Called after <code>doStartTag()</code> if
- * <code>EVAL_BODY_INCLUDE</code> is returned, or after
+ * <sup>1</sup> Called after <code>doStartTag()</code> if <code>EVAL_BODY_INCLUDE</code> is returned, or after
* <code>doInitBody()</code> otherwise. </blockquote>
* <p>
* <B>Variable Information in the TLD</B>
* <p>
- * Scripting variable information can also be encoded directly for most cases
- * into the Tag Library Descriptor using the <variable> subelement of the
- * <tag> element. See the JSP specification.
+ * Scripting variable information can also be encoded directly for most cases into the Tag Library Descriptor using the
+ * <variable> subelement of the <tag> element. See the JSP specification.
*/
public class VariableInfo {
/**
- * Scope information that scripting variable is visible only within the
- * start/end tags.
+ * Scope information that scripting variable is visible only within the start/end tags.
*/
public static final int NESTED = 0;
@@ -186,21 +166,14 @@ public class VariableInfo {
public static final int AT_END = 2;
/**
- * Constructor These objects can be created (at translation time) by the
- * TagExtraInfo instances.
+ * Constructor These objects can be created (at translation time) by the TagExtraInfo instances.
*
- * @param varName
- * The name of the scripting variable
- * @param className
- * The type of this variable
- * @param declare
- * If true, it is a new variable (in some languages this will
- * require a declaration)
- * @param scope
- * Indication on the lexical scope of the variable
+ * @param varName The name of the scripting variable
+ * @param className The type of this variable
+ * @param declare If true, it is a new variable (in some languages this will require a declaration)
+ * @param scope Indication on the lexical scope of the variable
*/
- public VariableInfo(String varName, String className, boolean declare,
- int scope) {
+ public VariableInfo(String varName, String className, boolean declare, int scope) {
this.varName = varName;
this.className = className;
this.declare = declare;
@@ -228,8 +201,7 @@ public class VariableInfo {
}
/**
- * Returns whether this is a new variable. If so, in some languages this
- * will require a declaration.
+ * Returns whether this is a new variable. If so, in some languages this will require a declaration.
*
* @return whether this is a new variable.
*/
@@ -240,8 +212,8 @@ public class VariableInfo {
/**
* Returns the lexical scope of the variable.
*
- * @return the lexical scope of the variable, either AT_BEGIN, AT_END, or
- * NESTED.
+ * @return the lexical scope of the variable, either AT_BEGIN, AT_END, or NESTED.
+ *
* @see #AT_BEGIN
* @see #AT_END
* @see #NESTED
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@tomcat.apache.org
For additional commands, e-mail: dev-help@tomcat.apache.org
[tomcat] 03/08: Code clean-up - no functional change
Posted by ma...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
markt pushed a commit to branch 9.0.x
in repository https://gitbox.apache.org/repos/asf/tomcat.git
commit 3a378cae7c574f42cf1f27cabb9edc440a6d8770
Author: Mark Thomas <ma...@apache.org>
AuthorDate: Fri Apr 14 11:36:57 2023 +0100
Code clean-up - no functional change
---
java/javax/websocket/ClientEndpoint.java | 6 +-
java/javax/websocket/ClientEndpointConfig.java | 34 ++--
java/javax/websocket/CloseReason.java | 6 +-
java/javax/websocket/ContainerProvider.java | 17 +-
java/javax/websocket/DecodeException.java | 3 +-
.../websocket/DefaultClientEndpointConfig.java | 8 +-
java/javax/websocket/Encoder.java | 6 +-
java/javax/websocket/Endpoint.java | 9 +-
java/javax/websocket/EndpointConfig.java | 2 +-
java/javax/websocket/Extension.java | 2 +
java/javax/websocket/HandshakeResponse.java | 2 +-
java/javax/websocket/MessageHandler.java | 7 +-
java/javax/websocket/PongMessage.java | 6 +-
java/javax/websocket/RemoteEndpoint.java | 186 ++++++++++-----------
java/javax/websocket/SendResult.java | 2 +-
java/javax/websocket/Session.java | 95 +++++------
java/javax/websocket/WebSocketContainer.java | 70 ++++----
.../server/DefaultServerEndpointConfig.java | 11 +-
java/javax/websocket/server/HandshakeRequest.java | 12 +-
java/javax/websocket/server/PathParam.java | 5 +-
.../websocket/server/ServerApplicationConfig.java | 27 ++-
java/javax/websocket/server/ServerEndpoint.java | 7 +-
.../websocket/server/ServerEndpointConfig.java | 72 +++-----
23 files changed, 262 insertions(+), 333 deletions(-)
diff --git a/java/javax/websocket/ClientEndpoint.java b/java/javax/websocket/ClientEndpoint.java
index 7de59fc0cb..f5cf516fa4 100644
--- a/java/javax/websocket/ClientEndpoint.java
+++ b/java/javax/websocket/ClientEndpoint.java
@@ -27,8 +27,10 @@ import javax.websocket.ClientEndpointConfig.Configurator;
@Target(ElementType.TYPE)
public @interface ClientEndpoint {
String[] subprotocols() default {};
+
Class<? extends Decoder>[] decoders() default {};
+
Class<? extends Encoder>[] encoders() default {};
- Class<? extends Configurator> configurator()
- default Configurator.class;
+
+ Class<? extends Configurator> configurator() default Configurator.class;
}
diff --git a/java/javax/websocket/ClientEndpointConfig.java b/java/javax/websocket/ClientEndpointConfig.java
index 61a4b108a6..86dbeb45ed 100644
--- a/java/javax/websocket/ClientEndpointConfig.java
+++ b/java/javax/websocket/ClientEndpointConfig.java
@@ -30,8 +30,8 @@ public interface ClientEndpointConfig extends EndpointConfig {
final class Builder {
- private static final Configurator DEFAULT_CONFIGURATOR =
- new Configurator() {};
+ private static final Configurator DEFAULT_CONFIGURATOR = new Configurator() {
+ };
public static Builder create() {
@@ -46,15 +46,12 @@ public interface ClientEndpointConfig extends EndpointConfig {
private Configurator configurator = DEFAULT_CONFIGURATOR;
private List<String> preferredSubprotocols = Collections.emptyList();
private List<Extension> extensions = Collections.emptyList();
- private List<Class<? extends Encoder>> encoders =
- Collections.emptyList();
- private List<Class<? extends Decoder>> decoders =
- Collections.emptyList();
+ private List<Class<? extends Encoder>> encoders = Collections.emptyList();
+ private List<Class<? extends Decoder>> decoders = Collections.emptyList();
public ClientEndpointConfig build() {
- return new DefaultClientEndpointConfig(preferredSubprotocols,
- extensions, encoders, decoders, configurator);
+ return new DefaultClientEndpointConfig(preferredSubprotocols, extensions, encoders, decoders, configurator);
}
@@ -68,21 +65,17 @@ public interface ClientEndpointConfig extends EndpointConfig {
}
- public Builder preferredSubprotocols(
- List<String> preferredSubprotocols) {
- if (preferredSubprotocols == null ||
- preferredSubprotocols.size() == 0) {
+ public Builder preferredSubprotocols(List<String> preferredSubprotocols) {
+ if (preferredSubprotocols == null || preferredSubprotocols.size() == 0) {
this.preferredSubprotocols = Collections.emptyList();
} else {
- this.preferredSubprotocols =
- Collections.unmodifiableList(preferredSubprotocols);
+ this.preferredSubprotocols = Collections.unmodifiableList(preferredSubprotocols);
}
return this;
}
- public Builder extensions(
- List<Extension> extensions) {
+ public Builder extensions(List<Extension> extensions) {
if (extensions == null || extensions.size() == 0) {
this.extensions = Collections.emptyList();
} else {
@@ -116,18 +109,17 @@ public interface ClientEndpointConfig extends EndpointConfig {
class Configurator {
/**
- * Provides the client with a mechanism to inspect and/or modify the headers
- * that are sent to the server to start the WebSocket handshake.
+ * Provides the client with a mechanism to inspect and/or modify the headers that are sent to the server to
+ * start the WebSocket handshake.
*
- * @param headers The HTTP headers
+ * @param headers The HTTP headers
*/
public void beforeRequest(Map<String, List<String>> headers) {
// NO-OP
}
/**
- * Provides the client with a mechanism to inspect the handshake response
- * that is returned from the server.
+ * Provides the client with a mechanism to inspect the handshake response that is returned from the server.
*
* @param handshakeResponse The response
*/
diff --git a/java/javax/websocket/CloseReason.java b/java/javax/websocket/CloseReason.java
index ef88d135d8..ecbf319c2d 100644
--- a/java/javax/websocket/CloseReason.java
+++ b/java/javax/websocket/CloseReason.java
@@ -36,8 +36,7 @@ public class CloseReason {
@Override
public String toString() {
- return "CloseReason: code [" + closeCode.getCode() +
- "], reason [" + reasonPhrase + "]";
+ return "CloseReason: code [" + closeCode.getCode() + "], reason [" + reasonPhrase + "]";
}
public interface CloseCode {
@@ -109,8 +108,7 @@ public class CloseReason {
case 1015:
return CloseCodes.TLS_HANDSHAKE_FAILURE;
default:
- throw new IllegalArgumentException(
- "Invalid close code: [" + code + "]");
+ throw new IllegalArgumentException("Invalid close code: [" + code + "]");
}
}
diff --git a/java/javax/websocket/ContainerProvider.java b/java/javax/websocket/ContainerProvider.java
index f95c9ade16..77623567ed 100644
--- a/java/javax/websocket/ContainerProvider.java
+++ b/java/javax/websocket/ContainerProvider.java
@@ -20,13 +20,11 @@ import java.util.Iterator;
import java.util.ServiceLoader;
/**
- * Use the {@link ServiceLoader} mechanism to provide instances of the WebSocket
- * client container.
+ * Use the {@link ServiceLoader} mechanism to provide instances of the WebSocket client container.
*/
public abstract class ContainerProvider {
- private static final String DEFAULT_PROVIDER_CLASS_NAME =
- "org.apache.tomcat.websocket.WsWebSocketContainer";
+ private static final String DEFAULT_PROVIDER_CLASS_NAME = "org.apache.tomcat.websocket.WsWebSocketContainer";
/**
* Create a new container used to create outgoing WebSocket connections.
@@ -36,8 +34,7 @@ public abstract class ContainerProvider {
public static WebSocketContainer getWebSocketContainer() {
WebSocketContainer result = null;
- ServiceLoader<ContainerProvider> serviceLoader =
- ServiceLoader.load(ContainerProvider.class);
+ ServiceLoader<ContainerProvider> serviceLoader = ServiceLoader.load(ContainerProvider.class);
Iterator<ContainerProvider> iter = serviceLoader.iterator();
while (result == null && iter.hasNext()) {
result = iter.next().getContainer();
@@ -47,12 +44,10 @@ public abstract class ContainerProvider {
if (result == null) {
try {
@SuppressWarnings("unchecked")
- Class<WebSocketContainer> clazz =
- (Class<WebSocketContainer>) Class.forName(
- DEFAULT_PROVIDER_CLASS_NAME);
+ Class<WebSocketContainer> clazz = (Class<WebSocketContainer>) Class
+ .forName(DEFAULT_PROVIDER_CLASS_NAME);
result = clazz.getConstructor().newInstance();
- } catch (ReflectiveOperationException | IllegalArgumentException |
- SecurityException e) {
+ } catch (ReflectiveOperationException | IllegalArgumentException | SecurityException e) {
// No options left. Just return null.
}
}
diff --git a/java/javax/websocket/DecodeException.java b/java/javax/websocket/DecodeException.java
index 771cfa5803..aae81204e8 100644
--- a/java/javax/websocket/DecodeException.java
+++ b/java/javax/websocket/DecodeException.java
@@ -30,8 +30,7 @@ public class DecodeException extends Exception {
this.bb = bb;
}
- public DecodeException(String encodedString, String message,
- Throwable cause) {
+ public DecodeException(String encodedString, String message, Throwable cause) {
super(message, cause);
this.encodedString = encodedString;
}
diff --git a/java/javax/websocket/DefaultClientEndpointConfig.java b/java/javax/websocket/DefaultClientEndpointConfig.java
index 27905a9111..306b075472 100644
--- a/java/javax/websocket/DefaultClientEndpointConfig.java
+++ b/java/javax/websocket/DefaultClientEndpointConfig.java
@@ -26,14 +26,12 @@ final class DefaultClientEndpointConfig implements ClientEndpointConfig {
private final List<Extension> extensions;
private final List<Class<? extends Encoder>> encoders;
private final List<Class<? extends Decoder>> decoders;
- private final Map<String,Object> userProperties = new ConcurrentHashMap<>();
+ private final Map<String, Object> userProperties = new ConcurrentHashMap<>();
private final Configurator configurator;
- DefaultClientEndpointConfig(List<String> preferredSubprotocols,
- List<Extension> extensions,
- List<Class<? extends Encoder>> encoders,
- List<Class<? extends Decoder>> decoders,
+ DefaultClientEndpointConfig(List<String> preferredSubprotocols, List<Extension> extensions,
+ List<Class<? extends Encoder>> encoders, List<Class<? extends Decoder>> decoders,
Configurator configurator) {
this.preferredSubprotocols = preferredSubprotocols;
this.extensions = extensions;
diff --git a/java/javax/websocket/Encoder.java b/java/javax/websocket/Encoder.java
index 9a03589966..22a225b628 100644
--- a/java/javax/websocket/Encoder.java
+++ b/java/javax/websocket/Encoder.java
@@ -42,8 +42,7 @@ public interface Encoder {
interface TextStream<T> extends Encoder {
- void encode(T object, Writer writer)
- throws EncodeException, IOException;
+ void encode(T object, Writer writer) throws EncodeException, IOException;
}
interface Binary<T> extends Encoder {
@@ -53,7 +52,6 @@ public interface Encoder {
interface BinaryStream<T> extends Encoder {
- void encode(T object, OutputStream os)
- throws EncodeException, IOException;
+ void encode(T object, OutputStream os) throws EncodeException, IOException;
}
}
diff --git a/java/javax/websocket/Endpoint.java b/java/javax/websocket/Endpoint.java
index 9dfdbcce2b..a7d7fb6716 100644
--- a/java/javax/websocket/Endpoint.java
+++ b/java/javax/websocket/Endpoint.java
@@ -21,17 +21,16 @@ public abstract class Endpoint {
/**
* Event that is triggered when a new session starts.
*
- * @param session The new session.
- * @param config The configuration with which the Endpoint was
- * configured.
+ * @param session The new session.
+ * @param config The configuration with which the Endpoint was configured.
*/
public abstract void onOpen(Session session, EndpointConfig config);
/**
* Event that is triggered when a session has closed.
*
- * @param session The session
- * @param closeReason Why the session was closed
+ * @param session The session
+ * @param closeReason Why the session was closed
*/
public void onClose(Session session, CloseReason closeReason) {
// NO-OP by default
diff --git a/java/javax/websocket/EndpointConfig.java b/java/javax/websocket/EndpointConfig.java
index 0b6c96818d..7cac76e752 100644
--- a/java/javax/websocket/EndpointConfig.java
+++ b/java/javax/websocket/EndpointConfig.java
@@ -25,5 +25,5 @@ public interface EndpointConfig {
List<Class<? extends Decoder>> getDecoders();
- Map<String,Object> getUserProperties();
+ Map<String, Object> getUserProperties();
}
diff --git a/java/javax/websocket/Extension.java b/java/javax/websocket/Extension.java
index b95b27b8bd..0f2c3fa764 100644
--- a/java/javax/websocket/Extension.java
+++ b/java/javax/websocket/Extension.java
@@ -20,10 +20,12 @@ import java.util.List;
public interface Extension {
String getName();
+
List<Parameter> getParameters();
interface Parameter {
String getName();
+
String getValue();
}
}
diff --git a/java/javax/websocket/HandshakeResponse.java b/java/javax/websocket/HandshakeResponse.java
index a932192218..a25c1a2de4 100644
--- a/java/javax/websocket/HandshakeResponse.java
+++ b/java/javax/websocket/HandshakeResponse.java
@@ -26,5 +26,5 @@ public interface HandshakeResponse {
*/
String SEC_WEBSOCKET_ACCEPT = "Sec-WebSocket-Accept";
- Map<String,List<String>> getHeaders();
+ Map<String, List<String>> getHeaders();
}
diff --git a/java/javax/websocket/MessageHandler.java b/java/javax/websocket/MessageHandler.java
index 2c30d99779..9918d37370 100644
--- a/java/javax/websocket/MessageHandler.java
+++ b/java/javax/websocket/MessageHandler.java
@@ -23,9 +23,8 @@ public interface MessageHandler {
/**
* Called when part of a message is available to be processed.
*
- * @param messagePart The message part
- * @param last <code>true</code> if this is the last part of
- * this message, else <code>false</code>
+ * @param messagePart The message part
+ * @param last <code>true</code> if this is the last part of this message, else <code>false</code>
*/
void onMessage(T messagePart, boolean last);
}
@@ -35,7 +34,7 @@ public interface MessageHandler {
/**
* Called when a whole message is available to be processed.
*
- * @param message The message
+ * @param message The message
*/
void onMessage(T message);
}
diff --git a/java/javax/websocket/PongMessage.java b/java/javax/websocket/PongMessage.java
index 7e9e3b6a33..4ca68d3464 100644
--- a/java/javax/websocket/PongMessage.java
+++ b/java/javax/websocket/PongMessage.java
@@ -19,14 +19,14 @@ package javax.websocket;
import java.nio.ByteBuffer;
/**
- * Represents a WebSocket Pong message and used by message handlers to enable
- * applications to process the response to any Pings they send.
+ * Represents a WebSocket Pong message and used by message handlers to enable applications to process the response to
+ * any Pings they send.
*/
public interface PongMessage {
/**
* Get the payload of the Pong message.
*
- * @return The payload of the Pong message.
+ * @return The payload of the Pong message.
*/
ByteBuffer getApplicationData();
}
diff --git a/java/javax/websocket/RemoteEndpoint.java b/java/javax/websocket/RemoteEndpoint.java
index 19c7a10028..74ac9927c9 100644
--- a/java/javax/websocket/RemoteEndpoint.java
+++ b/java/javax/websocket/RemoteEndpoint.java
@@ -28,78 +28,82 @@ public interface RemoteEndpoint {
interface Async extends RemoteEndpoint {
/**
- * Obtain the timeout (in milliseconds) for sending a message
- * asynchronously. The default value is determined by
+ * Obtain the timeout (in milliseconds) for sending a message asynchronously. The default value is determined by
* {@link WebSocketContainer#getDefaultAsyncSendTimeout()}.
- * @return The current send timeout in milliseconds. A non-positive
- * value means an infinite timeout.
+ *
+ * @return The current send timeout in milliseconds. A non-positive value means an infinite timeout.
*/
long getSendTimeout();
/**
- * Set the timeout (in milliseconds) for sending a message
- * asynchronously. The default value is determined by
+ * Set the timeout (in milliseconds) for sending a message asynchronously. The default value is determined by
* {@link WebSocketContainer#getDefaultAsyncSendTimeout()}.
- * @param timeout The new timeout for sending messages asynchronously
- * in milliseconds. A non-positive value means an
- * infinite timeout.
+ *
+ * @param timeout The new timeout for sending messages asynchronously in milliseconds. A non-positive value
+ * means an infinite timeout.
*/
void setSendTimeout(long timeout);
/**
- * Send the message asynchronously, using the SendHandler to signal to the
- * client when the message has been sent.
- * @param text The text message to send
- * @param completion Used to signal to the client when the message has
- * been sent
+ * Send the message asynchronously, using the SendHandler to signal to the client when the message has been
+ * sent.
+ *
+ * @param text The text message to send
+ * @param completion Used to signal to the client when the message has been sent
*/
void sendText(String text, SendHandler completion);
/**
- * Send the message asynchronously, using the Future to signal to the
- * client when the message has been sent.
- * @param text The text message to send
+ * Send the message asynchronously, using the Future to signal to the client when the message has been sent.
+ *
+ * @param text The text message to send
+ *
* @return A Future that signals when the message has been sent.
*/
Future<Void> sendText(String text);
/**
- * Send the message asynchronously, using the Future to signal to the client
- * when the message has been sent.
- * @param data The text message to send
+ * Send the message asynchronously, using the Future to signal to the client when the message has been sent.
+ *
+ * @param data The text message to send
+ *
* @return A Future that signals when the message has been sent.
+ *
* @throws IllegalArgumentException if {@code data} is {@code null}.
*/
Future<Void> sendBinary(ByteBuffer data);
/**
- * Send the message asynchronously, using the SendHandler to signal to the
- * client when the message has been sent.
- * @param data The text message to send
- * @param completion Used to signal to the client when the message has
- * been sent
- * @throws IllegalArgumentException if {@code data} or {@code completion}
- * is {@code null}.
+ * Send the message asynchronously, using the SendHandler to signal to the client when the message has been
+ * sent.
+ *
+ * @param data The text message to send
+ * @param completion Used to signal to the client when the message has been sent
+ *
+ * @throws IllegalArgumentException if {@code data} or {@code completion} is {@code null}.
*/
void sendBinary(ByteBuffer data, SendHandler completion);
/**
- * Encodes object as a message and sends it asynchronously, using the
- * Future to signal to the client when the message has been sent.
- * @param obj The object to be sent.
+ * Encodes object as a message and sends it asynchronously, using the Future to signal to the client when the
+ * message has been sent.
+ *
+ * @param obj The object to be sent.
+ *
* @return A Future that signals when the message has been sent.
+ *
* @throws IllegalArgumentException if {@code obj} is {@code null}.
*/
Future<Void> sendObject(Object obj);
/**
- * Encodes object as a message and sends it asynchronously, using the
- * SendHandler to signal to the client when the message has been sent.
- * @param obj The object to be sent.
- * @param completion Used to signal to the client when the message has
- * been sent
- * @throws IllegalArgumentException if {@code obj} or
- * {@code completion} is {@code null}.
+ * Encodes object as a message and sends it asynchronously, using the SendHandler to signal to the client when
+ * the message has been sent.
+ *
+ * @param obj The object to be sent.
+ * @param completion Used to signal to the client when the message has been sent
+ *
+ * @throws IllegalArgumentException if {@code obj} or {@code completion} is {@code null}.
*/
void sendObject(Object obj, SendHandler completion);
@@ -109,48 +113,45 @@ public interface RemoteEndpoint {
/**
* Send the message, blocking until the message is sent.
- * @param text The text message to send.
+ *
+ * @param text The text message to send.
+ *
* @throws IllegalArgumentException if {@code text} is {@code null}.
- * @throws IOException if an I/O error occurs during the sending of the
- * message.
+ * @throws IOException if an I/O error occurs during the sending of the message.
*/
void sendText(String text) throws IOException;
/**
* Send the message, blocking until the message is sent.
- * @param data The binary message to send
+ *
+ * @param data The binary message to send
+ *
* @throws IllegalArgumentException if {@code data} is {@code null}.
- * @throws IOException if an I/O error occurs during the sending of the
- * message.
+ * @throws IOException if an I/O error occurs during the sending of the message.
*/
void sendBinary(ByteBuffer data) throws IOException;
/**
- * Sends part of a text message to the remote endpoint. Once the first part
- * of a message has been sent, no other text or binary messages may be sent
- * until all remaining parts of this message have been sent.
+ * Sends part of a text message to the remote endpoint. Once the first part of a message has been sent, no other
+ * text or binary messages may be sent until all remaining parts of this message have been sent.
+ *
+ * @param fragment The partial message to send
+ * @param isLast <code>true</code> if this is the last part of the message, otherwise <code>false</code>
*
- * @param fragment The partial message to send
- * @param isLast <code>true</code> if this is the last part of the
- * message, otherwise <code>false</code>
* @throws IllegalArgumentException if {@code fragment} is {@code null}.
- * @throws IOException if an I/O error occurs during the sending of the
- * message.
+ * @throws IOException if an I/O error occurs during the sending of the message.
*/
void sendText(String fragment, boolean isLast) throws IOException;
/**
- * Sends part of a binary message to the remote endpoint. Once the first
- * part of a message has been sent, no other text or binary messages may be
- * sent until all remaining parts of this message have been sent.
- *
- * @param partialByte The partial message to send
- * @param isLast <code>true</code> if this is the last part of the
- * message, otherwise <code>false</code>
- * @throws IllegalArgumentException if {@code partialByte} is
- * {@code null}.
- * @throws IOException if an I/O error occurs during the sending of the
- * message.
+ * Sends part of a binary message to the remote endpoint. Once the first part of a message has been sent, no
+ * other text or binary messages may be sent until all remaining parts of this message have been sent.
+ *
+ * @param partialByte The partial message to send
+ * @param isLast <code>true</code> if this is the last part of the message, otherwise <code>false</code>
+ *
+ * @throws IllegalArgumentException if {@code partialByte} is {@code null}.
+ * @throws IOException if an I/O error occurs during the sending of the message.
*/
void sendBinary(ByteBuffer partialByte, boolean isLast) throws IOException;
@@ -160,70 +161,63 @@ public interface RemoteEndpoint {
/**
* Encodes object as a message and sends it to the remote endpoint.
- * @param data The object to be sent.
- * @throws EncodeException if there was a problem encoding the
- * {@code data} object as a websocket message.
+ *
+ * @param data The object to be sent.
+ *
+ * @throws EncodeException if there was a problem encoding the {@code data} object as a websocket
+ * message.
* @throws IllegalArgumentException if {@code data} is {@code null}.
- * @throws IOException if an I/O error occurs during the sending of the
- * message.
+ * @throws IOException if an I/O error occurs during the sending of the message.
*/
void sendObject(Object data) throws IOException, EncodeException;
}
+
/**
- * Enable or disable the batching of outgoing messages for this endpoint. If
- * batching is disabled when it was previously enabled then this method will
- * block until any currently batched messages have been written.
+ * Enable or disable the batching of outgoing messages for this endpoint. If batching is disabled when it was
+ * previously enabled then this method will block until any currently batched messages have been written.
+ *
+ * @param batchingAllowed New setting
*
- * @param batchingAllowed New setting
- * @throws IOException If changing the value resulted in a call to
- * {@link #flushBatch()} and that call threw an
- * {@link IOException}.
+ * @throws IOException If changing the value resulted in a call to {@link #flushBatch()} and that call threw an
+ * {@link IOException}.
*/
void setBatchingAllowed(boolean batchingAllowed) throws IOException;
/**
* Obtains the current batching status of the endpoint.
*
- * @return <code>true</code> if batching is enabled, otherwise
- * <code>false</code>.
+ * @return <code>true</code> if batching is enabled, otherwise <code>false</code>.
*/
boolean getBatchingAllowed();
/**
- * Flush any currently batched messages to the remote endpoint. This method
- * will block until the flush completes.
+ * Flush any currently batched messages to the remote endpoint. This method will block until the flush completes.
*
* @throws IOException If an I/O error occurs while flushing
*/
void flushBatch() throws IOException;
/**
- * Send a ping message blocking until the message has been sent. Note that
- * if a message is in the process of being sent asynchronously, this method
- * will block until that message and this ping has been sent.
+ * Send a ping message blocking until the message has been sent. Note that if a message is in the process of being
+ * sent asynchronously, this method will block until that message and this ping has been sent.
*
- * @param applicationData The payload for the ping message
+ * @param applicationData The payload for the ping message
*
- * @throws IOException If an I/O error occurs while sending the ping
- * @throws IllegalArgumentException if the applicationData is too large for
- * a control message (max 125 bytes)
+ * @throws IOException If an I/O error occurs while sending the ping
+ * @throws IllegalArgumentException if the applicationData is too large for a control message (max 125 bytes)
*/
- void sendPing(ByteBuffer applicationData)
- throws IOException, IllegalArgumentException;
+ void sendPing(ByteBuffer applicationData) throws IOException, IllegalArgumentException;
/**
- * Send a pong message blocking until the message has been sent. Note that
- * if a message is in the process of being sent asynchronously, this method
- * will block until that message and this pong has been sent.
+ * Send a pong message blocking until the message has been sent. Note that if a message is in the process of being
+ * sent asynchronously, this method will block until that message and this pong has been sent.
*
- * @param applicationData The payload for the pong message
+ * @param applicationData The payload for the pong message
*
- * @throws IOException If an I/O error occurs while sending the pong
- * @throws IllegalArgumentException if the applicationData is too large for
- * a control message (max 125 bytes)
+ * @throws IOException If an I/O error occurs while sending the pong
+ * @throws IllegalArgumentException if the applicationData is too large for a control message (max 125 bytes)
*/
- void sendPong(ByteBuffer applicationData)
- throws IOException, IllegalArgumentException;
+ void sendPong(ByteBuffer applicationData) throws IOException, IllegalArgumentException;
}
diff --git a/java/javax/websocket/SendResult.java b/java/javax/websocket/SendResult.java
index a3797d5bb4..6bdf3659e7 100644
--- a/java/javax/websocket/SendResult.java
+++ b/java/javax/websocket/SendResult.java
@@ -26,7 +26,7 @@ public final class SendResult {
}
public SendResult() {
- this (null);
+ this(null);
}
public Throwable getException() {
diff --git a/java/javax/websocket/Session.java b/java/javax/websocket/Session.java
index eea15e5be8..539fe7babc 100644
--- a/java/javax/websocket/Session.java
+++ b/java/javax/websocket/Session.java
@@ -28,24 +28,21 @@ public interface Session extends Closeable {
/**
* Get the container that created this session.
+ *
* @return the container that created this session.
*/
WebSocketContainer getContainer();
/**
- * Registers a {@link MessageHandler} for incoming messages. Only one
- * {@link MessageHandler} may be registered for each message type (text,
- * binary, pong). The message type will be derived at runtime from the
- * provided {@link MessageHandler} instance. It is not always possible to do
- * this so it is better to use
- * {@link #addMessageHandler(Class, javax.websocket.MessageHandler.Partial)}
- * or
+ * Registers a {@link MessageHandler} for incoming messages. Only one {@link MessageHandler} may be registered for
+ * each message type (text, binary, pong). The message type will be derived at runtime from the provided
+ * {@link MessageHandler} instance. It is not always possible to do this so it is better to use
+ * {@link #addMessageHandler(Class, javax.websocket.MessageHandler.Partial)} or
* {@link #addMessageHandler(Class, javax.websocket.MessageHandler.Whole)}.
*
- * @param handler The message handler for a incoming message
+ * @param handler The message handler for a incoming message
*
- * @throws IllegalStateException If a message handler has already been
- * registered for the associated message type
+ * @throws IllegalStateException If a message handler has already been registered for the associated message type
*/
void addMessageHandler(MessageHandler handler) throws IllegalStateException;
@@ -65,38 +62,44 @@ public interface Session extends Closeable {
/**
* Get the idle timeout for this session.
- * @return The current idle timeout for this session in milliseconds. Zero
- * or negative values indicate an infinite timeout.
+ *
+ * @return The current idle timeout for this session in milliseconds. Zero or negative values indicate an infinite
+ * timeout.
*/
long getMaxIdleTimeout();
/**
* Set the idle timeout for this session.
- * @param timeout The new idle timeout for this session in milliseconds.
- * Zero or negative values indicate an infinite timeout.
+ *
+ * @param timeout The new idle timeout for this session in milliseconds. Zero or negative values indicate an
+ * infinite timeout.
*/
void setMaxIdleTimeout(long timeout);
/**
* Set the current maximum buffer size for binary messages.
+ *
* @param max The new maximum buffer size in bytes
*/
void setMaxBinaryMessageBufferSize(int max);
/**
* Get the current maximum buffer size for binary messages.
+ *
* @return The current maximum buffer size in bytes
*/
int getMaxBinaryMessageBufferSize();
/**
* Set the maximum buffer size for text messages.
+ *
* @param max The new maximum buffer size in characters.
*/
void setMaxTextMessageBufferSize(int max);
/**
* Get the maximum buffer size for text messages.
+ *
* @return The maximum buffer size in characters.
*/
int getMaxTextMessageBufferSize();
@@ -106,31 +109,29 @@ public interface Session extends Closeable {
RemoteEndpoint.Basic getBasicRemote();
/**
- * Provides a unique identifier for the session. This identifier should not
- * be relied upon to be generated from a secure random source.
+ * Provides a unique identifier for the session. This identifier should not be relied upon to be generated from a
+ * secure random source.
+ *
* @return A unique identifier for the session.
*/
String getId();
/**
* Close the connection to the remote end point using the code
- * {@link javax.websocket.CloseReason.CloseCodes#NORMAL_CLOSURE} and an
- * empty reason phrase.
+ * {@link javax.websocket.CloseReason.CloseCodes#NORMAL_CLOSURE} and an empty reason phrase.
*
- * @throws IOException if an I/O error occurs while the WebSocket session is
- * being closed.
+ * @throws IOException if an I/O error occurs while the WebSocket session is being closed.
*/
@Override
void close() throws IOException;
/**
- * Close the connection to the remote end point using the specified code
- * and reason phrase.
+ * Close the connection to the remote end point using the specified code and reason phrase.
+ *
* @param closeReason The reason the WebSocket session is being closed.
*
- * @throws IOException if an I/O error occurs while the WebSocket session is
- * being closed.
+ * @throws IOException if an I/O error occurs while the WebSocket session is being closed.
*/
void close(CloseReason closeReason) throws IOException;
@@ -140,54 +141,44 @@ public interface Session extends Closeable {
String getQueryString();
- Map<String,String> getPathParameters();
+ Map<String, String> getPathParameters();
- Map<String,Object> getUserProperties();
+ Map<String, Object> getUserProperties();
Principal getUserPrincipal();
/**
- * Obtain the set of open sessions associated with the same local endpoint
- * as this session.
+ * Obtain the set of open sessions associated with the same local endpoint as this session.
*
- * @return The set of currently open sessions for the local endpoint that
- * this session is associated with.
+ * @return The set of currently open sessions for the local endpoint that this session is associated with.
*/
Set<Session> getOpenSessions();
/**
- * Registers a {@link MessageHandler} for partial incoming messages. Only
- * one {@link MessageHandler} may be registered for each message type (text
- * or binary, pong messages are never presented as partial messages).
+ * Registers a {@link MessageHandler} for partial incoming messages. Only one {@link MessageHandler} may be
+ * registered for each message type (text or binary, pong messages are never presented as partial messages).
*
- * @param <T> The type of message that the given handler is intended
- * for
- * @param clazz The Class that implements T
- * @param handler The message handler for a incoming message
+ * @param <T> The type of message that the given handler is intended for
+ * @param clazz The Class that implements T
+ * @param handler The message handler for a incoming message
*
- * @throws IllegalStateException If a message handler has already been
- * registered for the associated message type
+ * @throws IllegalStateException If a message handler has already been registered for the associated message type
*
* @since WebSocket 1.1
*/
- <T> void addMessageHandler(Class<T> clazz, MessageHandler.Partial<T> handler)
- throws IllegalStateException;
+ <T> void addMessageHandler(Class<T> clazz, MessageHandler.Partial<T> handler) throws IllegalStateException;
/**
- * Registers a {@link MessageHandler} for whole incoming messages. Only
- * one {@link MessageHandler} may be registered for each message type (text,
- * binary, pong).
+ * Registers a {@link MessageHandler} for whole incoming messages. Only one {@link MessageHandler} may be registered
+ * for each message type (text, binary, pong).
*
- * @param <T> The type of message that the given handler is intended
- * for
- * @param clazz The Class that implements T
- * @param handler The message handler for a incoming message
+ * @param <T> The type of message that the given handler is intended for
+ * @param clazz The Class that implements T
+ * @param handler The message handler for a incoming message
*
- * @throws IllegalStateException If a message handler has already been
- * registered for the associated message type
+ * @throws IllegalStateException If a message handler has already been registered for the associated message type
*
* @since WebSocket 1.1
*/
- <T> void addMessageHandler(Class<T> clazz, MessageHandler.Whole<T> handler)
- throws IllegalStateException;
+ <T> void addMessageHandler(Class<T> clazz, MessageHandler.Whole<T> handler) throws IllegalStateException;
}
diff --git a/java/javax/websocket/WebSocketContainer.java b/java/javax/websocket/WebSocketContainer.java
index f2da3e4327..ac5b063f98 100644
--- a/java/javax/websocket/WebSocketContainer.java
+++ b/java/javax/websocket/WebSocketContainer.java
@@ -24,108 +24,100 @@ public interface WebSocketContainer {
/**
* Get the default timeout for sending a message asynchronously.
- * @return The current default timeout in milliseconds. A non-positive value
- * means an infinite timeout.
+ *
+ * @return The current default timeout in milliseconds. A non-positive value means an infinite timeout.
*/
long getDefaultAsyncSendTimeout();
/**
* Set the default timeout for sending a message asynchronously.
- * @param timeout The new default timeout in milliseconds. A non-positive
- * value means an infinite timeout.
+ *
+ * @param timeout The new default timeout in milliseconds. A non-positive value means an infinite timeout.
*/
void setAsyncSendTimeout(long timeout);
- Session connectToServer(Object endpoint, URI path)
- throws DeploymentException, IOException;
+ Session connectToServer(Object endpoint, URI path) throws DeploymentException, IOException;
- Session connectToServer(Class<?> annotatedEndpointClass, URI path)
- throws DeploymentException, IOException;
+ Session connectToServer(Class<?> annotatedEndpointClass, URI path) throws DeploymentException, IOException;
/**
* Creates a new connection to the WebSocket.
*
- * @param endpoint
- * The endpoint instance that will handle responses from the
- * server
- * @param clientEndpointConfiguration
- * Used to configure the new connection
- * @param path
- * The full URL of the WebSocket endpoint to connect to
+ * @param endpoint The endpoint instance that will handle responses from the server
+ * @param clientEndpointConfiguration Used to configure the new connection
+ * @param path The full URL of the WebSocket endpoint to connect to
*
* @return The WebSocket session for the connection
*
- * @throws DeploymentException If the connection cannot be established
- * @throws IOException If an I/O occurred while trying to establish the
- * connection
+ * @throws DeploymentException If the connection cannot be established
+ * @throws IOException If an I/O occurred while trying to establish the connection
*/
- Session connectToServer(Endpoint endpoint,
- ClientEndpointConfig clientEndpointConfiguration, URI path)
+ Session connectToServer(Endpoint endpoint, ClientEndpointConfig clientEndpointConfiguration, URI path)
throws DeploymentException, IOException;
/**
* Creates a new connection to the WebSocket.
*
- * @param endpoint
- * An instance of this class will be created to handle responses
- * from the server
- * @param clientEndpointConfiguration
- * Used to configure the new connection
- * @param path
- * The full URL of the WebSocket endpoint to connect to
+ * @param endpoint An instance of this class will be created to handle responses from the server
+ * @param clientEndpointConfiguration Used to configure the new connection
+ * @param path The full URL of the WebSocket endpoint to connect to
*
* @return The WebSocket session for the connection
*
- * @throws DeploymentException If the connection cannot be established
- * @throws IOException If an I/O occurred while trying to establish the
- * connection
+ * @throws DeploymentException If the connection cannot be established
+ * @throws IOException If an I/O occurred while trying to establish the connection
*/
- Session connectToServer(Class<? extends Endpoint> endpoint,
- ClientEndpointConfig clientEndpointConfiguration, URI path)
- throws DeploymentException, IOException;
+ Session connectToServer(Class<? extends Endpoint> endpoint, ClientEndpointConfig clientEndpointConfiguration,
+ URI path) throws DeploymentException, IOException;
/**
* Get the current default session idle timeout.
- * @return The current default session idle timeout in milliseconds. Zero or
- * negative values indicate an infinite timeout.
+ *
+ * @return The current default session idle timeout in milliseconds. Zero or negative values indicate an infinite
+ * timeout.
*/
long getDefaultMaxSessionIdleTimeout();
/**
* Set the default session idle timeout.
- * @param timeout The new default session idle timeout in milliseconds. Zero
- * or negative values indicate an infinite timeout.
+ *
+ * @param timeout The new default session idle timeout in milliseconds. Zero or negative values indicate an infinite
+ * timeout.
*/
void setDefaultMaxSessionIdleTimeout(long timeout);
/**
* Get the default maximum buffer size for binary messages.
+ *
* @return The current default maximum buffer size in bytes
*/
int getDefaultMaxBinaryMessageBufferSize();
/**
* Set the default maximum buffer size for binary messages.
+ *
* @param max The new default maximum buffer size in bytes
*/
void setDefaultMaxBinaryMessageBufferSize(int max);
/**
* Get the default maximum buffer size for text messages.
+ *
* @return The current default maximum buffer size in characters
*/
int getDefaultMaxTextMessageBufferSize();
/**
* Set the default maximum buffer size for text messages.
+ *
* @param max The new default maximum buffer size in characters
*/
void setDefaultMaxTextMessageBufferSize(int max);
/**
* Get the installed extensions.
- * @return The set of extensions that are supported by this WebSocket
- * implementation.
+ *
+ * @return The set of extensions that are supported by this WebSocket implementation.
*/
Set<Extension> getInstalledExtensions();
}
diff --git a/java/javax/websocket/server/DefaultServerEndpointConfig.java b/java/javax/websocket/server/DefaultServerEndpointConfig.java
index 422cbda422..a47d5f91aa 100644
--- a/java/javax/websocket/server/DefaultServerEndpointConfig.java
+++ b/java/javax/websocket/server/DefaultServerEndpointConfig.java
@@ -36,14 +36,11 @@ final class DefaultServerEndpointConfig implements ServerEndpointConfig {
private final List<Class<? extends Encoder>> encoders;
private final List<Class<? extends Decoder>> decoders;
private final Configurator serverEndpointConfigurator;
- private final Map<String,Object> userProperties = new ConcurrentHashMap<>();
+ private final Map<String, Object> userProperties = new ConcurrentHashMap<>();
- DefaultServerEndpointConfig(
- Class<?> endpointClass, String path,
- List<String> subprotocols, List<Extension> extensions,
- List<Class<? extends Encoder>> encoders,
- List<Class<? extends Decoder>> decoders,
- Configurator serverEndpointConfigurator) {
+ DefaultServerEndpointConfig(Class<?> endpointClass, String path, List<String> subprotocols,
+ List<Extension> extensions, List<Class<? extends Encoder>> encoders,
+ List<Class<? extends Decoder>> decoders, Configurator serverEndpointConfigurator) {
this.endpointClass = endpointClass;
this.path = path;
this.subprotocols = subprotocols;
diff --git a/java/javax/websocket/server/HandshakeRequest.java b/java/javax/websocket/server/HandshakeRequest.java
index 49acfdfd99..6477a21b06 100644
--- a/java/javax/websocket/server/HandshakeRequest.java
+++ b/java/javax/websocket/server/HandshakeRequest.java
@@ -29,9 +29,9 @@ public interface HandshakeRequest {
String SEC_WEBSOCKET_KEY = "Sec-WebSocket-Key";
String SEC_WEBSOCKET_PROTOCOL = "Sec-WebSocket-Protocol";
String SEC_WEBSOCKET_VERSION = "Sec-WebSocket-Version";
- String SEC_WEBSOCKET_EXTENSIONS= "Sec-WebSocket-Extensions";
+ String SEC_WEBSOCKET_EXTENSIONS = "Sec-WebSocket-Extensions";
- Map<String,List<String>> getHeaders();
+ Map<String, List<String>> getHeaders();
Principal getUserPrincipal();
@@ -40,10 +40,10 @@ public interface HandshakeRequest {
boolean isUserInRole(String role);
/**
- * Get the HTTP Session object associated with this request. Object is used
- * to avoid a direct dependency on the Servlet API.
- * @return The javax.servlet.http.HttpSession object associated with this
- * request, if any.
+ * Get the HTTP Session object associated with this request. Object is used to avoid a direct dependency on the
+ * Servlet API.
+ *
+ * @return The javax.servlet.http.HttpSession object associated with this request, if any.
*/
Object getHttpSession();
diff --git a/java/javax/websocket/server/PathParam.java b/java/javax/websocket/server/PathParam.java
index ff1d085ed1..df9833c8c2 100644
--- a/java/javax/websocket/server/PathParam.java
+++ b/java/javax/websocket/server/PathParam.java
@@ -22,9 +22,8 @@ import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
/**
- * Used to annotate method parameters on POJO endpoints the the {@link
- * ServerEndpoint} has been defined with a {@link ServerEndpoint#value()} that
- * uses a URI template.
+ * Used to annotate method parameters on POJO endpoints the the {@link ServerEndpoint} has been defined with a
+ * {@link ServerEndpoint#value()} that uses a URI template.
*/
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.PARAMETER)
diff --git a/java/javax/websocket/server/ServerApplicationConfig.java b/java/javax/websocket/server/ServerApplicationConfig.java
index b91f1c4397..5f2a0971da 100644
--- a/java/javax/websocket/server/ServerApplicationConfig.java
+++ b/java/javax/websocket/server/ServerApplicationConfig.java
@@ -21,31 +21,26 @@ import java.util.Set;
import javax.websocket.Endpoint;
/**
- * Applications may provide an implementation of this interface to filter the
- * discovered WebSocket endpoints that are deployed. Implementations of this
- * class will be discovered via an ServletContainerInitializer scan.
+ * Applications may provide an implementation of this interface to filter the discovered WebSocket endpoints that are
+ * deployed. Implementations of this class will be discovered via an ServletContainerInitializer scan.
*/
public interface ServerApplicationConfig {
/**
- * Enables applications to filter the discovered implementations of
- * {@link ServerEndpointConfig}.
+ * Enables applications to filter the discovered implementations of {@link ServerEndpointConfig}.
*
- * @param scanned The {@link Endpoint} implementations found in the
- * application
- * @return The set of configurations for the endpoint the application
- * wishes to deploy
+ * @param scanned The {@link Endpoint} implementations found in the application
+ *
+ * @return The set of configurations for the endpoint the application wishes to deploy
*/
- Set<ServerEndpointConfig> getEndpointConfigs(
- Set<Class<? extends Endpoint>> scanned);
+ Set<ServerEndpointConfig> getEndpointConfigs(Set<Class<? extends Endpoint>> scanned);
/**
- * Enables applications to filter the discovered classes annotated with
- * {@link ServerEndpoint}.
+ * Enables applications to filter the discovered classes annotated with {@link ServerEndpoint}.
+ *
+ * @param scanned The POJOs annotated with {@link ServerEndpoint} found in the application
*
- * @param scanned The POJOs annotated with {@link ServerEndpoint} found in
- * the application
- * @return The set of POJOs the application wishes to deploy
+ * @return The set of POJOs the application wishes to deploy
*/
Set<Class<?>> getAnnotatedEndpointClasses(Set<Class<?>> scanned);
}
diff --git a/java/javax/websocket/server/ServerEndpoint.java b/java/javax/websocket/server/ServerEndpoint.java
index d42bce9eac..66f75d6749 100644
--- a/java/javax/websocket/server/ServerEndpoint.java
+++ b/java/javax/websocket/server/ServerEndpoint.java
@@ -30,8 +30,8 @@ public @interface ServerEndpoint {
/**
* URI or URI-template that the annotated class should be mapped to.
- * @return The URI or URI-template that the annotated class should be mapped
- * to.
+ *
+ * @return The URI or URI-template that the annotated class should be mapped to.
*/
String value();
@@ -41,6 +41,5 @@ public @interface ServerEndpoint {
Class<? extends Encoder>[] encoders() default {};
- Class<? extends ServerEndpointConfig.Configurator> configurator()
- default ServerEndpointConfig.Configurator.class;
+ Class<? extends ServerEndpointConfig.Configurator> configurator() default ServerEndpointConfig.Configurator.class;
}
diff --git a/java/javax/websocket/server/ServerEndpointConfig.java b/java/javax/websocket/server/ServerEndpointConfig.java
index 92a36b4846..879c104b65 100644
--- a/java/javax/websocket/server/ServerEndpointConfig.java
+++ b/java/javax/websocket/server/ServerEndpointConfig.java
@@ -30,17 +30,17 @@ import javax.websocket.Extension;
import javax.websocket.HandshakeResponse;
/**
- * Provides configuration information for WebSocket endpoints published to a
- * server. Applications may provide their own implementation or use
- * {@link Builder}.
+ * Provides configuration information for WebSocket endpoints published to a server. Applications may provide their own
+ * implementation or use {@link Builder}.
*/
public interface ServerEndpointConfig extends EndpointConfig {
Class<?> getEndpointClass();
/**
- * Returns the path at which this WebSocket server endpoint has been
- * registered. It may be a path or a level 0 URI template.
+ * Returns the path at which this WebSocket server endpoint has been registered. It may be a path or a level 0 URI
+ * template.
+ *
* @return The registered path
*/
String getPath();
@@ -54,26 +54,21 @@ public interface ServerEndpointConfig extends EndpointConfig {
final class Builder {
- public static Builder create(
- Class<?> endpointClass, String path) {
+ public static Builder create(Class<?> endpointClass, String path) {
return new Builder(endpointClass, path);
}
private final Class<?> endpointClass;
private final String path;
- private List<Class<? extends Encoder>> encoders =
- Collections.emptyList();
- private List<Class<? extends Decoder>> decoders =
- Collections.emptyList();
+ private List<Class<? extends Encoder>> encoders = Collections.emptyList();
+ private List<Class<? extends Decoder>> decoders = Collections.emptyList();
private List<String> subprotocols = Collections.emptyList();
private List<Extension> extensions = Collections.emptyList();
- private Configurator configurator =
- Configurator.fetchContainerDefaultConfigurator();
+ private Configurator configurator = Configurator.fetchContainerDefaultConfigurator();
- private Builder(Class<?> endpointClass,
- String path) {
+ private Builder(Class<?> endpointClass, String path) {
if (endpointClass == null) {
throw new IllegalArgumentException("Endpoint class may not be null");
}
@@ -91,13 +86,12 @@ public interface ServerEndpointConfig extends EndpointConfig {
}
public ServerEndpointConfig build() {
- return new DefaultServerEndpointConfig(endpointClass, path,
- subprotocols, extensions, encoders, decoders, configurator);
+ return new DefaultServerEndpointConfig(endpointClass, path, subprotocols, extensions, encoders, decoders,
+ configurator);
}
- public Builder encoders(
- List<Class<? extends Encoder>> encoders) {
+ public Builder encoders(List<Class<? extends Encoder>> encoders) {
if (encoders == null || encoders.size() == 0) {
this.encoders = Collections.emptyList();
} else {
@@ -107,8 +101,7 @@ public interface ServerEndpointConfig extends EndpointConfig {
}
- public Builder decoders(
- List<Class<? extends Decoder>> decoders) {
+ public Builder decoders(List<Class<? extends Decoder>> decoders) {
if (decoders == null || decoders.size() == 0) {
this.decoders = Collections.emptyList();
} else {
@@ -118,8 +111,7 @@ public interface ServerEndpointConfig extends EndpointConfig {
}
- public Builder subprotocols(
- List<String> subprotocols) {
+ public Builder subprotocols(List<String> subprotocols) {
if (subprotocols == null || subprotocols.size() == 0) {
this.subprotocols = Collections.emptyList();
} else {
@@ -129,8 +121,7 @@ public interface ServerEndpointConfig extends EndpointConfig {
}
- public Builder extensions(
- List<Extension> extensions) {
+ public Builder extensions(List<Extension> extensions) {
if (extensions == null || extensions.size() == 0) {
this.extensions = Collections.emptyList();
} else {
@@ -156,8 +147,7 @@ public interface ServerEndpointConfig extends EndpointConfig {
private static volatile Configurator defaultImpl = null;
private static final Object defaultImplLock = new Object();
- private static final String DEFAULT_IMPL_CLASSNAME =
- "org.apache.tomcat.websocket.server.DefaultServerEndpointConfigurator";
+ private static final String DEFAULT_IMPL_CLASSNAME = "org.apache.tomcat.websocket.server.DefaultServerEndpointConfigurator";
static Configurator fetchContainerDefaultConfigurator() {
if (defaultImpl == null) {
@@ -166,8 +156,7 @@ public interface ServerEndpointConfig extends EndpointConfig {
if (System.getSecurityManager() == null) {
defaultImpl = loadDefault();
} else {
- defaultImpl =
- AccessController.doPrivileged(new PrivilegedLoadDefault());
+ defaultImpl = AccessController.doPrivileged(new PrivilegedLoadDefault());
}
}
}
@@ -179,8 +168,7 @@ public interface ServerEndpointConfig extends EndpointConfig {
private static Configurator loadDefault() {
Configurator result = null;
- ServiceLoader<Configurator> serviceLoader =
- ServiceLoader.load(Configurator.class);
+ ServiceLoader<Configurator> serviceLoader = ServiceLoader.load(Configurator.class);
Iterator<Configurator> iter = serviceLoader.iterator();
while (result == null && iter.hasNext()) {
@@ -191,12 +179,9 @@ public interface ServerEndpointConfig extends EndpointConfig {
if (result == null) {
try {
@SuppressWarnings("unchecked")
- Class<Configurator> clazz =
- (Class<Configurator>) Class.forName(
- DEFAULT_IMPL_CLASSNAME);
+ Class<Configurator> clazz = (Class<Configurator>) Class.forName(DEFAULT_IMPL_CLASSNAME);
result = clazz.getConstructor().newInstance();
- } catch (ReflectiveOperationException | IllegalArgumentException |
- SecurityException e) {
+ } catch (ReflectiveOperationException | IllegalArgumentException | SecurityException e) {
// No options left. Just return null.
}
}
@@ -213,13 +198,11 @@ public interface ServerEndpointConfig extends EndpointConfig {
}
- public String getNegotiatedSubprotocol(List<String> supported,
- List<String> requested) {
+ public String getNegotiatedSubprotocol(List<String> supported, List<String> requested) {
return fetchContainerDefaultConfigurator().getNegotiatedSubprotocol(supported, requested);
}
- public List<Extension> getNegotiatedExtensions(List<Extension> installed,
- List<Extension> requested) {
+ public List<Extension> getNegotiatedExtensions(List<Extension> installed, List<Extension> requested) {
return fetchContainerDefaultConfigurator().getNegotiatedExtensions(installed, requested);
}
@@ -227,15 +210,12 @@ public interface ServerEndpointConfig extends EndpointConfig {
return fetchContainerDefaultConfigurator().checkOrigin(originHeaderValue);
}
- public void modifyHandshake(ServerEndpointConfig sec,
- HandshakeRequest request, HandshakeResponse response) {
+ public void modifyHandshake(ServerEndpointConfig sec, HandshakeRequest request, HandshakeResponse response) {
fetchContainerDefaultConfigurator().modifyHandshake(sec, request, response);
}
- public <T extends Object> T getEndpointInstance(Class<T> clazz)
- throws InstantiationException {
- return fetchContainerDefaultConfigurator().getEndpointInstance(
- clazz);
+ public <T extends Object> T getEndpointInstance(Class<T> clazz) throws InstantiationException {
+ return fetchContainerDefaultConfigurator().getEndpointInstance(clazz);
}
}
}
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@tomcat.apache.org
For additional commands, e-mail: dev-help@tomcat.apache.org
[tomcat] 05/08: Code clean-up - no functional change
Posted by ma...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
markt pushed a commit to branch 9.0.x
in repository https://gitbox.apache.org/repos/asf/tomcat.git
commit 6e0aeb5b4168ae1a8c1ac37d8e724cc33fa37aae
Author: Mark Thomas <ma...@apache.org>
AuthorDate: Fri Apr 14 11:37:06 2023 +0100
Code clean-up - no functional change
---
java/javax/annotation/Generated.java | 11 ++++++-----
java/javax/annotation/PostConstruct.java | 3 +--
java/javax/annotation/PreDestroy.java | 3 +--
java/javax/annotation/Priority.java | 4 ++--
java/javax/annotation/Resource.java | 7 +++----
java/javax/annotation/security/DenyAll.java | 2 +-
java/javax/annotation/security/PermitAll.java | 2 +-
java/javax/annotation/security/RolesAllowed.java | 2 +-
8 files changed, 16 insertions(+), 18 deletions(-)
diff --git a/java/javax/annotation/Generated.java b/java/javax/annotation/Generated.java
index 922352a5b3..ba60ed77d2 100644
--- a/java/javax/annotation/Generated.java
+++ b/java/javax/annotation/Generated.java
@@ -28,20 +28,21 @@ import java.lang.annotation.Target;
* @since Common Annotations 1.0
*/
@Documented
-@Target({ElementType.ANNOTATION_TYPE, ElementType.CONSTRUCTOR,
- ElementType.FIELD, ElementType.LOCAL_VARIABLE, ElementType.METHOD,
- ElementType.PACKAGE, ElementType.PARAMETER, ElementType.TYPE})
+@Target({ ElementType.ANNOTATION_TYPE, ElementType.CONSTRUCTOR, ElementType.FIELD, ElementType.LOCAL_VARIABLE,
+ ElementType.METHOD, ElementType.PACKAGE, ElementType.PARAMETER, ElementType.TYPE })
@Retention(RetentionPolicy.SOURCE)
public @interface Generated {
/**
- * @return The name of the code generator. It is recommended that the fully
- * qualified name of the code generator is used.
+ * @return The name of the code generator. It is recommended that the fully qualified name of the code generator is
+ * used.
*/
String[] value();
+
/**
* @return The date the code was generated
*/
String date() default "";
+
/**
* @return Additional comments (if any) related to the code generation
*/
diff --git a/java/javax/annotation/PostConstruct.java b/java/javax/annotation/PostConstruct.java
index 166aedbc6f..aef7d254d8 100644
--- a/java/javax/annotation/PostConstruct.java
+++ b/java/javax/annotation/PostConstruct.java
@@ -23,8 +23,7 @@ import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
/**
- * Added to a method required to be called after the object has been constructed
- * and before it used.
+ * Added to a method required to be called after the object has been constructed and before it used.
*
* @since Common Annotations 1.0
*/
diff --git a/java/javax/annotation/PreDestroy.java b/java/javax/annotation/PreDestroy.java
index 38bc4c6299..4a0749cefb 100644
--- a/java/javax/annotation/PreDestroy.java
+++ b/java/javax/annotation/PreDestroy.java
@@ -23,8 +23,7 @@ import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
/**
- * Added to a method required to be called once the object is no longer required
- * and before it is discarded.
+ * Added to a method required to be called once the object is no longer required and before it is discarded.
*
* @since Common Annotations 1.0
*/
diff --git a/java/javax/annotation/Priority.java b/java/javax/annotation/Priority.java
index 9178b0921e..6d9c84a50f 100644
--- a/java/javax/annotation/Priority.java
+++ b/java/javax/annotation/Priority.java
@@ -23,8 +23,8 @@ import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
/**
- * Used to define the order in which classes or parameters should be used. The
- * annotated class or parameter defines how the prority value is used.
+ * Used to define the order in which classes or parameters should be used. The annotated class or parameter defines how
+ * the prority value is used.
*
* @since Common Annotations 1.2
*/
diff --git a/java/javax/annotation/Resource.java b/java/javax/annotation/Resource.java
index 71427ded3c..cb00bc848f 100644
--- a/java/javax/annotation/Resource.java
+++ b/java/javax/annotation/Resource.java
@@ -22,13 +22,12 @@ import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
/**
- * Indicates a resource required by the application. Annotated classes will be
- * used as resources. Annotated fields and/or methods will have resources
- * injected.
+ * Indicates a resource required by the application. Annotated classes will be used as resources. Annotated fields
+ * and/or methods will have resources injected.
*
* @since Common Annotations 1.0
*/
-@Target({ElementType.TYPE, ElementType.METHOD, ElementType.FIELD})
+@Target({ ElementType.TYPE, ElementType.METHOD, ElementType.FIELD })
@Retention(RetentionPolicy.RUNTIME)
public @interface Resource {
diff --git a/java/javax/annotation/security/DenyAll.java b/java/javax/annotation/security/DenyAll.java
index 069aca2af7..74db2da31a 100644
--- a/java/javax/annotation/security/DenyAll.java
+++ b/java/javax/annotation/security/DenyAll.java
@@ -26,7 +26,7 @@ import java.lang.annotation.Target;
* @since Common Annotations 1.0
*/
@Documented
-@Target({ElementType.METHOD, ElementType.TYPE})
+@Target({ ElementType.METHOD, ElementType.TYPE })
@Retention(RetentionPolicy.RUNTIME)
public @interface DenyAll {
// No attributes
diff --git a/java/javax/annotation/security/PermitAll.java b/java/javax/annotation/security/PermitAll.java
index db1d7b6b88..43177e8186 100644
--- a/java/javax/annotation/security/PermitAll.java
+++ b/java/javax/annotation/security/PermitAll.java
@@ -26,7 +26,7 @@ import java.lang.annotation.Target;
* @since Common Annotations 1.0
*/
@Documented
-@Target({ElementType.TYPE, ElementType.METHOD})
+@Target({ ElementType.TYPE, ElementType.METHOD })
@Retention(RetentionPolicy.RUNTIME)
public @interface PermitAll {
// No attributes
diff --git a/java/javax/annotation/security/RolesAllowed.java b/java/javax/annotation/security/RolesAllowed.java
index 4377cfd137..20bf70d475 100644
--- a/java/javax/annotation/security/RolesAllowed.java
+++ b/java/javax/annotation/security/RolesAllowed.java
@@ -26,7 +26,7 @@ import java.lang.annotation.Target;
* @since Common Annotations 1.0
*/
@Documented
-@Target({ElementType.TYPE, ElementType.METHOD})
+@Target({ ElementType.TYPE, ElementType.METHOD })
@Retention(RetentionPolicy.RUNTIME)
public @interface RolesAllowed {
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@tomcat.apache.org
For additional commands, e-mail: dev-help@tomcat.apache.org
[tomcat] 08/08: Code clean-up - no functional change
Posted by ma...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
markt pushed a commit to branch 9.0.x
in repository https://gitbox.apache.org/repos/asf/tomcat.git
commit 8e92da0ace64e2261e5582d68189e3d57d8e00b1
Author: Mark Thomas <ma...@apache.org>
AuthorDate: Fri Apr 14 12:25:59 2023 +0100
Code clean-up - no functional change
---
java/javax/el/BeanELResolver.java | 12 ++++++------
java/javax/el/ELContext.java | 10 +++++-----
java/javax/el/ELManager.java | 2 +-
java/javax/el/ExpressionFactory.java | 14 +++++++-------
java/javax/el/ImportHandler.java | 12 ++++++------
java/javax/el/LambdaExpression.java | 4 ++--
java/javax/el/MapELResolver.java | 18 +++++++++---------
java/javax/el/StandardELContext.java | 14 +++++++-------
java/javax/el/StaticFieldELResolver.java | 8 ++++----
java/javax/el/Util.java | 6 +++---
10 files changed, 50 insertions(+), 50 deletions(-)
diff --git a/java/javax/el/BeanELResolver.java b/java/javax/el/BeanELResolver.java
index 10d428aa51..38f74081f6 100644
--- a/java/javax/el/BeanELResolver.java
+++ b/java/javax/el/BeanELResolver.java
@@ -53,7 +53,7 @@ public class BeanELResolver extends ELResolver {
private final boolean readOnly;
- private final ConcurrentCache<String, BeanProperties> cache = new ConcurrentCache<>(CACHE_SIZE);
+ private final ConcurrentCache<String,BeanProperties> cache = new ConcurrentCache<>(CACHE_SIZE);
/**
* Creates a writable instance of the standard JavaBean resolver.
@@ -144,8 +144,8 @@ public class BeanELResolver extends ELResolver {
// Find the matching method
Method matchingMethod = Util.findMethod(context, base.getClass(), base, methodName, paramTypes, params);
- Object[] parameters = Util.buildParameters(context, matchingMethod.getParameterTypes(),
- matchingMethod.isVarArgs(), params);
+ Object[] parameters =
+ Util.buildParameters(context, matchingMethod.getParameterTypes(), matchingMethod.isVarArgs(), params);
Object result = null;
try {
@@ -204,7 +204,7 @@ public class BeanELResolver extends ELResolver {
}
static final class BeanProperties {
- private final Map<String, BeanProperty> properties;
+ private final Map<String,BeanProperty> properties;
private final Class<?> type;
@@ -325,8 +325,8 @@ public class BeanELResolver extends ELResolver {
private static final class ConcurrentCache<K, V> {
private final int size;
- private final Map<K, V> eden;
- private final Map<K, V> longterm;
+ private final Map<K,V> eden;
+ private final Map<K,V> longterm;
ConcurrentCache(int size) {
this.size = size;
diff --git a/java/javax/el/ELContext.java b/java/javax/el/ELContext.java
index 5a1cbdbf9e..ac9d5fa2ea 100644
--- a/java/javax/el/ELContext.java
+++ b/java/javax/el/ELContext.java
@@ -30,7 +30,7 @@ public abstract class ELContext {
private Locale locale;
- private Map<Class<?>, Object> map;
+ private Map<Class<?>,Object> map;
private boolean resolved;
@@ -38,7 +38,7 @@ public abstract class ELContext {
private List<EvaluationListener> listeners;
- private Deque<Map<String, Object>> lambdaArguments = new ArrayDeque<>();
+ private Deque<Map<String,Object>> lambdaArguments = new ArrayDeque<>();
public ELContext() {
this.resolved = false;
@@ -235,7 +235,7 @@ public abstract class ELContext {
* @since EL 3.0
*/
public boolean isLambdaArgument(String name) {
- for (Map<String, Object> arguments : lambdaArguments) {
+ for (Map<String,Object> arguments : lambdaArguments) {
if (arguments.containsKey(name)) {
return true;
}
@@ -253,7 +253,7 @@ public abstract class ELContext {
* @since EL 3.0
*/
public Object getLambdaArgument(String name) {
- for (Map<String, Object> arguments : lambdaArguments) {
+ for (Map<String,Object> arguments : lambdaArguments) {
Object result = arguments.get(name);
if (result != null) {
return result;
@@ -270,7 +270,7 @@ public abstract class ELContext {
*
* @since EL 3.0
*/
- public void enterLambdaScope(Map<String, Object> arguments) {
+ public void enterLambdaScope(Map<String,Object> arguments) {
lambdaArguments.push(arguments);
}
diff --git a/java/javax/el/ELManager.java b/java/javax/el/ELManager.java
index 6b3cf7bc74..15677c72bf 100644
--- a/java/javax/el/ELManager.java
+++ b/java/javax/el/ELManager.java
@@ -73,7 +73,7 @@ public class ELManager {
}
public Object defineBean(String name, Object bean) {
- Map<String, Object> localBeans = getELContext().getLocalBeans();
+ Map<String,Object> localBeans = getELContext().getLocalBeans();
if (bean == null) {
return localBeans.remove(name);
diff --git a/java/javax/el/ExpressionFactory.java b/java/javax/el/ExpressionFactory.java
index 77007f875d..c8fb87b1e6 100644
--- a/java/javax/el/ExpressionFactory.java
+++ b/java/javax/el/ExpressionFactory.java
@@ -48,13 +48,13 @@ public abstract class ExpressionFactory {
private static final String PROPERTY_FILE;
private static final CacheValue nullTcclFactory = new CacheValue();
- private static final Map<CacheKey, CacheValue> factoryCache = new ConcurrentHashMap<>();
+ private static final Map<CacheKey,CacheValue> factoryCache = new ConcurrentHashMap<>();
static {
if (IS_SECURITY_ENABLED) {
- PROPERTY_FILE = AccessController
- .doPrivileged((PrivilegedAction<String>) () -> System.getProperty("java.home") + File.separator +
- "lib" + File.separator + "el.properties");
+ PROPERTY_FILE =
+ AccessController.doPrivileged((PrivilegedAction<String>) () -> System.getProperty("java.home") +
+ File.separator + "lib" + File.separator + "el.properties");
} else {
PROPERTY_FILE = System.getProperty("java.home") + File.separator + "lib" + File.separator + "el.properties";
}
@@ -226,7 +226,7 @@ public abstract class ExpressionFactory {
*
* @since EL 3.0
*/
- public Map<String, Method> getInitFunctionMap() {
+ public Map<String,Method> getInitFunctionMap() {
return null;
}
@@ -307,8 +307,8 @@ public abstract class ExpressionFactory {
className = getClassNameServices(tccl);
if (className == null) {
if (IS_SECURITY_ENABLED) {
- className = AccessController
- .doPrivileged((PrivilegedAction<String>) ExpressionFactory::getClassNameJreDir);
+ className =
+ AccessController.doPrivileged((PrivilegedAction<String>) ExpressionFactory::getClassNameJreDir);
} else {
// Second el.properties file
className = getClassNameJreDir();
diff --git a/java/javax/el/ImportHandler.java b/java/javax/el/ImportHandler.java
index a653a855c4..f200c6df32 100644
--- a/java/javax/el/ImportHandler.java
+++ b/java/javax/el/ImportHandler.java
@@ -31,7 +31,7 @@ import java.util.concurrent.ConcurrentHashMap;
*/
public class ImportHandler {
- private static final Map<String, Set<String>> standardPackages = new HashMap<>();
+ private static final Map<String,Set<String>> standardPackages = new HashMap<>();
static {
// Servlet 4.0
@@ -273,10 +273,10 @@ public class ImportHandler {
}
- private Map<String, Set<String>> packageNames = new ConcurrentHashMap<>();
- private Map<String, String> classNames = new ConcurrentHashMap<>();
- private Map<String, Class<?>> clazzes = new ConcurrentHashMap<>();
- private Map<String, Class<?>> statics = new ConcurrentHashMap<>();
+ private Map<String,Set<String>> packageNames = new ConcurrentHashMap<>();
+ private Map<String,String> classNames = new ConcurrentHashMap<>();
+ private Map<String,Class<?>> clazzes = new ConcurrentHashMap<>();
+ private Map<String,Class<?>> statics = new ConcurrentHashMap<>();
public ImportHandler() {
@@ -399,7 +399,7 @@ public class ImportHandler {
// Search the package imports - note there may be multiple matches
// (which correctly triggers an error)
- for (Map.Entry<String, Set<String>> entry : packageNames.entrySet()) {
+ for (Map.Entry<String,Set<String>> entry : packageNames.entrySet()) {
if (!entry.getValue().isEmpty()) {
// Standard package where we know all the class names
if (!entry.getValue().contains(name)) {
diff --git a/java/javax/el/LambdaExpression.java b/java/javax/el/LambdaExpression.java
index cd07fdc9d2..a87d73122b 100644
--- a/java/javax/el/LambdaExpression.java
+++ b/java/javax/el/LambdaExpression.java
@@ -25,7 +25,7 @@ public class LambdaExpression {
private final List<String> formalParameters;
private final ValueExpression expression;
- private final Map<String, Object> nestedArguments = new HashMap<>();
+ private final Map<String,Object> nestedArguments = new HashMap<>();
private ELContext context = null;
public LambdaExpression(List<String> formalParameters, ValueExpression expression) {
@@ -61,7 +61,7 @@ public class LambdaExpression {
// Build the argument map
// Start with the arguments from any outer expressions so if there is
// any overlap the local arguments have priority
- Map<String, Object> lambdaArguments = new HashMap<>(nestedArguments);
+ Map<String,Object> lambdaArguments = new HashMap<>(nestedArguments);
for (int i = 0; i < formalParamCount; i++) {
lambdaArguments.put(formalParameters.get(i), args[i]);
}
diff --git a/java/javax/el/MapELResolver.java b/java/javax/el/MapELResolver.java
index 67f8000c48..9c5e9adf6e 100644
--- a/java/javax/el/MapELResolver.java
+++ b/java/javax/el/MapELResolver.java
@@ -43,7 +43,7 @@ public class MapELResolver extends ELResolver {
public Class<?> getType(ELContext context, Object base, Object property) {
Objects.requireNonNull(context);
- if (base instanceof Map<?, ?>) {
+ if (base instanceof Map<?,?>) {
context.setPropertyResolved(base, property);
return Object.class;
}
@@ -55,9 +55,9 @@ public class MapELResolver extends ELResolver {
public Object getValue(ELContext context, Object base, Object property) {
Objects.requireNonNull(context);
- if (base instanceof Map<?, ?>) {
+ if (base instanceof Map<?,?>) {
context.setPropertyResolved(base, property);
- return ((Map<?, ?>) base).get(property);
+ return ((Map<?,?>) base).get(property);
}
return null;
@@ -67,7 +67,7 @@ public class MapELResolver extends ELResolver {
public void setValue(ELContext context, Object base, Object property, Object value) {
Objects.requireNonNull(context);
- if (base instanceof Map<?, ?>) {
+ if (base instanceof Map<?,?>) {
context.setPropertyResolved(base, property);
if (this.readOnly) {
@@ -77,7 +77,7 @@ public class MapELResolver extends ELResolver {
try {
@SuppressWarnings("unchecked") // Must be OK
- Map<Object, Object> map = ((Map<Object, Object>) base);
+ Map<Object,Object> map = ((Map<Object,Object>) base);
map.put(property, value);
} catch (UnsupportedOperationException e) {
throw new PropertyNotWritableException(e);
@@ -89,7 +89,7 @@ public class MapELResolver extends ELResolver {
public boolean isReadOnly(ELContext context, Object base, Object property) {
Objects.requireNonNull(context);
- if (base instanceof Map<?, ?>) {
+ if (base instanceof Map<?,?>) {
context.setPropertyResolved(base, property);
return this.readOnly || UNMODIFIABLE.equals(base.getClass());
}
@@ -99,8 +99,8 @@ public class MapELResolver extends ELResolver {
@Override
public Iterator<FeatureDescriptor> getFeatureDescriptors(ELContext context, Object base) {
- if (base instanceof Map<?, ?>) {
- Iterator<?> itr = ((Map<?, ?>) base).keySet().iterator();
+ if (base instanceof Map<?,?>) {
+ Iterator<?> itr = ((Map<?,?>) base).keySet().iterator();
List<FeatureDescriptor> feats = new ArrayList<>();
Object key;
FeatureDescriptor desc;
@@ -124,7 +124,7 @@ public class MapELResolver extends ELResolver {
@Override
public Class<?> getCommonPropertyType(ELContext context, Object base) {
- if (base instanceof Map<?, ?>) {
+ if (base instanceof Map<?,?>) {
return Object.class;
}
return null;
diff --git a/java/javax/el/StandardELContext.java b/java/javax/el/StandardELContext.java
index 3185c5cd34..aa9180ec17 100644
--- a/java/javax/el/StandardELContext.java
+++ b/java/javax/el/StandardELContext.java
@@ -30,7 +30,7 @@ public class StandardELContext extends ELContext {
private final FunctionMapper functionMapper;
private final CompositeELResolver standardResolver;
private final CompositeELResolver customResolvers;
- private final Map<String, Object> localBeans = new HashMap<>();
+ private final Map<String,Object> localBeans = new HashMap<>();
public StandardELContext(ExpressionFactory factory) {
@@ -109,14 +109,14 @@ public class StandardELContext extends ELContext {
}
- Map<String, Object> getLocalBeans() {
+ Map<String,Object> getLocalBeans() {
return localBeans;
}
private static class StandardVariableMapper extends VariableMapper {
- private Map<String, ValueExpression> vars;
+ private Map<String,ValueExpression> vars;
@Override
public ValueExpression resolveVariable(String variable) {
@@ -142,9 +142,9 @@ public class StandardELContext extends ELContext {
private static class StandardBeanNameResolver extends BeanNameResolver {
- private final Map<String, Object> beans;
+ private final Map<String,Object> beans;
- StandardBeanNameResolver(Map<String, Object> beans) {
+ StandardBeanNameResolver(Map<String,Object> beans) {
this.beans = beans;
}
@@ -177,9 +177,9 @@ public class StandardELContext extends ELContext {
private static class StandardFunctionMapper extends FunctionMapper {
- private final Map<String, Method> methods = new HashMap<>();
+ private final Map<String,Method> methods = new HashMap<>();
- StandardFunctionMapper(Map<String, Method> initFunctionMap) {
+ StandardFunctionMapper(Map<String,Method> initFunctionMap) {
if (initFunctionMap != null) {
methods.putAll(initFunctionMap);
}
diff --git a/java/javax/el/StaticFieldELResolver.java b/java/javax/el/StaticFieldELResolver.java
index 41365a2414..d1e1b3ffa9 100644
--- a/java/javax/el/StaticFieldELResolver.java
+++ b/java/javax/el/StaticFieldELResolver.java
@@ -88,8 +88,8 @@ public class StaticFieldELResolver extends ELResolver {
if ("<init>".equals(methodName)) {
Constructor<?> match = Util.findConstructor(context, clazz, paramTypes, params);
- Object[] parameters = Util.buildParameters(context, match.getParameterTypes(), match.isVarArgs(),
- params);
+ Object[] parameters =
+ Util.buildParameters(context, match.getParameterTypes(), match.isVarArgs(), params);
Object result = null;
@@ -116,8 +116,8 @@ public class StaticFieldELResolver extends ELResolver {
Util.message(context, "staticFieldELResolver.methodNotFound", methodName, clazz.getName()));
}
- Object[] parameters = Util.buildParameters(context, match.getParameterTypes(), match.isVarArgs(),
- params);
+ Object[] parameters =
+ Util.buildParameters(context, match.getParameterTypes(), match.isVarArgs(), params);
Object result = null;
try {
diff --git a/java/javax/el/Util.java b/java/javax/el/Util.java
index 753521e000..e263f9d41d 100644
--- a/java/javax/el/Util.java
+++ b/java/javax/el/Util.java
@@ -102,7 +102,7 @@ class Util {
private static final CacheValue nullTcclFactory = new CacheValue();
- private static final Map<CacheKey, CacheValue> factoryCache = new ConcurrentHashMap<>();
+ private static final Map<CacheKey,CacheValue> factoryCache = new ConcurrentHashMap<>();
/**
* Provides a per class loader cache of ExpressionFactory instances without pinning any in memory as that could
@@ -241,7 +241,7 @@ class Util {
private static <T> Wrapper<T> findWrapper(ELContext context, Class<?> clazz, List<Wrapper<T>> wrappers, String name,
Class<?>[] paramTypes, Object[] paramValues) {
- Map<Wrapper<T>, MatchResult> candidates = new HashMap<>();
+ Map<Wrapper<T>,MatchResult> candidates = new HashMap<>();
int paramCount = paramTypes.length;
@@ -355,7 +355,7 @@ class Util {
MatchResult bestMatch = new MatchResult(true, 0, 0, 0, 0, true);
Wrapper<T> match = null;
boolean multiple = false;
- for (Map.Entry<Wrapper<T>, MatchResult> entry : candidates.entrySet()) {
+ for (Map.Entry<Wrapper<T>,MatchResult> entry : candidates.entrySet()) {
int cmp = entry.getValue().compareTo(bestMatch);
if (cmp > 0 || match == null) {
bestMatch = entry.getValue();
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@tomcat.apache.org
For additional commands, e-mail: dev-help@tomcat.apache.org
[tomcat] 07/08: Align with Java EE 8
Posted by ma...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
markt pushed a commit to branch 9.0.x
in repository https://gitbox.apache.org/repos/asf/tomcat.git
commit 215a3f0ba8d2d5017df17c645e229e8278cd7e7f
Author: Mark Thomas <ma...@apache.org>
AuthorDate: Fri Apr 14 12:10:55 2023 +0100
Align with Java EE 8
Spotted checking diffs between 9.0.x and 10.1.x
---
java/javax/annotation/Priority.java | 2 +-
java/javax/annotation/Resource.java | 2 ++
java/javax/annotation/sql/DataSourceDefinition.java | 2 ++
3 files changed, 5 insertions(+), 1 deletion(-)
diff --git a/java/javax/annotation/Priority.java b/java/javax/annotation/Priority.java
index 6d9c84a50f..ed7527de05 100644
--- a/java/javax/annotation/Priority.java
+++ b/java/javax/annotation/Priority.java
@@ -29,7 +29,7 @@ import java.lang.annotation.Target;
* @since Common Annotations 1.2
*/
@Documented
-@Target(ElementType.TYPE)
+@Target({ ElementType.TYPE, ElementType.PARAMETER })
@Retention(RetentionPolicy.RUNTIME)
public @interface Priority {
diff --git a/java/javax/annotation/Resource.java b/java/javax/annotation/Resource.java
index cb00bc848f..856fd1ecd8 100644
--- a/java/javax/annotation/Resource.java
+++ b/java/javax/annotation/Resource.java
@@ -17,6 +17,7 @@
package javax.annotation;
import java.lang.annotation.ElementType;
+import java.lang.annotation.Repeatable;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
@@ -29,6 +30,7 @@ import java.lang.annotation.Target;
*/
@Target({ ElementType.TYPE, ElementType.METHOD, ElementType.FIELD })
@Retention(RetentionPolicy.RUNTIME)
+@Repeatable(Resources.class)
public @interface Resource {
/**
diff --git a/java/javax/annotation/sql/DataSourceDefinition.java b/java/javax/annotation/sql/DataSourceDefinition.java
index a779b219d4..a4137e0eb6 100644
--- a/java/javax/annotation/sql/DataSourceDefinition.java
+++ b/java/javax/annotation/sql/DataSourceDefinition.java
@@ -17,6 +17,7 @@
package javax.annotation.sql;
import java.lang.annotation.ElementType;
+import java.lang.annotation.Repeatable;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
@@ -26,6 +27,7 @@ import java.lang.annotation.Target;
*/
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
+@Repeatable(DataSourceDefinitions.class)
public @interface DataSourceDefinition {
/**
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@tomcat.apache.org
For additional commands, e-mail: dev-help@tomcat.apache.org