Author: jalkanen
Date: Sat Jun 7 04:13:38 2008
New Revision: 664320
URL: http://svn.apache.org/viewvc?rev=664320&view=rev
Log:
Various Javadoc, Java5, checkstyle, and comment fixes.
Modified:
incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/ui/progress/ProgressItem.java
incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/ui/progress/ProgressManager.java
incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/url/DefaultURLConstructor.java
incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/url/ShortURLConstructor.java
incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/url/URLConstructor.java
incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/util/ProviderConverter.java
incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/workflow/AbstractStep.java
Modified:
incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/ui/progress/ProgressItem.java
URL:
http://svn.apache.org/viewvc/incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/ui/progress/ProgressItem.java?rev=664320&r1=664319&r2=664320&view=diff
==============================================================================
--- incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/ui/progress/ProgressItem.java
(original)
+++ incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/ui/progress/ProgressItem.java
Sat Jun 7 04:13:38 2008
@@ -27,18 +27,36 @@
*/
public abstract class ProgressItem
{
+ /**
+ * Status: The PI is created.
+ */
public static final int CREATED = 0;
+
+ /** Status: The PI is started. */
public static final int STARTED = 1;
+
+ /** Status: The PI is stopped. */
public static final int STOPPED = 2;
+
+ /** Status: The PI is finished. */
public static final int FINISHED = 3;
protected int m_state = CREATED;
+ /**
+ * Get the state of the ProgressItem.
+ * @return CREATED, STARTED, STOPPED or FINISHED.
+ */
public int getState()
{
return m_state;
}
+ /**
+ * Sets the state of the ProgressItem.
+ *
+ * @param state One of the CREATED, STARTED, STOPPED or FINISHED.
+ */
public void setState( int state )
{
m_state = state;
Modified:
incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/ui/progress/ProgressManager.java
URL:
http://svn.apache.org/viewvc/incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/ui/progress/ProgressManager.java?rev=664320&r1=664319&r2=664320&view=diff
==============================================================================
---
incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/ui/progress/ProgressManager.java
(original)
+++
incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/ui/progress/ProgressManager.java
Sat Jun 7 04:13:38 2008
@@ -90,7 +90,7 @@
public void stopProgress( String id )
{
log.debug("Removed "+id+" from progress queue");
- ProgressItem pi = (ProgressItem) m_progressingTasks.remove( id );
+ ProgressItem pi = m_progressingTasks.remove( id );
if( pi != null ) pi.setState( ProgressItem.STOPPED );
}
@@ -104,7 +104,7 @@
public int getProgress( String id )
throws IllegalArgumentException
{
- ProgressItem pi = (ProgressItem)m_progressingTasks.get( id );
+ ProgressItem pi = m_progressingTasks.get( id );
if( pi != null )
{
@@ -132,4 +132,4 @@
return ProgressManager.this.getProgress( progressId );
}
}
-}
\ No newline at end of file
+}
Modified:
incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/url/DefaultURLConstructor.java
URL:
http://svn.apache.org/viewvc/incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/url/DefaultURLConstructor.java?rev=664320&r1=664319&r2=664320&view=diff
==============================================================================
---
incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/url/DefaultURLConstructor.java
(original)
+++
incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/url/DefaultURLConstructor.java
Sat Jun 7 04:13:38 2008
@@ -306,4 +306,4 @@
{
return request.getPathInfo();
}
-}
\ No newline at end of file
+}
Modified:
incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/url/ShortURLConstructor.java
URL:
http://svn.apache.org/viewvc/incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/url/ShortURLConstructor.java?rev=664320&r1=664319&r2=664320&view=diff
==============================================================================
--- incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/url/ShortURLConstructor.java
(original)
+++ incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/url/ShortURLConstructor.java
Sat Jun 7 04:13:38 2008
@@ -227,4 +227,4 @@
return jspPage+".jsp";
}
-}
\ No newline at end of file
+}
Modified: incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/url/URLConstructor.java
URL:
http://svn.apache.org/viewvc/incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/url/URLConstructor.java?rev=664320&r1=664319&r2=664320&view=diff
==============================================================================
--- incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/url/URLConstructor.java
(original)
+++ incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/url/URLConstructor.java Sat
Jun 7 04:13:38 2008
@@ -93,4 +93,4 @@
* JSPWiki will figure out the page.
*/
public String getForwardPage( HttpServletRequest request );
-}
\ No newline at end of file
+}
Modified:
incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/util/ProviderConverter.java
URL:
http://svn.apache.org/viewvc/incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/util/ProviderConverter.java?rev=664320&r1=664319&r2=664320&view=diff
==============================================================================
--- incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/util/ProviderConverter.java
(original)
+++ incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/util/ProviderConverter.java
Sat Jun 7 04:13:38 2008
@@ -147,7 +147,7 @@
}
/**
- * @param args
+ * @param args Normal arguments.
*/
public static void main( String[] args )
throws Exception
Modified:
incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/workflow/AbstractStep.java
URL:
http://svn.apache.org/viewvc/incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/workflow/AbstractStep.java?rev=664320&r1=664319&r2=664320&view=diff
==============================================================================
--- incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/workflow/AbstractStep.java
(original)
+++ incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/workflow/AbstractStep.java
Sat Jun 7 04:13:38 2008
@@ -260,7 +260,7 @@
*/
public final Step getSuccessor( Outcome outcome )
{
- return (Step) m_successors.get( outcome );
+ return m_successors.get( outcome );
}
// --------------------------Helper methods--------------------------