Author: fschumacher
Date: Sat Nov 21 13:01:29 2015
New Revision: 1715510
URL: http://svn.apache.org/viewvc?rev=1715510&view=rev
Log:
Javadoc changes. Markup changes and addition of return annotations
Modified:
tomcat/trunk/java/org/apache/catalina/session/JDBCStore.java
Modified: tomcat/trunk/java/org/apache/catalina/session/JDBCStore.java
URL:
http://svn.apache.org/viewvc/tomcat/trunk/java/org/apache/catalina/session/JDBCStore.java?rev=1715510&r1=1715509&r2=1715510&view=diff
==============================================================================
--- tomcat/trunk/java/org/apache/catalina/session/JDBCStore.java (original)
+++ tomcat/trunk/java/org/apache/catalina/session/JDBCStore.java Sat Nov 21
13:01:29 2015
@@ -46,9 +46,10 @@ import org.apache.catalina.util.CustomOb
import org.apache.tomcat.util.ExceptionUtils;
/**
- * Implementation of the <code>Store</code> interface that stores
- * serialized session objects in a database. Sessions that are
- * saved are still subject to being expired based on inactivity.
+ * Implementation of the {@link org.apache.catalina.Store Store}
+ * interface that stores serialized session objects in a database.
+ * Sessions that are saved are still subject to being expired
+ * based on inactivity.
*
* @author Bip Thelin
*/
@@ -133,7 +134,7 @@ public class JDBCStore extends StoreBase
protected String sessionDataCol = "data";
/**
- * Is Valid column to use.
+ * {@code Is Valid} column to use.
*/
protected String sessionValidCol = "valid";
@@ -182,7 +183,7 @@ public class JDBCStore extends StoreBase
// ------------------------------------------------------------- Properties
/**
- * Return the name for this instance (built from container name)
+ * @return the name for this instance (built from container name)
*/
public String getName() {
if (name == null) {
@@ -207,14 +208,14 @@ public class JDBCStore extends StoreBase
}
/**
- * Return the thread name for this Store.
+ * @return the thread name for this Store.
*/
public String getThreadName() {
return (threadName);
}
/**
- * Return the name for this Store, used for logging.
+ * @return the name for this Store, used for logging.
*/
@Override
public String getStoreName() {
@@ -236,15 +237,14 @@ public class JDBCStore extends StoreBase
}
/**
- * Return the driver for this Store.
+ * @return the driver for this Store.
*/
public String getDriverName() {
return (this.driverName);
}
/**
- * Return the username to use to connect to the database.
- *
+ * @return the username to use to connect to the database.
*/
public String getConnectionName() {
return connectionName;
@@ -260,8 +260,7 @@ public class JDBCStore extends StoreBase
}
/**
- * Return the password to use to connect to the database.
- *
+ * @return the password to use to connect to the database.
*/
public String getConnectionPassword() {
return connectionPassword;
@@ -290,7 +289,7 @@ public class JDBCStore extends StoreBase
}
/**
- * Return the Connection URL for this Store.
+ * @return the Connection URL for this Store.
*/
public String getConnectionURL() {
return (this.connectionURL);
@@ -310,7 +309,7 @@ public class JDBCStore extends StoreBase
}
/**
- * Return the table for this Store.
+ * @return the table for this Store.
*/
public String getSessionTable() {
return (this.sessionTable);
@@ -330,7 +329,7 @@ public class JDBCStore extends StoreBase
}
/**
- * Return the web application name column for the table.
+ * @return the web application name column for the table.
*/
public String getSessionAppCol() {
return (this.sessionAppCol);
@@ -350,7 +349,7 @@ public class JDBCStore extends StoreBase
}
/**
- * Return the Id column for the table.
+ * @return the Id column for the table.
*/
public String getSessionIdCol() {
return (this.sessionIdCol);
@@ -370,14 +369,14 @@ public class JDBCStore extends StoreBase
}
/**
- * Return the data column for the table
+ * @return the data column for the table
*/
public String getSessionDataCol() {
return (this.sessionDataCol);
}
/**
- * Set the Is Valid column for the table
+ * Set the {@code Is Valid} column for the table
*
* @param sessionValidCol The column name
*/
@@ -390,14 +389,14 @@ public class JDBCStore extends StoreBase
}
/**
- * Return the Is Valid column
+ * @return the {@code Is Valid} column
*/
public String getSessionValidCol() {
return (this.sessionValidCol);
}
/**
- * Set the Max Inactive column for the table
+ * Set the {@code Max Inactive} column for the table
*
* @param sessionMaxInactiveCol The column name
*/
@@ -410,14 +409,14 @@ public class JDBCStore extends StoreBase
}
/**
- * Return the Max Inactive column
+ * @return the {@code Max Inactive} column
*/
public String getSessionMaxInactiveCol() {
return (this.sessionMaxInactiveCol);
}
/**
- * Set the Last Accessed column for the table
+ * Set the {@code Last Accessed} column for the table
*
* @param sessionLastAccessedCol The column name
*/
@@ -430,7 +429,7 @@ public class JDBCStore extends StoreBase
}
/**
- * Return the Last Accessed column
+ * @return the {@code Last Accessed} column
*/
public String getSessionLastAccessedCol() {
return (this.sessionLastAccessedCol);
@@ -451,7 +450,7 @@ public class JDBCStore extends StoreBase
}
/**
- * Return the name of the JNDI DataSource-factory
+ * @return the name of the JNDI DataSource-factory
*/
public String getDataSourceName() {
return this.dataSourceName;
@@ -464,6 +463,8 @@ public class JDBCStore extends StoreBase
* currently saved in this Store. If there are no such Sessions, a
* zero-length array is returned.
*
+ * @return array containing the list of session IDs
+ *
* @exception IOException if an input/output error occurred
*/
@Override
@@ -517,6 +518,8 @@ public class JDBCStore extends StoreBase
* currently saved in this Store. If there are no Sessions,
* <code>0</code> is returned.
*
+ * @return the count of all sessions currently saved in this Store
+ *
* @exception IOException if an input/output error occurred
*/
@Override
@@ -857,7 +860,9 @@ public class JDBCStore extends StoreBase
/**
* Open (if necessary) and return a database connection for use by
- * this Realm.
+ * this Store.
+ *
+ * @return database connection ready to use
*
* @exception SQLException if a database error occurs
*/
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscr...@tomcat.apache.org
For additional commands, e-mail: dev-h...@tomcat.apache.org
