From e07ba4928310e5750bf784c2ef55abc8a3b9cab9 Mon Sep 17 00:00:00 2001 From: olivier lamy Date: Fri, 29 Dec 2017 11:07:51 +1100 Subject: [PATCH] more javadoc fixes #2056 Signed-off-by: olivier lamy --- .../org/eclipse/jetty/plus/jndi/NamingEntry.java | 2 +- .../eclipse/jetty/server/session/HouseKeeper.java | 14 +++++++------- .../session/JDBCSessionDataStoreFactory.java | 4 ++-- .../jetty/server/session/NullSessionCache.java | 2 +- .../jetty/server/session/SessionHandler.java | 8 ++++---- .../session/UnreadableSessionDataException.java | 12 ++++++------ .../org/eclipse/jetty/servlet/ServletHandler.java | 7 +++++-- .../eclipse/jetty/webapp/MetaInfConfiguration.java | 2 +- .../eclipse/jetty/webapp/WebInfConfiguration.java | 4 ++-- 9 files changed, 29 insertions(+), 26 deletions(-) diff --git a/jetty-plus/src/main/java/org/eclipse/jetty/plus/jndi/NamingEntry.java b/jetty-plus/src/main/java/org/eclipse/jetty/plus/jndi/NamingEntry.java index 63250f5f594..9d15f2c64e2 100644 --- a/jetty-plus/src/main/java/org/eclipse/jetty/plus/jndi/NamingEntry.java +++ b/jetty-plus/src/main/java/org/eclipse/jetty/plus/jndi/NamingEntry.java @@ -60,7 +60,7 @@ public abstract class NamingEntry * * @param scope an object representing the scope of the name to be bound into jndi, where null means jvm scope. * @param jndiName the name that will be associated with an object bound into jndi - * @throws NamingException + * @throws NamingException if jndiName is null */ protected NamingEntry (Object scope, String jndiName) throws NamingException diff --git a/jetty-server/src/main/java/org/eclipse/jetty/server/session/HouseKeeper.java b/jetty-server/src/main/java/org/eclipse/jetty/server/session/HouseKeeper.java index f294be51288..8bc66482f5a 100644 --- a/jetty-server/src/main/java/org/eclipse/jetty/server/session/HouseKeeper.java +++ b/jetty-server/src/main/java/org/eclipse/jetty/server/session/HouseKeeper.java @@ -107,9 +107,9 @@ public class HouseKeeper extends AbstractLifeCycle * Get a scheduler. First try a common scheduler, failing that * create our own. * - * @throws Exception + * @throws Exception when the scheduler cannot be started */ - protected void findScheduler () throws Exception + protected void findScheduler() throws Exception { if (_scheduler == null) { @@ -133,9 +133,9 @@ public class HouseKeeper extends AbstractLifeCycle /** * If scavenging is not scheduled, schedule it. - * @throws Exception + * @throws Exception if any error during scheduling the scavenging */ - protected void startScavenging() throws Exception + protected void startScavenging() throws Exception { synchronized (this) { @@ -155,7 +155,7 @@ public class HouseKeeper extends AbstractLifeCycle /** * If scavenging is scheduled, stop it. * - * @throws Exception + * @throws Exception if any error during stopping the scavenging */ protected void stopScavenging() throws Exception { @@ -195,9 +195,9 @@ public class HouseKeeper extends AbstractLifeCycle /** * Set the period between scavenge cycles * @param sec the interval (in seconds) - * @throws Exception + * @throws Exception if any error during restarting the scavenging */ - public void setIntervalSec (long sec) throws Exception + public void setIntervalSec(long sec) throws Exception { if (isStarted() || isStarting()) { diff --git a/jetty-server/src/main/java/org/eclipse/jetty/server/session/JDBCSessionDataStoreFactory.java b/jetty-server/src/main/java/org/eclipse/jetty/server/session/JDBCSessionDataStoreFactory.java index a67bf7c2014..2ed148e1d88 100644 --- a/jetty-server/src/main/java/org/eclipse/jetty/server/session/JDBCSessionDataStoreFactory.java +++ b/jetty-server/src/main/java/org/eclipse/jetty/server/session/JDBCSessionDataStoreFactory.java @@ -54,7 +54,7 @@ public class JDBCSessionDataStoreFactory extends AbstractSessionDataStoreFactory /** - * @param adaptor + * @param adaptor the {@link DatabaseAdaptor} to set */ public void setDatabaseAdaptor (DatabaseAdaptor adaptor) { @@ -63,7 +63,7 @@ public class JDBCSessionDataStoreFactory extends AbstractSessionDataStoreFactory /** - * @param schema + * @param schema the {@link JDBCSessionDataStoreFactory} to set */ public void setSessionTableSchema (JDBCSessionDataStore.SessionTableSchema schema) { diff --git a/jetty-server/src/main/java/org/eclipse/jetty/server/session/NullSessionCache.java b/jetty-server/src/main/java/org/eclipse/jetty/server/session/NullSessionCache.java index a944e4ed85d..32b2bb8c8d0 100644 --- a/jetty-server/src/main/java/org/eclipse/jetty/server/session/NullSessionCache.java +++ b/jetty-server/src/main/java/org/eclipse/jetty/server/session/NullSessionCache.java @@ -32,7 +32,7 @@ public class NullSessionCache extends AbstractSessionCache { /** - * @param handler + * @param handler The SessionHandler related to this SessionCache */ public NullSessionCache(SessionHandler handler) { diff --git a/jetty-server/src/main/java/org/eclipse/jetty/server/session/SessionHandler.java b/jetty-server/src/main/java/org/eclipse/jetty/server/session/SessionHandler.java index 5ddb073d03c..9e25eebbe28 100644 --- a/jetty-server/src/main/java/org/eclipse/jetty/server/session/SessionHandler.java +++ b/jetty-server/src/main/java/org/eclipse/jetty/server/session/SessionHandler.java @@ -1006,7 +1006,7 @@ public class SessionHandler extends ScopedHandler /** - * @param cache + * @param cache the session store to use */ public void setSessionCache (SessionCache cache) { @@ -1294,7 +1294,7 @@ public class SessionHandler extends ScopedHandler * configurable amount of time, or the session itself * has passed its expiry. * - * @param session + * @param session the session */ public void sessionInactivityTimerExpired (Session session) { @@ -1349,8 +1349,8 @@ public class SessionHandler extends ScopedHandler * * @param id identity of session to check * - * @return true if this manager knows about this id - * @throws Exception + * @return true if this manager knows about this id + * @throws Exception if any error occurred */ public boolean isIdInUse(String id) throws Exception { diff --git a/jetty-server/src/main/java/org/eclipse/jetty/server/session/UnreadableSessionDataException.java b/jetty-server/src/main/java/org/eclipse/jetty/server/session/UnreadableSessionDataException.java index f4b2637fe14..77ccfbd077f 100644 --- a/jetty-server/src/main/java/org/eclipse/jetty/server/session/UnreadableSessionDataException.java +++ b/jetty-server/src/main/java/org/eclipse/jetty/server/session/UnreadableSessionDataException.java @@ -52,14 +52,14 @@ public class UnreadableSessionDataException extends Exception /** - * @param id - * @param contextId - * @param t + * @param id the session id + * @param sessionContext the sessionContext + * @param t the cause of the exception */ - public UnreadableSessionDataException (String id, SessionContext contextId, Throwable t) + public UnreadableSessionDataException (String id, SessionContext sessionContext, Throwable t) { - super ("Unreadable session "+id+" for "+contextId, t); - _sessionContext = contextId; + super ("Unreadable session "+id+" for "+sessionContext, t); + _sessionContext = sessionContext; _id = id; } } diff --git a/jetty-servlet/src/main/java/org/eclipse/jetty/servlet/ServletHandler.java b/jetty-servlet/src/main/java/org/eclipse/jetty/servlet/ServletHandler.java index 92dabbd00c2..326851f1b1e 100644 --- a/jetty-servlet/src/main/java/org/eclipse/jetty/servlet/ServletHandler.java +++ b/jetty-servlet/src/main/java/org/eclipse/jetty/servlet/ServletHandler.java @@ -832,7 +832,10 @@ public class ServletHandler extends ScopedHandler /* ------------------------------------------------------------ */ /** - * Create a new CachedChain + * Create a new CachedChain + * @param filters a collection of {@link FilterHolder} + * @param servletHolder the servletHolder + * @return a new {@link CachedChain} instance */ public CachedChain newCachedChain(List filters, ServletHolder servletHolder) { @@ -1590,7 +1593,7 @@ public class ServletHandler extends ScopedHandler /* ------------------------------------------------------------ */ /** * @param filters list of {@link FilterHolder} objects - * @param servletHolder + * @param servletHolder the current {@link ServletHolder} */ protected CachedChain(List filters, ServletHolder servletHolder) { diff --git a/jetty-webapp/src/main/java/org/eclipse/jetty/webapp/MetaInfConfiguration.java b/jetty-webapp/src/main/java/org/eclipse/jetty/webapp/MetaInfConfiguration.java index e06a55cda1e..bb6245ed72c 100644 --- a/jetty-webapp/src/main/java/org/eclipse/jetty/webapp/MetaInfConfiguration.java +++ b/jetty-webapp/src/main/java/org/eclipse/jetty/webapp/MetaInfConfiguration.java @@ -113,7 +113,7 @@ public class MetaInfConfiguration extends AbstractConfiguration * @param context the context for the scan * @param jars the jars to scan * @param useCaches if true, the scanned info is cached - * @throws Exception + * @throws Exception if unable to scan the jars */ public void scanJars (final WebAppContext context, Collection jars, boolean useCaches) throws Exception diff --git a/jetty-webapp/src/main/java/org/eclipse/jetty/webapp/WebInfConfiguration.java b/jetty-webapp/src/main/java/org/eclipse/jetty/webapp/WebInfConfiguration.java index 9e6d92f2698..d43196df1e9 100644 --- a/jetty-webapp/src/main/java/org/eclipse/jetty/webapp/WebInfConfiguration.java +++ b/jetty-webapp/src/main/java/org/eclipse/jetty/webapp/WebInfConfiguration.java @@ -177,7 +177,7 @@ public class WebInfConfiguration extends AbstractConfiguration * look at the java.class.path, and the jdk.module.path. * * @param context the WebAppContext being deployed - * @throws Exception + * @throws Exception if unable to apply optional filtering on the container's classpath */ public void findAndFilterContainerPaths (final WebAppContext context) throws Exception @@ -287,7 +287,7 @@ public class WebInfConfiguration extends AbstractConfiguration * all jars are considered selected. * * @param context the WebAppContext being deployed - * @throws Exception + * @throws Exception if unable to find the jars or apply filtering */ public void findAndFilterWebAppPaths (WebAppContext context) throws Exception