Author: ivaynberg
Date: Fri Sep 14 07:51:19 2007
New Revision: 575710
URL: http://svn.apache.org/viewvc?rev=575710&view=rev
Log:
WICKET-971: Wicket Javadoc Standardization
Modified:
wicket/trunk/jdk-1.4/wicket/src/main/java/org/apache/wicket/util/watch/IModifiable.java
wicket/trunk/jdk-1.4/wicket/src/main/java/org/apache/wicket/util/watch/ModificationWatcher.java
wicket/trunk/jdk-1.4/wicket/src/main/java/org/apache/wicket/util/watch/package.html
Modified:
wicket/trunk/jdk-1.4/wicket/src/main/java/org/apache/wicket/util/watch/IModifiable.java
URL:
http://svn.apache.org/viewvc/wicket/trunk/jdk-1.4/wicket/src/main/java/org/apache/wicket/util/watch/IModifiable.java?rev=575710&r1=575709&r2=575710&view=diff
==============================================================================
---
wicket/trunk/jdk-1.4/wicket/src/main/java/org/apache/wicket/util/watch/IModifiable.java
(original)
+++
wicket/trunk/jdk-1.4/wicket/src/main/java/org/apache/wicket/util/watch/IModifiable.java
Fri Sep 14 07:51:19 2007
@@ -22,13 +22,14 @@
* Interface to get the last time something was modified.
*
* @author Jonathan Locke
+ * @since 1.2.6
*/
public interface IModifiable
{
/**
* Gets the last time this modifiable thing changed.
*
- * @return The last modification time.
+ * @return the last modification <code>Time</code>
*/
Time lastModifiedTime();
}
Modified:
wicket/trunk/jdk-1.4/wicket/src/main/java/org/apache/wicket/util/watch/ModificationWatcher.java
URL:
http://svn.apache.org/viewvc/wicket/trunk/jdk-1.4/wicket/src/main/java/org/apache/wicket/util/watch/ModificationWatcher.java?rev=575710&r1=575709&r2=575710&view=diff
==============================================================================
---
wicket/trunk/jdk-1.4/wicket/src/main/java/org/apache/wicket/util/watch/ModificationWatcher.java
(original)
+++
wicket/trunk/jdk-1.4/wicket/src/main/java/org/apache/wicket/util/watch/ModificationWatcher.java
Fri Sep 14 07:51:19 2007
@@ -33,22 +33,27 @@
/**
- * Monitors one or more Modifiable objects, calling a ChangeListener when a
- * given object's modification time changes.
+ * Monitors one or more <code>IModifiable</code> objects, calling a
+ * [EMAIL PROTECTED] IChangeListener IChangeListener} when a given object's
modification
+ * time changes.
*
* @author Jonathan Locke
+ * @since 1.2.6
*/
public final class ModificationWatcher
{
- /** Logging */
+ /** logger */
private static final Logger log =
LoggerFactory.getLogger(ModificationWatcher.class);
- /** Maps Modifiable objects to Entry objects */
+ /** maps <code>IModifiable</code> objects to <code>Entry</code> objects
*/
private final Map modifiableToEntry = new HashMap();
+ /** the <code>Task</code> to run */
private Task task;
- // MarkupContainer class for holding modifiable entries to watch
+ /**
+ * Container class for holding modifiable entries to watch.
+ */
private static final class Entry
{
// The most recent lastModificationTime polled on the object
@@ -62,17 +67,18 @@
}
/**
- * For two-phase construction
+ * Default constructor for two-phase construction.
*/
public ModificationWatcher()
{
}
/**
- * Constructor
+ * Constructor that accepts a <code>Duration</code> argument
representing
+ * the poll frequency.
*
* @param pollFrequency
- * How often to check on modifiables
+ * how often to check on <code>IModifiable</code>s
*/
public ModificationWatcher(final Duration pollFrequency)
{
@@ -80,15 +86,17 @@
}
/**
- * Adds a Modifiable object and an IChangeListener to call when the
- * modifiable object is modified.
+ * Adds an <code>IModifiable</code> object and an
+ * <code>IChangeListener</code> object to call when the modifiable
object
+ * is modified.
*
* @param modifiable
- * The modifiable thing to monitor
+ * an <code>IModifiable</code> object to monitor
* @param listener
- * The listener to call if the modifiable is modified
- * @return <tt>true</tt> if the set did not already contain the
specified
- * element.
+ * an <code>IChangeListener</code> to call if the
+ * <code>IModifiable</code> object is modified
+ * @return <code>true</code> if the set did not already contain the
+ * specified element
*/
public final boolean add(final IModifiable modifiable, final
IChangeListener listener)
{
@@ -126,10 +134,12 @@
}
/**
- * Remove all entries associated with 'modifiable'
+ * Removes all entries associated with an <code>IModifiable</code>
object.
*
* @param modifiable
- * @return the object removed, else null
+ * an <code>IModifiable</code> object
+ * @return the <code>IModifiable</code> object that was removed, else
+ * <code>null</code>
*/
public IModifiable remove(final IModifiable modifiable)
{
@@ -142,10 +152,10 @@
}
/**
- * Start watching at a given polling rate
+ * Starts watching at a given <code>Duration</code> polling rate.
*
* @param pollFrequency
- * The poll rate
+ * the polling rate <code>Duration</code>
*/
public void start(final Duration pollFrequency)
{
@@ -184,19 +194,23 @@
}
/**
- * stops the modification watcher from watching.
+ * Stops this <code>ModificationWatcher</code>.
*/
public void destroy()
{
if (task != null)
{
-// task.stop();
+ // task.stop();
task.interrupt();
}
}
/**
- * @return Gets all IModifiable entries currently maintained
+ * Retrieves a key set of all <code>IModifiable</code> objects currently
+ * being monitored.
+ *
+ * @return a <code>Set</code> of all <code>IModifiable</code> entries
+ * currently maintained
*/
public final Set getEntries()
{
Modified:
wicket/trunk/jdk-1.4/wicket/src/main/java/org/apache/wicket/util/watch/package.html
URL:
http://svn.apache.org/viewvc/wicket/trunk/jdk-1.4/wicket/src/main/java/org/apache/wicket/util/watch/package.html?rev=575710&r1=575709&r2=575710&view=diff
==============================================================================
---
wicket/trunk/jdk-1.4/wicket/src/main/java/org/apache/wicket/util/watch/package.html
(original)
+++
wicket/trunk/jdk-1.4/wicket/src/main/java/org/apache/wicket/util/watch/package.html
Fri Sep 14 07:51:19 2007
@@ -16,12 +16,14 @@
-->
<!DOCTYPE HTML PUBLIC "-//W3C/DTD HTML 3.2 Final//NL">
<html>
-<head>
-<title>wicket.util.watch package</title>
-</head>
-<body>
-<p>
-Modification observers.
-</p>
-</body>
+ <head>
+ <title>
+ org.apache.wicket.util.watch package
+ </title>
+ </head>
+ <body>
+ <p>
+ This package provides modification watchers.
+ </p>
+ </body>
</html>
