Author: jalkanen
Date: Sat May 24 02:16:26 2008
New Revision: 659779
URL: http://svn.apache.org/viewvc?rev=659779&view=rev
Log:
Javadoc, Java5, and comment fixes.
Modified:
incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/PageManager.java
incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/PropertyReader.java
incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/QueryItem.java
incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/TranslatorReader.java
incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/WikiContext.java
incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/WikiPage.java
Modified: incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/PageManager.java
URL:
http://svn.apache.org/viewvc/incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/PageManager.java?rev=659779&r1=659778&r2=659779&view=diff
==============================================================================
--- incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/PageManager.java (original)
+++ incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/PageManager.java Sat May 24
02:16:26 2008
@@ -51,6 +51,9 @@
* Manages the WikiPages. This class functions as an unified interface
towards
* the page providers. It handles initialization and management of the
providers,
* and provides utility methods for accessing the contents.
+ * <p>
+ * Saving a page is a two-stage Task; first the pre-save operations and then
the
+ * actual save. See the descriptions of the tasks for further information.
*
* @since 2.0
*/
@@ -72,12 +75,24 @@
*/
public static final String PROP_LOCKEXPIRY = "jspwiki.lockExpiryTime";
+ /** The message key for storing the text for the presave task. Value is
<tt>[EMAIL PROTECTED]</tt>*/
public static final String PRESAVE_TASK_MESSAGE_KEY =
"task.preSaveWikiPage";
+
+ /** The workflow attribute which stores the wikiContext. */
public static final String PRESAVE_WIKI_CONTEXT = "wikiContext";
- public static final String SAVE_APPROVER = "workflow.saveWikiPage";
+
+ /** The name of the key from jspwiki.properties which defines who shall
approve
+ * the workflow of storing a wikipage. Value is <tt>[EMAIL
PROTECTED]</tt>*/
+ public static final String SAVE_APPROVER =
"workflow.saveWikiPage";
+
+ /** The message key for storing the Decision text for saving a page.
Value is [EMAIL PROTECTED] */
public static final String SAVE_DECISION_MESSAGE_KEY =
"decision.saveWikiPage";
- public static final String SAVE_REJECT_MESSAGE_KEY =
"notification.saveWikiPage.reject";
- public static final String SAVE_TASK_MESSAGE_KEY = "task.saveWikiPage";
+
+ /** The message key for rejecting the decision to save the page. Value is
[EMAIL PROTECTED] */
+ public static final String SAVE_REJECT_MESSAGE_KEY =
"notification.saveWikiPage.reject";
+
+ /** The message key of the text to finally approve a page save. Value is
[EMAIL PROTECTED] */
+ public static final String SAVE_TASK_MESSAGE_KEY = "task.saveWikiPage";
/** Fact name for storing the page name. Value is [EMAIL PROTECTED] */
public static final String FACT_PAGE_NAME = "fact.pageName";
@@ -91,13 +106,14 @@
/** Fact name for storing the proposed (edited) text. Value is [EMAIL
PROTECTED] */
public static final String FACT_PROPOSED_TEXT = "fact.proposedText";
+ /** Fact name for storing whether the user is authenticated or not. Value
is [EMAIL PROTECTED] */
public static final String FACT_IS_AUTHENTICATED = "fact.isAuthenticated";
static Logger log = Logger.getLogger( PageManager.class );
private WikiPageProvider m_provider;
- protected HashMap m_pageLocks = new HashMap();
+ protected HashMap<String,PageLock> m_pageLocks = new
HashMap<String,PageLock>();
private WikiEngine m_engine;
@@ -319,7 +335,7 @@
{
fireEvent( WikiPageEvent.PAGE_LOCK, page.getName() ); // prior to
or after actual lock?
- lock = (PageLock) m_pageLocks.get( page.getName() );
+ lock = m_pageLocks.get( page.getName() );
if( lock == null )
{
@@ -377,7 +393,7 @@
synchronized( m_pageLocks )
{
- lock = (PageLock)m_pageLocks.get( page.getName() );
+ lock = m_pageLocks.get( page.getName() );
}
return lock;
@@ -393,13 +409,13 @@
*/
public List getActiveLocks()
{
- ArrayList result = new ArrayList();
+ ArrayList<PageLock> result = new ArrayList<PageLock>();
synchronized( m_pageLocks )
{
- for( Iterator i = m_pageLocks.values().iterator(); i.hasNext(); )
+ for( PageLock lock : m_pageLocks.values() )
{
- result.add( i.next() );
+ result.add( lock );
}
}
@@ -639,6 +655,12 @@
private final WikiContext m_context;
private final String m_proposedText;
+ /**
+ * Creates the task.
+ *
+ * @param context The WikiContext
+ * @param proposedText The text that was just saved.
+ */
public PreSaveWikiPageTask( WikiContext context, String proposedText )
{
super( PRESAVE_TASK_MESSAGE_KEY );
@@ -646,6 +668,10 @@
m_proposedText = proposedText;
}
+ /**
+ * [EMAIL PROTECTED]
+ */
+ @Override
public Outcome execute() throws WikiException
{
// Retrieve attributes
@@ -694,11 +720,16 @@
*/
public static class SaveWikiPageTask extends Task
{
+ /**
+ * Creates the Task.
+ */
public SaveWikiPageTask()
{
super( SAVE_TASK_MESSAGE_KEY );
}
+ /** [EMAIL PROTECTED] */
+ @Override
public Outcome execute() throws WikiException
{
// Retrieve attributes
@@ -741,6 +772,7 @@
/**
* [EMAIL PROTECTED]
*/
+ @Override
public Collection modules()
{
// TODO Auto-generated method stub
@@ -825,8 +857,8 @@
if ( acl != null )
{
Enumeration entries = acl.entries();
- Collection entriesToAdd = new ArrayList();
- Collection entriesToRemove = new ArrayList();
+ Collection<AclEntry> entriesToAdd = new ArrayList<AclEntry>();
+ Collection<AclEntry> entriesToRemove = new ArrayList<AclEntry>();
while ( entries.hasMoreElements() )
{
AclEntry entry = (AclEntry)entries.nextElement();
Modified: incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/PropertyReader.java
URL:
http://svn.apache.org/viewvc/incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/PropertyReader.java?rev=659779&r1=659778&r2=659779&view=diff
==============================================================================
--- incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/PropertyReader.java (original)
+++ incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/PropertyReader.java Sat May
24 02:16:26 2008
@@ -47,6 +47,11 @@
*/
public static final String PARAM_PROPERTYFILE = "jspwiki.propertyfile";
+ /**
+ * The prefix when you are cascading properties.
+ *
+ * @see #loadWebAppProps(ServletContext)
+ */
public static final String PARAM_PROPERTYFILE_CASCADEPREFIX =
"jspwiki.propertyfile.cascade.";
/** Path to the default property file.
@@ -54,8 +59,8 @@
*/
public static final String DEFAULT_PROPERTYFILE =
"/WEB-INF/jspwiki.properties";
- public static final String PARAM_VAR_DECLARATION = "var.";
- public static final String PARAM_VAR_IDENTIFIER = "$";
+ private static final String PARAM_VAR_DECLARATION = "var.";
+ private static final String PARAM_VAR_IDENTIFIER = "$";
/**
@@ -102,6 +107,9 @@
* and so on. You have to number your cascade in a descending way starting
* with "1". This means you cannot leave out numbers in your cascade. This
* method is based on an idea by Olaf Kaus, see [JSPWiki:MultipleWikis].
+ *
+ * @param context A Servlet Context which is used to find the properties
+ * @return A filled Properties object with all the cascaded properties in
place
*/
public static Properties loadWebAppProps( ServletContext context )
{
@@ -168,6 +176,8 @@
/**
* Returns the default property set as a Properties object.
+ *
+ * @return The default property set.
*/
public static final Properties getDefaultProperties()
{
@@ -275,7 +285,7 @@
public static void expandVars(Properties properties)
{
//get variable name/values from properties...
- Map vars = new HashMap();
+ Map<String,String> vars = new HashMap<String,String>();
Enumeration propertyList = properties.propertyNames();
while( propertyList.hasMoreElements() )
{
@@ -323,4 +333,4 @@
}
}
-}
\ No newline at end of file
+}
Modified: incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/QueryItem.java
URL:
http://svn.apache.org/viewvc/incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/QueryItem.java?rev=659779&r1=659778&r2=659779&view=diff
==============================================================================
--- incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/QueryItem.java (original)
+++ incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/QueryItem.java Sat May 24
02:16:26 2008
@@ -25,6 +25,7 @@
* for searches. It tells the word and whether it is requested or not.
*
*/
+// FIXME3.0: This should be moved to the search-package, as well as properly
rewritten as a bean.
public class QueryItem
{
/** The word is required to be in the pages */
Modified: incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/TranslatorReader.java
URL:
http://svn.apache.org/viewvc/incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/TranslatorReader.java?rev=659779&r1=659778&r2=659779&view=diff
==============================================================================
--- incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/TranslatorReader.java
(original)
+++ incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/TranslatorReader.java Sat May
24 02:16:26 2008
@@ -20,29 +20,16 @@
*/
package com.ecyrd.jspwiki;
-import java.io.*;
-import java.text.MessageFormat;
-import java.util.*;
-
-import org.apache.log4j.Logger;
-import org.apache.oro.text.*;
-import org.apache.oro.text.regex.*;
+import java.io.IOException;
+import java.io.Reader;
+import java.io.StringReader;
+import java.util.Collection;
-import com.ecyrd.jspwiki.i18n.InternationalizationManager;
-import com.ecyrd.jspwiki.parser.Heading;
import com.ecyrd.jspwiki.parser.HeadingListener;
import com.ecyrd.jspwiki.parser.JSPWikiMarkupParser;
import com.ecyrd.jspwiki.parser.MarkupParser;
-import com.ecyrd.jspwiki.plugin.PluginManager;
-import com.ecyrd.jspwiki.plugin.PluginException;
-import com.ecyrd.jspwiki.plugin.WikiPlugin;
-import com.ecyrd.jspwiki.attachment.AttachmentManager;
-import com.ecyrd.jspwiki.attachment.Attachment;
-import com.ecyrd.jspwiki.providers.ProviderException;
import com.ecyrd.jspwiki.render.WikiRenderer;
import com.ecyrd.jspwiki.render.XHTMLRenderer;
-import com.ecyrd.jspwiki.auth.acl.Acl;
-import com.ecyrd.jspwiki.auth.WikiSecurityException;
/**
* Handles conversion from Wiki format into fully featured HTML.
@@ -94,14 +81,21 @@
private WikiContext m_context;
/**
- /**
* Creates a TranslatorReader using the default HTML renderer.
+ * @param context WikiContext
+ * @param in The reader from which to read.
*/
public TranslatorReader( WikiContext context, Reader in )
{
initialize( context, in );
}
+ /**
+ * Creates a TranslatorReader.
+ * @param context WikiContext
+ * @param in Reader
+ * @param renderer Unused.
+ */
public TranslatorReader( WikiContext context, Reader in, Object renderer )
{
initialize( context, in );
@@ -131,10 +125,8 @@
}
/**
- * Sets the currently used renderer. This method is protected because
- * we only want to use it internally for now. The renderer interface
- * is not yet set to stone, so it's not expected that third parties
- * would use this.
+ * Does not work, don't try to use it.
+ * @param renderer Renderer.
*/
protected void setRenderer( Object renderer )
{
@@ -186,11 +178,13 @@
m_parser.addAttachmentLinkHook( mutator );
}
+ /** Adds a listener to headings. */
public void addHeadingListener( HeadingListener listener )
{
m_parser.addHeadingListener( listener );
}
+ /** Disables access rules parsing. */
public void disableAccessRules()
{
m_parser.disableAccessRules();
@@ -198,6 +192,7 @@
/**
* Can be used to turn on plugin execution on a translator-reader basis
+ * @param toggle on or off
*/
public void enablePlugins( boolean toggle )
{
@@ -219,6 +214,7 @@
/**
* Figure out which image suffixes should be inlined.
* @return Collection of Strings with patterns.
+ * @param engine WikiEngine
*/
protected static Collection getImagePatterns( WikiEngine engine )
@@ -234,6 +230,7 @@
* @param type Type of the link.
* @param link The actual link.
* @param text The user-visible text for the link.
+ * @return link
*/
public String makeLink( int type, String link, String text )
{
@@ -265,6 +262,7 @@
private StringReader m_data;
+ /** [EMAIL PROTECTED]/
public int read()
throws IOException
{
@@ -280,18 +278,21 @@
return m_data.read();
}
+ /** [EMAIL PROTECTED]/
public int read( char[] buf, int off, int len )
throws IOException
{
return m_data.read( buf, off, len );
}
-
+
+ /** [EMAIL PROTECTED]/
public boolean ready()
throws IOException
{
return m_data.ready();
}
-
+
+ /** [EMAIL PROTECTED]/
public void close()
{
}
Modified: incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/WikiContext.java
URL:
http://svn.apache.org/viewvc/incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/WikiContext.java?rev=659779&r1=659778&r2=659779&view=diff
==============================================================================
--- incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/WikiContext.java (original)
+++ incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/WikiContext.java Sat May 24
02:16:26 2008
@@ -75,7 +75,7 @@
private WikiEngine m_engine;
private String m_template = "default";
- private Map m_variableMap = new HashMap();
+ private Map<String,Object> m_variableMap = new HashMap<String,Object>();
/**
* Stores the HttpServletRequest. May be null, if the request did not
Modified: incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/WikiPage.java
URL:
http://svn.apache.org/viewvc/incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/WikiPage.java?rev=659779&r1=659778&r2=659779&view=diff
==============================================================================
--- incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/WikiPage.java (original)
+++ incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/WikiPage.java Sat May 24
02:16:26 2008
@@ -49,7 +49,7 @@
private long m_fileSize = -1;
private int m_version = WikiPageProvider.LATEST_VERSION;
private String m_author = null;
- private final HashMap m_attributes = new HashMap();
+ private final HashMap<String,Object> m_attributes = new
HashMap<String,Object>();
/**
* "Summary" is a short summary of the page. It is a String.
