jspwiki-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From juanpa...@apache.org
Subject [jspwiki] branch master updated: Fixed all javadoc errors when building using java 8 - no version bump
Date Sun, 04 Mar 2018 00:34:46 GMT
This is an automated email from the ASF dual-hosted git repository.

juanpablo pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/jspwiki.git


The following commit(s) were added to refs/heads/master by this push:
     new 7dc525f  Fixed all javadoc errors when building using java 8 - no version bump
7dc525f is described below

commit 7dc525f274c69926ad3e7e7b3958cc3330ed517b
Author: juanpablo <juanpablo@apache.org>
AuthorDate: Sun Mar 4 01:34:21 2018 +0100

    Fixed all javadoc errors when building using java 8 - no version bump
---
 ChangeLog                                          |   4 +
 .../wiki/ajax/WikiAjaxDispatcherServlet.java       | 150 ++++++++++----------
 .../wiki/api/exceptions/FilterException.java       |  10 +-
 .../wiki/api/exceptions/PluginException.java       |  16 +--
 .../wiki/api/exceptions/ProviderException.java     |  14 +-
 .../java/org/apache/wiki/auth/UserManager.java     | 155 +++++++++++----------
 .../htmltowiki/ForgetNullValuesLinkedHashMap.java  |  14 +-
 .../org/apache/wiki/management/SimpleMBean.java    |  22 +--
 .../apache/wiki/parser/LinkParsingOperations.java  |   2 +-
 .../org/apache/wiki/parser/ParseException.java     |  10 +-
 .../apache/wiki/plugin/DefaultPluginManager.java   |   2 +-
 .../wiki/providers/AbstractFileProvider.java       |  74 +++++-----
 .../wiki/providers/NoSuchVersionException.java     |  10 +-
 .../org/apache/wiki/render/CleanTextRenderer.java  |  36 +++--
 .../apache/wiki/render/WysiwygEditingRenderer.java |   4 +-
 .../java/org/apache/wiki/render/XHTMLRenderer.java |  22 +--
 .../main/java/org/apache/wiki/rss/RSS10Feed.java   |  14 +-
 17 files changed, 288 insertions(+), 271 deletions(-)

diff --git a/ChangeLog b/ChangeLog
index 65dfe13..13b9b5b 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,7 @@
+2018-03-04  Juan Pablo Santos (juanpablo AT apache DOT org)
+
+       * Fixed all javadoc errors when building using java 8 - no version bump
+
 2018-02-25  Dirk Frederickx (brushed AT apache DOT org)
 
        * 2.10.4-git-01  Fixing Admin JSP Bugs
diff --git a/jspwiki-war/src/main/java/org/apache/wiki/ajax/WikiAjaxDispatcherServlet.java b/jspwiki-war/src/main/java/org/apache/wiki/ajax/WikiAjaxDispatcherServlet.java
index 829de91..bcf6a75 100644
--- a/jspwiki-war/src/main/java/org/apache/wiki/ajax/WikiAjaxDispatcherServlet.java
+++ b/jspwiki-war/src/main/java/org/apache/wiki/ajax/WikiAjaxDispatcherServlet.java
@@ -15,7 +15,7 @@
     "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
     KIND, either express or implied.  See the License for the
     specific language governing permissions and limitations
-    under the License.     
+    under the License.
  */
 package org.apache.wiki.ajax;
 
@@ -43,23 +43,24 @@ import org.apache.wiki.util.TextUtil;
 
 /**
  * This provides a simple ajax servlet for handling /ajax/<ClassName> requests.
- * HttpServlet classes need to be registered using {@link WikiAjaxDispatcherServlet.registerServlet(WikiAjaxServlet)}
+ * HttpServlet classes need to be registered using {@link WikiAjaxDispatcherServlet#registerServlet(WikiAjaxServlet)}
  *
  * @since 2.10.2-svn12
  */
 public class WikiAjaxDispatcherServlet extends HttpServlet {
-	private static final long serialVersionUID = 1L;
-	private static Map<String,AjaxServletContainer> ajaxServlets = new HashMap<String,AjaxServletContainer>();
+    private static final long serialVersionUID = 1L;
+    private static Map<String,AjaxServletContainer> ajaxServlets = new HashMap<String,AjaxServletContainer>();
     static final Logger log = Logger.getLogger(WikiAjaxDispatcherServlet.class.getName());
     private String PATH_AJAX = "/ajax/";
     private WikiEngine m_engine;
 
     /**
      * {@inheritDoc}
-     * 
+     *
      * This sets the AjaxPath to "/ajax/" as configured in "jspwiki.ajax.url.prefix".
      * Note: Do not change this without also changing the web.xml file.
      */
+    @Override
     public void init(ServletConfig config)
             throws ServletException {
         super.init(config);
@@ -72,48 +73,50 @@ public class WikiAjaxDispatcherServlet extends HttpServlet {
      * Register a {@link WikiAjaxServlet} using the servlet mapping as the alias
      */
     public static void registerServlet(WikiAjaxServlet servlet) {
-    	registerServlet(servlet.getServletMapping(),servlet);
+        registerServlet(servlet.getServletMapping(),servlet);
     }
-    
+
     /**
-     * Register a {@link WikiAjaxServlet} with a specific alias, and default permission {@link PagePermission.VIEW}.
+     * Register a {@link WikiAjaxServlet} with a specific alias, and default permission {@link PagePermission#VIEW}.
      */
     public static void registerServlet(String alias, WikiAjaxServlet servlet) {
-    	registerServlet(alias, servlet, PagePermission.VIEW);
+        registerServlet(alias, servlet, PagePermission.VIEW);
     }
-    
+
     /**
      * Regster a {@link WikiAjaxServlet} given an alias, the servlet, and the permission.
-     * Thie creates a temporary bundle object called {@link AjaxServletContainer} 
+     * This creates a temporary bundle object called {@link WikiAjaxDispatcherServlet.AjaxServletContainer}
      * @param alias the uri link to this servlet
      * @param servlet the servlet being registered
      * @param perm the permission required to execute the servlet.
      */
     public static void registerServlet(String alias, WikiAjaxServlet servlet, Permission perm) {
-    	log.info("WikiAjaxDispatcherServlet registering "+alias+"="+servlet+" perm="+perm);
+        log.info("WikiAjaxDispatcherServlet registering "+alias+"="+servlet+" perm="+perm);
         ajaxServlets.put(alias,new AjaxServletContainer(alias, servlet, perm));
     }
 
     /**
-     * Calls {@link this.performAction}
+     * Calls {@link #performAction}
      */
+    @Override
     public void doPost(HttpServletRequest req, HttpServletResponse res)
             throws IOException, ServletException {
         performAction(req,res);
     }
 
     /**
-     * Calls {@link this.performAction}
+     * Calls {@link #performAction}
      */
+    @Override
     public void doGet(HttpServletRequest req, HttpServletResponse res)
             throws IOException, ServletException {
         performAction(req,res);
     }
 
     /**
-     * The main method which get the requestURI "/ajax/<ServletName>", gets the 
-     * {@link this.getServletName} and finds the servlet using {@link this.findServletByName}. 
-     * It then calls {@link WikiAjaxServlet.service} method.
+     * The main method which get the requestURI "/ajax/<ServletName>", gets the
+     * {@link #getServletName} and finds the servlet using {@link #findServletByName}.
+     * It then calls {@link WikiAjaxServlet#service} method.
      * @param req the inbound request
      * @param res the outbound response
      * @throws IOException
@@ -121,46 +124,46 @@ public class WikiAjaxDispatcherServlet extends HttpServlet {
      */
     private void performAction(HttpServletRequest req, HttpServletResponse res)
             throws IOException, ServletException {
-        String path = req.getRequestURI();
-        String servletName = getServletName(path);
+        final String path = req.getRequestURI();
+        final String servletName = getServletName(path);
         if (servletName!=null) {
-        	AjaxServletContainer container = findServletContainer(servletName);
+            final AjaxServletContainer container = findServletContainer(servletName);
             if (container != null) {
-            	WikiAjaxServlet servlet = container.servlet;
-            	if ( validatePermission(req,container) ) {
-            	    req.setCharacterEncoding(m_engine.getContentEncoding());
-            	    res.setCharacterEncoding(m_engine.getContentEncoding());
-            		String actionName = AjaxUtil.getNextPathPart(req.getRequestURI(), servlet.getServletMapping());
-            		log.debug("actionName="+actionName);
-            		Object params = req.getParameter("params");
-            		log.debug("params="+params);
-            		List<String> paramValues = new ArrayList<String>();
-            		if (params instanceof String) {
-            			String paramString = (String)params;
-            			if (StringUtils.isNotBlank(paramString)) {
-            				paramValues = Arrays.asList(paramString.trim().split(","));
-            			}
-            		}
-            		servlet.service(req, res, actionName, paramValues);
-            	} else {
-            		log.warn("Servlet container "+container+" not authorised. Permission required.");
-            	}
+                final WikiAjaxServlet servlet = container.servlet;
+                if ( validatePermission(req,container) ) {
+                    req.setCharacterEncoding(m_engine.getContentEncoding());
+                    res.setCharacterEncoding(m_engine.getContentEncoding());
+                    final String actionName = AjaxUtil.getNextPathPart(req.getRequestURI(), servlet.getServletMapping());
+                    log.debug("actionName="+actionName);
+                    final Object params = req.getParameter("params");
+                    log.debug("params="+params);
+                    List<String> paramValues = new ArrayList<String>();
+                    if (params instanceof String) {
+                        final String paramString = (String)params;
+                        if (StringUtils.isNotBlank(paramString)) {
+                            paramValues = Arrays.asList(paramString.trim().split(","));
+                        }
+                    }
+                    servlet.service(req, res, actionName, paramValues);
+                } else {
+                    log.warn("Servlet container "+container+" not authorised. Permission required.");
+                }
             } else {
                 log.error("No registered class for servletName=" + servletName + " in path=" + path);
                 throw new ServletException("No registered class for servletName=" + servletName);
             }
         }
     }
-    
+
     /**
-     * Validate the permission of the {@link WikiAjaxServlet} using the {@link AuthorizationManager.checkPermission}
-     * 
+     * Validate the permission of the {@link WikiAjaxServlet} using the {@link AuthorizationManager#checkPermission}
+     *
      * @param req the servlet request
      * @param container the container info of the servlet
      * @return true if permission is valid
      */
     private boolean validatePermission(HttpServletRequest req, AjaxServletContainer container) {
-        WikiEngine e = WikiEngine.getInstance(req.getSession().getServletContext(), null);
+        final WikiEngine e = WikiEngine.getInstance(req.getSession().getServletContext(), null);
         boolean valid = false;
         if (container != null) {
             valid = e.getAuthorizationManager().checkPermission(WikiSession.getWikiSession(e, req), container.permission);
@@ -169,54 +172,55 @@ public class WikiAjaxDispatcherServlet extends HttpServlet {
     }
 
     /**
-     * Get the ServletName from the requestURI "/ajax/<ServletName>", using {@link AjaxUtil.getNextPathPath}.
-     * 
+     * Get the ServletName from the requestURI "/ajax/<ServletName>", using {@link AjaxUtil#getNextPathPart}.
+     *
      * @param path The requestURI, which must contains "/ajax/<ServletName>" in the path
      * @return The ServletName for the requestURI, or null
      * @throws ServletException if the path is invalid
      */
     public String getServletName(String path) throws ServletException {
-    	return AjaxUtil.getNextPathPart(path, PATH_AJAX);
+        return AjaxUtil.getNextPathPart(path, PATH_AJAX);
     }
-    
+
     /**
-     * Find the {@link AjaxServletContainer} as registered in {@link WikiAjaxDispatcherServlet.registerServlet}.
-     * 
-     * @param servletName the name of the servlet from {@link this.getServletName}
+     * Find the {@link AjaxServletContainer} as registered in {@link #registerServlet}.
+     *
+     * @param servletName the name of the servlet from {@link #getServletName}
      * @return The first servlet found, or null.
      */
     private AjaxServletContainer findServletContainer(String servletAlias) {
-    	return ajaxServlets.get(servletAlias);
+        return ajaxServlets.get(servletAlias);
     }
 
     /**
      * Find the {@link WikiAjaxServlet} given the servletAlias that it was registered with.
-     * 
-     * @param servletAlias the value provided to {@link this.registerServlet}
-     * @return
+     *
+     * @param servletAlias the value provided to {@link #registerServlet}
+     * @return the {@link WikiAjaxServlet} given the servletAlias that it was registered with.
      */
     public WikiAjaxServlet findServletByName(String servletAlias) {
-    	AjaxServletContainer container = ajaxServlets.get(servletAlias);
-    	if (container != null) {
-    		return container.servlet;
-    	}
-    	return null;
+        final AjaxServletContainer container = ajaxServlets.get(servletAlias);
+        if (container != null) {
+            return container.servlet;
+        }
+        return null;
     }
-    
+
     private static class AjaxServletContainer {
-    	String alias;
-    	WikiAjaxServlet servlet;
-    	Permission permission;
-    	
-    	public AjaxServletContainer(String alias, WikiAjaxServlet servlet, Permission permission) {
-    		this.alias = alias;
-    		this.servlet = servlet;
-    		this.permission = permission;
-		}
-    	
-    	public String toString() {
-    		return getClass().getSimpleName()+" "+alias+"="+servlet.getClass().getSimpleName()+" permission="+permission;
-    	}
+        String alias;
+        WikiAjaxServlet servlet;
+        Permission permission;
+
+        public AjaxServletContainer(String alias, WikiAjaxServlet servlet, Permission permission) {
+            this.alias = alias;
+            this.servlet = servlet;
+            this.permission = permission;
+        }
+
+        @Override
+        public String toString() {
+            return getClass().getSimpleName()+" "+alias+"="+servlet.getClass().getSimpleName()+" permission="+permission;
+        }
     }
 
 }
diff --git a/jspwiki-war/src/main/java/org/apache/wiki/api/exceptions/FilterException.java b/jspwiki-war/src/main/java/org/apache/wiki/api/exceptions/FilterException.java
index 7c3162d..27ca868 100644
--- a/jspwiki-war/src/main/java/org/apache/wiki/api/exceptions/FilterException.java
+++ b/jspwiki-war/src/main/java/org/apache/wiki/api/exceptions/FilterException.java
@@ -1,4 +1,4 @@
-/* 
+/*
     Licensed to the Apache Software Foundation (ASF) under one
     or more contributor license agreements.  See the NOTICE file
     distributed with this work for additional information
@@ -14,7 +14,7 @@
     "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
     KIND, either express or implied.  See the License for the
     specific language governing permissions and limitations
-    under the License.  
+    under the License.
  */
 package org.apache.wiki.api.exceptions;
 
@@ -25,13 +25,13 @@ package org.apache.wiki.api.exceptions;
  *  @since 2.1.112
  */
 public class FilterException extends WikiException {
-    
+
     private static final long serialVersionUID = -490652869936406653L;
 
     /**
      *  Constructs an exception.
-     *  
-     *  @param msg {@inheritDoc}
+     *
+     *  @param msg exception message.
      */
     public FilterException( String msg ) {
         super( msg );
diff --git a/jspwiki-war/src/main/java/org/apache/wiki/api/exceptions/PluginException.java b/jspwiki-war/src/main/java/org/apache/wiki/api/exceptions/PluginException.java
index 5ead0a7..6d25cf9 100644
--- a/jspwiki-war/src/main/java/org/apache/wiki/api/exceptions/PluginException.java
+++ b/jspwiki-war/src/main/java/org/apache/wiki/api/exceptions/PluginException.java
@@ -14,7 +14,7 @@
     "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
     KIND, either express or implied.  See the License for the
     specific language governing permissions and limitations
-    under the License.  
+    under the License.
  */
 package org.apache.wiki.api.exceptions;
 
@@ -23,15 +23,15 @@ package org.apache.wiki.api.exceptions;
  *  Provides a generic PluginException.  This is the kind of an exception that the plugins should throw.
  */
 public class PluginException  extends WikiException {
-	
+
     private static final long serialVersionUID = -289900047240960332L;
 
     private final Throwable m_throwable;
 
     /**
      *  Create a PluginException.
-     *  
-     *  @param message {@inheritDoc}
+     *
+     *  @param message exception message.
      */
     public PluginException( String message ) {
         super( message );
@@ -40,8 +40,8 @@ public class PluginException  extends WikiException {
 
     /**
      *  Create a PluginException with the given original exception wrapped.
-     *  
-     *  @param message {@inheritDoc}
+     *
+     *  @param message exception message.
      *  @param original The original exception.
      */
     public PluginException( String message, Throwable original ) {
@@ -51,11 +51,11 @@ public class PluginException  extends WikiException {
 
     /**
      *  Return the original exception.
-     *  
+     *
      *  @return The original exception.
      */
     public Throwable getRootThrowable() {
         return m_throwable;
     }
-    
+
 }
diff --git a/jspwiki-war/src/main/java/org/apache/wiki/api/exceptions/ProviderException.java b/jspwiki-war/src/main/java/org/apache/wiki/api/exceptions/ProviderException.java
index 4d2dadf..4059224 100644
--- a/jspwiki-war/src/main/java/org/apache/wiki/api/exceptions/ProviderException.java
+++ b/jspwiki-war/src/main/java/org/apache/wiki/api/exceptions/ProviderException.java
@@ -1,4 +1,4 @@
-/* 
+/*
     Licensed to the Apache Software Foundation (ASF) under one
     or more contributor license agreements.  See the NOTICE file
     distributed with this work for additional information
@@ -14,24 +14,24 @@
     "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
     KIND, either express or implied.  See the License for the
     specific language governing permissions and limitations
-    under the License.  
+    under the License.
  */
 package org.apache.wiki.api.exceptions;
 
 
 /**
- *  This exception represents the superclass of all exceptions that providers may throw.  It is okay to throw 
- *  it in case you cannot use any of the specific subclasses, in which case the page loading is considered to be 
+ *  This exception represents the superclass of all exceptions that providers may throw.  It is okay to throw
+ *  it in case you cannot use any of the specific subclasses, in which case the page loading is considered to be
  *  broken, and the user is notified.
  */
 public class ProviderException extends WikiException {
 
     private static final long serialVersionUID = 0L;
-    
+
     /**
      *  Creates a ProviderException.
-     *  
-     *  @param msg {@inheritDoc}
+     *
+     *  @param msg exception message.
      */
     public ProviderException( String msg ) {
         super( msg );
diff --git a/jspwiki-war/src/main/java/org/apache/wiki/auth/UserManager.java b/jspwiki-war/src/main/java/org/apache/wiki/auth/UserManager.java
index 1412718..6f503d5 100644
--- a/jspwiki-war/src/main/java/org/apache/wiki/auth/UserManager.java
+++ b/jspwiki-war/src/main/java/org/apache/wiki/auth/UserManager.java
@@ -1,4 +1,4 @@
-/* 
+/*
     Licensed to the Apache Software Foundation (ASF) under one
     or more contributor license agreements.  See the NOTICE file
     distributed with this work for additional information
@@ -14,7 +14,7 @@
     "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
     KIND, either express or implied.  See the License for the
     specific language governing permissions and limitations
-    under the License.  
+    under the License.
  */
 package org.apache.wiki.auth;
 
@@ -159,28 +159,28 @@ public class UserManager {
                                                           PROP_DATABASE );
 
             log.info("Attempting to load user database class "+dbClassName);
-            Class<?> dbClass = ClassUtil.findClass( USERDATABASE_PACKAGE, dbClassName );
+            final Class<?> dbClass = ClassUtil.findClass( USERDATABASE_PACKAGE, dbClassName );
             m_database = (UserDatabase) dbClass.newInstance();
             m_database.initialize( m_engine, m_engine.getWikiProperties() );
             log.info("UserDatabase initialized.");
         }
-        catch( NoRequiredPropertyException e )
+        catch( final NoRequiredPropertyException e )
         {
             log.error( "You have not set the '"+PROP_DATABASE+"'. You need to do this if you want to enable user management by JSPWiki." );
         }
-        catch( ClassNotFoundException e )
+        catch( final ClassNotFoundException e )
         {
             log.error( "UserDatabase class " + dbClassName + " cannot be found", e );
         }
-        catch( InstantiationException e )
+        catch( final InstantiationException e )
         {
             log.error( "UserDatabase class " + dbClassName + " cannot be created", e );
         }
-        catch( IllegalAccessException e )
+        catch( final IllegalAccessException e )
         {
             log.error( "You are not allowed to access this user database class", e );
         }
-        catch( WikiSecurityException e )
+        catch( final WikiSecurityException e )
         {
             log.error( "Exception initializing user database: " + e.getMessage() );
         }
@@ -235,7 +235,7 @@ public class UserManager {
                 profile = getUserDatabase().find( user.getName() );
                 newProfile = false;
             }
-            catch( NoSuchPrincipalException e )
+            catch( final NoSuchPrincipalException e )
             {
             }
         }
@@ -298,18 +298,18 @@ public class UserManager {
     public void setUserProfile( WikiSession session, UserProfile profile ) throws DuplicateUserException, WikiException
     {
         // Verify user is allowed to save profile!
-        Permission p = new WikiPermission( m_engine.getApplicationName(), WikiPermission.EDIT_PROFILE_ACTION );
+        final Permission p = new WikiPermission( m_engine.getApplicationName(), WikiPermission.EDIT_PROFILE_ACTION );
         if ( !m_engine.getAuthorizationManager().checkPermission( session, p ) )
         {
             throw new WikiSecurityException( "You are not allowed to save wiki profiles." );
         }
 
         // Check if profile is new, and see if container allows creation
-        boolean newProfile = profile.isNew();
+        final boolean newProfile = profile.isNew();
 
         // Check if another user profile already has the fullname or loginname
-        UserProfile oldProfile = getUserProfile( session );
-        boolean nameChanged = ( oldProfile == null  || oldProfile.getFullname() == null )
+        final UserProfile oldProfile = getUserProfile( session );
+        final boolean nameChanged = ( oldProfile == null  || oldProfile.getFullname() == null )
             ? false
             : !( oldProfile.getFullname().equals( profile.getFullname() ) &&
                  oldProfile.getLoginName().equals( profile.getLoginName() ) );
@@ -322,7 +322,7 @@ public class UserManager {
                 throw new DuplicateUserException( "security.error.login.taken", profile.getLoginName() );
             }
         }
-        catch( NoSuchPrincipalException e )
+        catch( final NoSuchPrincipalException e )
         {
         }
         try
@@ -333,20 +333,20 @@ public class UserManager {
                 throw new DuplicateUserException( "security.error.fullname.taken", profile.getFullname() );
             }
         }
-        catch( NoSuchPrincipalException e )
+        catch( final NoSuchPrincipalException e )
         {
         }
 
         // For new accounts, create approval workflow for user profile save.
         if ( newProfile && oldProfile != null && oldProfile.isNew() )
         {
-            WorkflowBuilder builder = WorkflowBuilder.getBuilder( m_engine );
-            Principal submitter = session.getUserPrincipal();
-            Task completionTask = new SaveUserProfileTask( m_engine, session.getLocale() );
+            final WorkflowBuilder builder = WorkflowBuilder.getBuilder( m_engine );
+            final Principal submitter = session.getUserPrincipal();
+            final Task completionTask = new SaveUserProfileTask( m_engine, session.getLocale() );
 
             // Add user profile attribute as Facts for the approver (if required)
-            boolean hasEmail = profile.getEmail() != null;
-            Fact[] facts = new Fact[ hasEmail ? 4 : 3];
+            final boolean hasEmail = profile.getEmail() != null;
+            final Fact[] facts = new Fact[ hasEmail ? 4 : 3];
             facts[0] = new Fact( PREFS_FULL_NAME, profile.getFullname() );
             facts[1] = new Fact( PREFS_LOGIN_NAME, profile.getLoginName() );
             facts[2] = new Fact( FACT_SUBMITTER, submitter.getName() );
@@ -354,7 +354,7 @@ public class UserManager {
             {
                 facts[3] = new Fact( PREFS_EMAIL, profile.getEmail() );
             }
-            Workflow workflow = builder.buildApprovalWorkflow( submitter,
+            final Workflow workflow = builder.buildApprovalWorkflow( submitter,
                                                                SAVE_APPROVER,
                                                                null,
                                                                SAVE_DECISION_MESSAGE_KEY,
@@ -365,7 +365,7 @@ public class UserManager {
             workflow.setAttribute( SAVED_PROFILE, profile );
             m_engine.getWorkflowManager().start(workflow);
 
-            boolean approvalRequired = workflow.getCurrentStep() instanceof Decision;
+            final boolean approvalRequired = workflow.getCurrentStep() instanceof Decision;
 
             // If the profile requires approval, redirect user to message page
             if ( approvalRequired )
@@ -377,13 +377,13 @@ public class UserManager {
 
             try
             {
-                AuthenticationManager mgr = m_engine.getAuthenticationManager();
+                final AuthenticationManager mgr = m_engine.getAuthenticationManager();
                 if ( newProfile && !mgr.isContainerAuthenticated() )
                 {
                     mgr.login( session, null, profile.getLoginName(), profile.getPassword() );
                 }
             }
-            catch ( WikiException e )
+            catch ( final WikiException e )
             {
                 throw new WikiSecurityException( e.getMessage(), e );
             }
@@ -408,7 +408,7 @@ public class UserManager {
             if ( nameChanged )
             {
                 // Fire an event if the login name or full name changed
-                UserProfile[] profiles = new UserProfile[] { oldProfile, profile };
+                final UserProfile[] profiles = new UserProfile[] { oldProfile, profile };
                 fireEvent( WikiSecurityEvent.PROFILE_NAME_CHANGED, session, profiles );
             }
             else
@@ -444,8 +444,8 @@ public class UserManager {
     public UserProfile parseProfile( WikiContext context )
     {
         // Retrieve the user's profile (may have been previously cached)
-        UserProfile profile = getUserProfile( context.getWikiSession() );
-        HttpServletRequest request = context.getHttpRequest();
+        final UserProfile profile = getUserProfile( context.getWikiSession() );
+        final HttpServletRequest request = context.getHttpRequest();
 
         // Extract values from request stream (cleanse whitespace as needed)
         String loginName = request.getParameter( PARAM_LOGINNAME );
@@ -487,17 +487,17 @@ public class UserManager {
      */
     public void validateProfile( WikiContext context, UserProfile profile )
     {
-        boolean isNew = profile.isNew();
-        WikiSession session = context.getWikiSession();
-        InputValidator validator = new InputValidator( SESSION_MESSAGES, context );
-        ResourceBundle rb = Preferences.getBundle( context, InternationalizationManager.CORE_BUNDLE );
+        final boolean isNew = profile.isNew();
+        final WikiSession session = context.getWikiSession();
+        final InputValidator validator = new InputValidator( SESSION_MESSAGES, context );
+        final ResourceBundle rb = Preferences.getBundle( context, InternationalizationManager.CORE_BUNDLE );
 
         //
         //  Query the SpamFilter first
         //
-        FilterManager fm = m_engine.getFilterManager();
-        List<PageFilter> ls = fm.getFilterList();
-        for( PageFilter pf : ls )
+        final FilterManager fm = m_engine.getFilterManager();
+        final List<PageFilter> ls = fm.getFilterList();
+        for( final PageFilter pf : ls )
         {
             if( pf instanceof SpamFilter )
             {
@@ -509,7 +509,7 @@ public class UserManager {
                 break;
             }
         }
-        
+
         // If container-managed auth and user not logged in, throw an error
         if ( m_engine.getAuthenticationManager().isContainerAuthenticated()
              && !context.getWikiSession().isAuthenticated() )
@@ -524,7 +524,7 @@ public class UserManager {
         // If new profile, passwords must match and can't be null
         if ( !m_engine.getAuthenticationManager().isContainerAuthenticated() )
         {
-            String password = profile.getPassword();
+            final String password = profile.getPassword();
             if ( password == null )
             {
                 if ( isNew )
@@ -534,8 +534,8 @@ public class UserManager {
             }
             else
             {
-                HttpServletRequest request = context.getHttpRequest();
-                String password2 = ( request == null ) ? null : request.getParameter( "password2" );
+                final HttpServletRequest request = context.getHttpRequest();
+                final String password2 = ( request == null ) ? null : request.getParameter( "password2" );
                 if ( !password.equals( password2 ) )
                 {
                     session.addMessage( SESSION_MESSAGES, rb.getString("security.error.passwordnomatch") );
@@ -544,9 +544,9 @@ public class UserManager {
         }
 
         UserProfile otherProfile;
-        String fullName = profile.getFullname();
-        String loginName = profile.getLoginName();
-        String email = profile.getEmail();
+        final String fullName = profile.getFullname();
+        final String loginName = profile.getLoginName();
+        final String email = profile.getEmail();
 
         // It's illegal to use as a full name someone else's login name
         try
@@ -554,11 +554,11 @@ public class UserManager {
             otherProfile = getUserDatabase().find( fullName );
             if ( otherProfile != null && !profile.equals( otherProfile ) && !fullName.equals( otherProfile.getFullname() ) )
             {
-                Object[] args = { fullName };
+                final Object[] args = { fullName };
                 session.addMessage( SESSION_MESSAGES, MessageFormat.format( rb.getString("security.error.illegalfullname"), args ) );
             }
         }
-        catch ( NoSuchPrincipalException e)
+        catch ( final NoSuchPrincipalException e)
         { /* It's clean */ }
 
         // It's illegal to use as a login name someone else's full name
@@ -567,11 +567,11 @@ public class UserManager {
             otherProfile = getUserDatabase().find( loginName );
             if ( otherProfile != null && !profile.equals( otherProfile ) && !loginName.equals( otherProfile.getLoginName() ) )
             {
-                Object[] args = { loginName };
+                final Object[] args = { loginName };
                 session.addMessage( SESSION_MESSAGES, MessageFormat.format( rb.getString("security.error.illegalloginname"), args ) );
             }
         }
-        catch ( NoSuchPrincipalException e)
+        catch ( final NoSuchPrincipalException e)
         { /* It's clean */ }
 
         // It's illegal to use multiple accounts with the same email
@@ -582,17 +582,17 @@ public class UserManager {
                 && !profile.getUid().equals(otherProfile.getUid()) // Issue JSPWIKI-1042
                 && !profile.equals( otherProfile ) && StringUtils.lowerCase( email ).equals( StringUtils.lowerCase(otherProfile.getEmail() ) ) )
             {
-                Object[] args = { email };
+                final Object[] args = { email };
                 session.addMessage( SESSION_MESSAGES, MessageFormat.format( rb.getString("security.error.email.taken"), args ) );
             }
         }
-        catch ( NoSuchPrincipalException e)
+        catch ( final NoSuchPrincipalException e)
         { /* It's clean */ }
     }
 
     /**
      *  A helper method for returning all of the known WikiNames in this system.
-     *  
+     *
      *  @return An Array of Principals
      *  @throws WikiSecurityException If for reason the names cannot be fetched
      */
@@ -614,6 +614,7 @@ public class UserManager {
          * No-op.
          * @throws WikiSecurityException never...
          */
+        @Override
         public void commit() throws WikiSecurityException
         {
             // No operation
@@ -624,6 +625,7 @@ public class UserManager {
          * @param loginName the login name to delete
          * @throws WikiSecurityException never...
          */
+        @Override
         public void deleteByLoginName( String loginName ) throws WikiSecurityException
         {
             // No operation
@@ -635,6 +637,7 @@ public class UserManager {
          * @return the user profile
          * @throws NoSuchPrincipalException never...
          */
+        @Override
         public UserProfile findByEmail(String index) throws NoSuchPrincipalException
         {
             throw new NoSuchPrincipalException("No user profiles available");
@@ -646,6 +649,7 @@ public class UserManager {
          * @return the user profile
          * @throws NoSuchPrincipalException never...
          */
+        @Override
         public UserProfile findByFullName(String index) throws NoSuchPrincipalException
         {
             throw new NoSuchPrincipalException("No user profiles available");
@@ -657,6 +661,7 @@ public class UserManager {
          * @return the user profile
          * @throws NoSuchPrincipalException never...
          */
+        @Override
         public UserProfile findByLoginName(String index) throws NoSuchPrincipalException
         {
             throw new NoSuchPrincipalException("No user profiles available");
@@ -668,6 +673,7 @@ public class UserManager {
          * @return the user profile
          * @throws NoSuchPrincipalException never...
          */
+        @Override
         public UserProfile findByUid( String uid ) throws NoSuchPrincipalException
         {
             throw new NoSuchPrincipalException("No user profiles available");
@@ -678,6 +684,7 @@ public class UserManager {
          * @return the user profile
          * @throws NoSuchPrincipalException never...
          */
+        @Override
         public UserProfile findByWikiName(String index) throws NoSuchPrincipalException
         {
             throw new NoSuchPrincipalException("No user profiles available");
@@ -688,6 +695,7 @@ public class UserManager {
          * @return a zero-length array
          * @throws WikiSecurityException never...
          */
+        @Override
         public Principal[] getWikiNames() throws WikiSecurityException
         {
             return new Principal[0];
@@ -700,6 +708,7 @@ public class UserManager {
          * @param props the properties used to initialize the wiki engine
          * @throws NoRequiredPropertyException never...
          */
+        @Override
         public void initialize(WikiEngine engine, Properties props) throws NoRequiredPropertyException
         {
         }
@@ -711,6 +720,7 @@ public class UserManager {
          * @throws DuplicateUserException never...
          * @throws WikiSecurityException never...
          */
+        @Override
         public void rename( String loginName, String newName ) throws DuplicateUserException, WikiSecurityException
         {
             throw new NoSuchPrincipalException("No user profiles available");
@@ -721,6 +731,7 @@ public class UserManager {
          * @param profile the user profile
          * @throws WikiSecurityException never...
          */
+        @Override
         public void save( UserProfile profile ) throws WikiSecurityException
         {
         }
@@ -746,8 +757,8 @@ public class UserManager {
         /**
          * Constructs a new Task for saving a user profile.
          * @param engine the wiki engine
-         * @deprecated will be removed in 2.10 scope. Consider using 
-         * {@link #SaveUserProfileTask(WikiEngine, Locale)} instead
+         * @deprecated will be removed in 2.10 scope. Consider using
+         * {@link #UserManager.SaveUserProfileTask(WikiEngine, Locale)} instead
          */
         @Deprecated
         public SaveUserProfileTask( WikiEngine engine )
@@ -757,7 +768,7 @@ public class UserManager {
             m_db = engine.getUserManager().getUserDatabase();
             m_loc = null;
         }
-        
+
         public SaveUserProfileTask( WikiEngine engine, Locale loc )
         {
             super( SAVE_TASK_MESSAGE_KEY );
@@ -772,10 +783,11 @@ public class UserManager {
          * task completed successfully
          * @throws WikiException if the save did not complete for some reason
          */
+        @Override
         public Outcome execute() throws WikiException
         {
             // Retrieve user profile
-            UserProfile profile = (UserProfile) getWorkflow().getAttribute( SAVED_PROFILE );
+            final UserProfile profile = (UserProfile) getWorkflow().getAttribute( SAVED_PROFILE );
 
             // Save the profile (userdatabase will take care of timestamps for us)
             m_db.save( profile );
@@ -785,24 +797,24 @@ public class UserManager {
             {
                 try
                 {
-                    InternationalizationManager i18n = m_engine.getInternationalizationManager();
-                    String app = m_engine.getApplicationName();
-                    String to = profile.getEmail();
-                    String subject = i18n.get( InternationalizationManager.DEF_TEMPLATE, m_loc, 
+                    final InternationalizationManager i18n = m_engine.getInternationalizationManager();
+                    final String app = m_engine.getApplicationName();
+                    final String to = profile.getEmail();
+                    final String subject = i18n.get( InternationalizationManager.DEF_TEMPLATE, m_loc,
                                                "notification.createUserProfile.accept.subject", app );
-                    
-                    String content = i18n.get( InternationalizationManager.DEF_TEMPLATE, m_loc, 
-                                               "notification.createUserProfile.accept.content", app, 
-                                               profile.getLoginName(), 
+
+                    final String content = i18n.get( InternationalizationManager.DEF_TEMPLATE, m_loc,
+                                               "notification.createUserProfile.accept.content", app,
+                                               profile.getLoginName(),
                                                profile.getFullname(),
                                                profile.getEmail(),
                                                m_engine.getURL( WikiContext.LOGIN, null, null, true ) );
                     MailUtil.sendMessage( m_engine.getWikiProperties(), to, subject, content);
                 }
-                catch ( AddressException e)
+                catch ( final AddressException e)
                 {
                 }
-                catch ( MessagingException me )
+                catch ( final MessagingException me )
                 {
                     log.error( "Could not send registration confirmation e-mail. Is the e-mail server running?", me );
                 }
@@ -850,7 +862,7 @@ public class UserManager {
             WikiEventManager.fireEvent(this,new WikiSecurityEvent(session,type,profile));
         }
     }
-    
+
     /**
      *  Implements the JSON API for usermanager.
      *  <p>
@@ -861,7 +873,7 @@ public class UserManager {
     public static final class JSONUserModule implements WikiAjaxServlet
     {
 		private volatile UserManager m_manager;
-        
+
         /**
          *  Create a new JSONUserModule.
          *  @param mgr Manager
@@ -870,12 +882,13 @@ public class UserManager {
         {
             m_manager = mgr;
         }
-        
+
         @Override
         public String getServletMapping() {
         	return JSON_USERS;
         }
-        
+
+        @Override
         public void service(HttpServletRequest req, HttpServletResponse resp, String actionName, List<String> params) throws ServletException, IOException {
         	try {
         		String uid = null;
@@ -885,14 +898,14 @@ public class UserManager {
         		uid = params.get(0);
 	        	log.debug("uid="+uid);
 	        	if (StringUtils.isNotBlank(uid)) {
-		            UserProfile prof = getUserInfo(uid);
+		            final UserProfile prof = getUserInfo(uid);
 		            resp.getWriter().write(AjaxUtil.toJson(prof));
 	        	}
-        	} catch (NoSuchPrincipalException e) {
+        	} catch (final NoSuchPrincipalException e) {
         		throw new ServletException(e);
         	}
         }
-        
+
         /**
          *  Directly returns the UserProfile object attached to an uid.
          *
@@ -905,11 +918,11 @@ public class UserManager {
         {
             if( m_manager != null )
             {
-                UserProfile prof = m_manager.getUserDatabase().find( uid );
+                final UserProfile prof = m_manager.getUserDatabase().find( uid );
 
                 return prof;
             }
-            
+
             throw new IllegalStateException("The manager is offline.");
         }
     }
diff --git a/jspwiki-war/src/main/java/org/apache/wiki/htmltowiki/ForgetNullValuesLinkedHashMap.java b/jspwiki-war/src/main/java/org/apache/wiki/htmltowiki/ForgetNullValuesLinkedHashMap.java
index ee70388..d634cee 100644
--- a/jspwiki-war/src/main/java/org/apache/wiki/htmltowiki/ForgetNullValuesLinkedHashMap.java
+++ b/jspwiki-war/src/main/java/org/apache/wiki/htmltowiki/ForgetNullValuesLinkedHashMap.java
@@ -1,4 +1,4 @@
-/* 
+/*
     Licensed to the Apache Software Foundation (ASF) under one
     or more contributor license agreements.  See the NOTICE file
     distributed with this work for additional information
@@ -14,7 +14,7 @@
     "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
     KIND, either express or implied.  See the License for the
     specific language governing permissions and limitations
-    under the License.  
+    under the License.
  */
 package org.apache.wiki.htmltowiki;
 
@@ -22,25 +22,23 @@ import java.util.LinkedHashMap;
 
 /**
  * A LinkedHashMap that does not put null values into the map.
- * 
- * @param <K> {@inheritDoc}
- * @param <V> {@inheritDoc}
- * 
+ *
  */
 public class ForgetNullValuesLinkedHashMap<K,V> extends LinkedHashMap<K,V>
 {
     private static final long serialVersionUID = 0L;
-    
+
     /**
      *  {@inheritDoc}
      */
+    @Override
     public V put( K key, V value )
     {
         if( value != null )
         {
             return super.put( key, value );
         }
-        
+
         return null;
     }
 }
diff --git a/jspwiki-war/src/main/java/org/apache/wiki/management/SimpleMBean.java b/jspwiki-war/src/main/java/org/apache/wiki/management/SimpleMBean.java
index 9d7faa8..2bd5a2e 100644
--- a/jspwiki-war/src/main/java/org/apache/wiki/management/SimpleMBean.java
+++ b/jspwiki-war/src/main/java/org/apache/wiki/management/SimpleMBean.java
@@ -14,7 +14,7 @@
     "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
     KIND, either express or implied.  See the License for the
     specific language governing permissions and limitations
-    under the License.  
+    under the License.
  */
 package org.apache.wiki.management;
 
@@ -80,8 +80,8 @@ public abstract class SimpleMBean implements DynamicMBean {
 
     /**
      *  Create a new SimpleMBean
-     *  
-     *  @throws NotCompliantMBeanException {@inheritDoc}
+     *
+     *  @throws NotCompliantMBeanException if an error occurs registering the MBean.
      */
     protected SimpleMBean() throws NotCompliantMBeanException
     {
@@ -199,14 +199,14 @@ public abstract class SimpleMBean implements DynamicMBean {
 
     /**
      *  Gets an attribute using reflection from the MBean.
-     *  
+     *
      *  @param name Name of the attribute to find.
      *  @return The value returned by the corresponding getXXX() call
      *  @throws AttributeNotFoundException If there is not such attribute
-     *  @throws MBeanException 
+     *  @throws MBeanException
      *  @throws ReflectionException
      */
-    public Object getAttribute(String name) 
+    public Object getAttribute(String name)
         throws AttributeNotFoundException, MBeanException, ReflectionException
     {
         Method m;
@@ -245,9 +245,9 @@ public abstract class SimpleMBean implements DynamicMBean {
 
     /**
      *  Gets multiple attributes at the same time.
-     *  
+     *
      *  @param arg0 The attribute names to get
-     *  @return A list of attributes 
+     *  @return A list of attributes
      */
     public AttributeList getAttributes(String[] arg0)
     {
@@ -281,7 +281,7 @@ public abstract class SimpleMBean implements DynamicMBean {
 
     /**
      *  Return the MBeanInfo structure.
-     *  
+     *
      *  @return the MBeanInfo
      */
     public MBeanInfo getMBeanInfo()
@@ -291,7 +291,7 @@ public abstract class SimpleMBean implements DynamicMBean {
 
     /**
      *  Invokes a particular method.
-     *  
+     *
      *  @param arg0 Method name
      *  @param arg1 A list of arguments for the invocation
      */
@@ -362,7 +362,7 @@ public abstract class SimpleMBean implements DynamicMBean {
     public AttributeList setAttributes(AttributeList arg0)
     {
         AttributeList result = new AttributeList();
-        for( Iterator i = arg0.iterator(); i.hasNext(); )
+        for( Iterator< Object > i = arg0.iterator(); i.hasNext(); )
         {
             Attribute attr = (Attribute)i.next();
 
diff --git a/jspwiki-war/src/main/java/org/apache/wiki/parser/LinkParsingOperations.java b/jspwiki-war/src/main/java/org/apache/wiki/parser/LinkParsingOperations.java
index c56538f..0e67464 100755
--- a/jspwiki-war/src/main/java/org/apache/wiki/parser/LinkParsingOperations.java
+++ b/jspwiki-war/src/main/java/org/apache/wiki/parser/LinkParsingOperations.java
@@ -137,7 +137,7 @@ public class LinkParsingOperations {
      * Figures out if a link is an off-site link.  This recognizes
      * the most common protocols by checking how it starts.
      *
-     * @param link The link to check.
+     * @param page The link to check.
      * @return true, if this is a link outside of this wiki.
      */
     public boolean isExternalLink( final String page ) {
diff --git a/jspwiki-war/src/main/java/org/apache/wiki/parser/ParseException.java b/jspwiki-war/src/main/java/org/apache/wiki/parser/ParseException.java
index cce29b9..6c37824 100644
--- a/jspwiki-war/src/main/java/org/apache/wiki/parser/ParseException.java
+++ b/jspwiki-war/src/main/java/org/apache/wiki/parser/ParseException.java
@@ -1,4 +1,4 @@
-/* 
+/*
     Licensed to the Apache Software Foundation (ASF) under one
     or more contributor license agreements.  See the NOTICE file
     distributed with this work for additional information
@@ -14,7 +14,7 @@
     "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
     KIND, either express or implied.  See the License for the
     specific language governing permissions and limitations
-    under the License.  
+    under the License.
  */
 package org.apache.wiki.parser;
 
@@ -23,7 +23,7 @@ import org.apache.wiki.api.exceptions.WikiException;
 /**
  *  This is an exception which gets thrown whenever the parser cannot
  *  parse the parsing things.
- *  
+ *
  */
 public class ParseException extends WikiException
 {
@@ -31,8 +31,8 @@ public class ParseException extends WikiException
 
     /**
      *  Constructs a new ParseException.
-     *  
-     *  @param msg {@inheritDoc}
+     *
+     *  @param msg the message exception.
      */
     public ParseException(String msg)
     {
diff --git a/jspwiki-war/src/main/java/org/apache/wiki/plugin/DefaultPluginManager.java b/jspwiki-war/src/main/java/org/apache/wiki/plugin/DefaultPluginManager.java
index eb48910..831324f 100644
--- a/jspwiki-war/src/main/java/org/apache/wiki/plugin/DefaultPluginManager.java
+++ b/jspwiki-war/src/main/java/org/apache/wiki/plugin/DefaultPluginManager.java
@@ -606,7 +606,7 @@ public class DefaultPluginManager extends ModuleManager implements PluginManager
         /**
          *  Initializes a plugin, if it has not yet been initialized.
          *  If the plugin extends {@link HttpServlet} it will automatically
-         *  register it as AJAX using {@link WikiAjaxDispatcherServlet.register}.
+         *  register it as AJAX using {@link WikiAjaxDispatcherServlet#registerServlet(String, WikiAjaxServlet)}.
          *
          *  @param engine The WikiEngine
          *  @param searchPath A List of Strings, containing different package names.
diff --git a/jspwiki-war/src/main/java/org/apache/wiki/providers/AbstractFileProvider.java b/jspwiki-war/src/main/java/org/apache/wiki/providers/AbstractFileProvider.java
index c0c1a81..f7eec73 100644
--- a/jspwiki-war/src/main/java/org/apache/wiki/providers/AbstractFileProvider.java
+++ b/jspwiki-war/src/main/java/org/apache/wiki/providers/AbstractFileProvider.java
@@ -1,4 +1,4 @@
-/* 
+/*
     Licensed to the Apache Software Foundation (ASF) under one
     or more contributor license agreements.  See the NOTICE file
     distributed with this work for additional information
@@ -14,7 +14,7 @@
     "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
     KIND, either express or implied.  See the License for the
     specific language governing permissions and limitations
-    under the License.  
+    under the License.
  */
 package org.apache.wiki.providers;
 
@@ -71,11 +71,11 @@ public abstract class AbstractFileProvider
 {
     private static final Logger   log = Logger.getLogger(AbstractFileProvider.class);
     private String m_pageDirectory = "/tmp/";
-    
+
     protected String m_encoding;
-    
+
     protected WikiEngine m_engine;
-    
+
     public static final String PROP_CUSTOMPROP_MAXLIMIT = "custom.pageproperty.max.allowed";
     public static final String PROP_CUSTOMPROP_MAXKEYLENGTH = "custom.pageproperty.key.length";
     public static final String PROP_CUSTOMPROP_MAXVALUELENGTH = "custom.pageproperty.value.length";
@@ -115,7 +115,7 @@ public abstract class AbstractFileProvider
     public static final String DEFAULT_ENCODING = "ISO-8859-1";
 
     private boolean m_windowsHackNeeded = false;
-    
+
     /**
      *  {@inheritDoc}
      *  @throws FileNotFoundException If the specified page directory does not exist.
@@ -156,18 +156,18 @@ public abstract class AbstractFileProvider
         m_encoding = properties.getProperty( WikiEngine.PROP_ENCODING, DEFAULT_ENCODING );
 
         String os = System.getProperty( "os.name" ).toLowerCase();
-        
+
         if( os.startsWith("windows") || os.equals("nt") )
         {
             m_windowsHackNeeded = true;
         }
-        
+
     	if (properties != null) {
             MAX_PROPLIMIT = TextUtil.getIntegerProperty(properties,PROP_CUSTOMPROP_MAXLIMIT,DEFAULT_MAX_PROPLIMIT);
             MAX_PROPKEYLENGTH = TextUtil.getIntegerProperty(properties,PROP_CUSTOMPROP_MAXKEYLENGTH,DEFAULT_MAX_PROPKEYLENGTH);
             MAX_PROPVALUELENGTH = TextUtil.getIntegerProperty(properties,PROP_CUSTOMPROP_MAXVALUELENGTH,DEFAULT_MAX_PROPVALUELENGTH);
     	}
-        
+
         log.info( "Wikipages are read from '" + m_pageDirectory + "'" );
     }
 
@@ -182,19 +182,19 @@ public abstract class AbstractFileProvider
         "con", "prn", "nul", "aux", "lpt1", "lpt2", "lpt3", "lpt4", "lpt5", "lpt6", "lpt7", "lpt8", "lpt9",
         "com1", "com2", "com3", "com4", "com5", "com6", "com7", "com8", "com9"
     };
-    
+
     /**
      *  This makes sure that the queried page name
      *  is still readable by the file system.  For example, all XML entities
      *  and slashes are encoded with the percent notation.
-     *  
+     *
      *  @param pagename The name to mangle
      *  @return The mangled name.
      */
     protected String mangleName( String pagename )
     {
         pagename = TextUtil.urlEncode( pagename, m_encoding );
-        
+
         pagename = TextUtil.replaceString( pagename, "/", "%2F" );
 
         //
@@ -205,7 +205,7 @@ public abstract class AbstractFileProvider
         {
             pagename = "%2E" + pagename.substring( 1 );
         }
-        
+
         if( m_windowsHackNeeded )
         {
             String pn = pagename.toLowerCase();
@@ -217,13 +217,13 @@ public abstract class AbstractFileProvider
                 }
             }
         }
-        
+
         return pagename;
     }
 
     /**
      *  This makes the reverse of mangleName.
-     *  
+     *
      *  @param filename The filename to unmangle
      *  @return The unmangled name.
      */
@@ -236,18 +236,18 @@ public abstract class AbstractFileProvider
             {
                 filename = filename.substring(3);
             }
-            
+
             return TextUtil.urlDecode( filename, m_encoding );
         }
-        catch( UnsupportedEncodingException e ) 
+        catch( UnsupportedEncodingException e )
         {
             throw new InternalWikiException("Faulty encoding; should never happen", e);
         }
     }
-    
+
     /**
      *  Finds a Wiki page from the page repository.
-     *  
+     *
      *  @param page The name of the page.
      *  @return A File to the page.  May be null.
      */
@@ -277,7 +277,7 @@ public abstract class AbstractFileProvider
     /**
      *  This implementation just returns the current version, as filesystem
      *  does not provide versioning information for now.
-     *  
+     *
      *  @param page {@inheritDoc}
      *  @param version {@inheritDoc}
      *  @throws {@inheritDoc}
@@ -303,7 +303,7 @@ public abstract class AbstractFileProvider
             if( pagedata.canRead() )
             {
                 try
-                {          
+                {
                     in = new FileInputStream( pagedata );
                     result = FileUtil.readContents( in, m_encoding );
                 }
@@ -333,7 +333,7 @@ public abstract class AbstractFileProvider
     /**
      *  {@inheritDoc}
      */
-    public void putPageText( WikiPage page, String text )        
+    public void putPageText( WikiPage page, String text )
         throws ProviderException
     {
         File file = findPage( page.getName() );
@@ -390,16 +390,16 @@ public abstract class AbstractFileProvider
                 log.error("Page "+wikiname+" was found in directory listing, but could not be located individually.");
                 continue;
             }
-            
+
             set.add( page );
         }
 
-        return set;        
+        return set;
     }
 
     /**
      *  Does not work.
-     *  
+     *
      *  @param date {@inheritDoc}
      *  @return {@inheritDoc}
      */
@@ -423,7 +423,7 @@ public abstract class AbstractFileProvider
     /**
      * Iterates through all WikiPages, matches them against the given query,
      * and returns a Collection of SearchResult objects.
-     * 
+     *
      * @param query {@inheritDoc}
      * @return {@inheritDoc}
      */
@@ -473,7 +473,7 @@ public abstract class AbstractFileProvider
     /**
      *  Always returns the latest version, since FileSystemProvider
      *  does not support versioning.
-     *  
+     *
      *  @param page {@inheritDoc}
      *  @param version {@inheritDoc}
      *  @return {@inheritDoc}
@@ -497,7 +497,7 @@ public abstract class AbstractFileProvider
 
     /**
      *  The FileSystemProvider provides only one version.
-     *  
+     *
      *  @param page {@inheritDoc}
      *  @throws {@inheritDoc}
      *  @return {@inheritDoc}
@@ -547,7 +547,7 @@ public abstract class AbstractFileProvider
 
     /**
      * Set the custom properties provided into the given page.
-     * 
+     *
      * @since 2.10.2
      */
     protected void setCustomProperties(WikiPage page, Properties properties) {
@@ -561,9 +561,9 @@ public abstract class AbstractFileProvider
     }
 
     /**
-     * Get custom properties using {@link this.addCustomPageProperties}, validate them using {@link this.validateCustomPageProperties}
+     * Get custom properties using {@link #addCustomProperties(WikiPage, Properties)}, validate them using {@link #validateCustomPageProperties(Properties)}
      * and add them to default properties provided
-     * 
+     *
      * @since 2.10.2
      */
     protected void getCustomProperties(WikiPage page, Properties defaultProperties) throws IOException {
@@ -571,16 +571,16 @@ public abstract class AbstractFileProvider
     	validateCustomPageProperties(customPageProperties);
     	defaultProperties.putAll(customPageProperties);
     }
-    
+
     /**
      * By default all page attributes that start with "@" are returned as custom properties.
      * This can be overwritten by custom FileSystemProviders to save additional properties.
-     * CustomPageProperties are validated by {@link this.validateCustomPageProperties}
-     * 
+     * CustomPageProperties are validated by {@link #validateCustomPageProperties(Properties)}
+     *
      * @since 2.10.2
      * @param page the current page
      * @param props the default properties of this page
-     * @return default implementation returns empty Properties. 
+     * @return default implementation returns empty Properties.
      */
     protected Properties addCustomProperties(WikiPage page, Properties props) {
     	Properties customProperties = new Properties();
@@ -592,11 +592,11 @@ public abstract class AbstractFileProvider
     				customProperties.put(key,value.toString());
     			}
     		}
-    		
+
     	}
     	return customProperties;
     }
-    
+
     /**
      * Default validation, validates that key and value is ASCII <code>StringUtils.isAsciiPrintable()</code> and within lengths set up in jspwiki-custom.properties.
      * This can be overwritten by custom FileSystemProviders to validate additional properties
diff --git a/jspwiki-war/src/main/java/org/apache/wiki/providers/NoSuchVersionException.java b/jspwiki-war/src/main/java/org/apache/wiki/providers/NoSuchVersionException.java
index db5df86..0c4919f 100644
--- a/jspwiki-war/src/main/java/org/apache/wiki/providers/NoSuchVersionException.java
+++ b/jspwiki-war/src/main/java/org/apache/wiki/providers/NoSuchVersionException.java
@@ -1,4 +1,4 @@
-/* 
+/*
     Licensed to the Apache Software Foundation (ASF) under one
     or more contributor license agreements.  See the NOTICE file
     distributed with this work for additional information
@@ -14,7 +14,7 @@
     "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
     KIND, either express or implied.  See the License for the
     specific language governing permissions and limitations
-    under the License.  
+    under the License.
  */
 package org.apache.wiki.providers;
 
@@ -27,11 +27,11 @@ public class NoSuchVersionException
     extends ProviderException
 {
     private static final long serialVersionUID = 0L;
-    
+
     /**
      *  Creates a ProviderException.
-     *  
-     *  @param msg {@inheritDoc}
+     *
+     *  @param msg the exception message.
      */
     public NoSuchVersionException( String msg )
     {
diff --git a/jspwiki-war/src/main/java/org/apache/wiki/render/CleanTextRenderer.java b/jspwiki-war/src/main/java/org/apache/wiki/render/CleanTextRenderer.java
index 7379372..fedff17 100644
--- a/jspwiki-war/src/main/java/org/apache/wiki/render/CleanTextRenderer.java
+++ b/jspwiki-war/src/main/java/org/apache/wiki/render/CleanTextRenderer.java
@@ -1,4 +1,4 @@
-/* 
+/*
     Licensed to the Apache Software Foundation (ASF) under one
     or more contributor license agreements.  See the NOTICE file
     distributed with this work for additional information
@@ -14,7 +14,7 @@
     "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
     KIND, either express or implied.  See the License for the
     specific language governing permissions and limitations
-    under the License.  
+    under the License.
  */
 package org.apache.wiki.render;
 
@@ -30,48 +30,46 @@ import org.jdom2.Text;
 import org.jdom2.xpath.XPath;
 
 /**
- *  A simple renderer that just renders all the text() nodes
- *  from the DOM tree.  This is very useful for cleaning away
- *  all of the XHTML.
- *  
+ *  A simple renderer that just renders all the text() nodes from the DOM tree.
+ *  This is very useful for cleaning away all of the XHTML.
+ *
  *  @since  2.4
  */
 public class CleanTextRenderer
     extends WikiRenderer
 {
     private static final String ALL_TEXT_NODES = "//text()";
-    
+
     protected static final Logger log = Logger.getLogger( CleanTextRenderer.class );
-    
+
     /**
      *  Create a renderer.
-     *  
-     *  @param context {@inheritDoc}
-     *  @param doc {@inheritDoc}
+     *
+     *  @param context A WikiContext in which the rendering will take place.
+     *  @param doc The WikiDocument which shall be rendered.
      */
     public CleanTextRenderer( WikiContext context, WikiDocument doc )
     {
         super( context, doc );
     }
-    
+
     /**
      *  {@inheritDoc}
      */
-    public String getString()
-        throws IOException
+    public String getString() throws IOException
     {
     	StringBuilder sb = new StringBuilder();
-        
+
         try
         {
             XPath xp = XPath.newInstance( ALL_TEXT_NODES );
-        
+
             List nodes = xp.selectNodes(m_document.getDocument());
-            
+
             for( Iterator i = nodes.iterator(); i.hasNext(); )
             {
                 Object el = i.next();
-                
+
                 if( el instanceof Text )
                 {
                     sb.append( ((Text)el).getValue() );
@@ -83,7 +81,7 @@ public class CleanTextRenderer
             log.error("Could not parse XPATH expression");
             throw new IOException( e.getMessage() );
         }
-    
+
         return sb.toString();
     }
 }
diff --git a/jspwiki-war/src/main/java/org/apache/wiki/render/WysiwygEditingRenderer.java b/jspwiki-war/src/main/java/org/apache/wiki/render/WysiwygEditingRenderer.java
index bc42aeb..74b07e5 100644
--- a/jspwiki-war/src/main/java/org/apache/wiki/render/WysiwygEditingRenderer.java
+++ b/jspwiki-war/src/main/java/org/apache/wiki/render/WysiwygEditingRenderer.java
@@ -52,8 +52,8 @@ public class WysiwygEditingRenderer
     /**
      *  Creates a WYSIWYG editing renderer.
      *
-     *  @param context {@inheritDoc}
-     *  @param doc {@inheritDoc}
+     *  @param context A WikiContext in which the rendering will take place.
+     *  @param doc The WikiDocument which shall be rendered.
      */
     public WysiwygEditingRenderer( WikiContext context, WikiDocument doc )
     {
diff --git a/jspwiki-war/src/main/java/org/apache/wiki/render/XHTMLRenderer.java b/jspwiki-war/src/main/java/org/apache/wiki/render/XHTMLRenderer.java
index eae4634..b54fe02 100644
--- a/jspwiki-war/src/main/java/org/apache/wiki/render/XHTMLRenderer.java
+++ b/jspwiki-war/src/main/java/org/apache/wiki/render/XHTMLRenderer.java
@@ -1,4 +1,4 @@
-/* 
+/*
     Licensed to the Apache Software Foundation (ASF) under one
     or more contributor license agreements.  See the NOTICE file
     distributed with this work for additional information
@@ -14,7 +14,7 @@
     "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
     KIND, either express or implied.  See the License for the
     specific language governing permissions and limitations
-    under the License.  
+    under the License.
  */
 package org.apache.wiki.render;
 
@@ -31,25 +31,25 @@ import org.apache.wiki.parser.WikiDocument;
  *  Implements a WikiRendered that outputs XHTML.  Because the internal DOM
  *  representation is in XHTML already, this just basically dumps out everything
  *  out in a non-prettyprinted format.
- *  
+ *
  *  @since  2.4
  */
 public class XHTMLRenderer
-    extends WikiRenderer 
+    extends WikiRenderer
 {
     private static final String LINEBREAK = "\n";
 
     /**
      *  Creates an XHTML 1.0 renderer.
-     *  
-     *  @param context {@inheritDoc}
-     *  @param doc {@inheritDoc}
+     *
+     *  @param context A WikiContext in which the rendering will take place.
+     *  @param doc The WikiDocument which shall be rendered.
      */
     public XHTMLRenderer( WikiContext context, WikiDocument doc )
     {
         super( context, doc );
     }
-    
+
     /**
      *  {@inheritDoc}
      */
@@ -60,16 +60,16 @@ public class XHTMLRenderer
 
         CustomXMLOutputProcessor processor = new CustomXMLOutputProcessor();
         XMLOutputter output = new XMLOutputter(processor);
-        
+
         StringWriter out = new StringWriter();
-        
+
         Format fmt = Format.getRawFormat();
         fmt.setExpandEmptyElements( false );
         fmt.setLineSeparator( LINEBREAK );
 
         output.setFormat( fmt );
         output.outputElementContent( m_document.getRootElement(), out );
-        
+
         String result = out.toString();
         return result;
     }
diff --git a/jspwiki-war/src/main/java/org/apache/wiki/rss/RSS10Feed.java b/jspwiki-war/src/main/java/org/apache/wiki/rss/RSS10Feed.java
index f02d63e..fe4dec4 100644
--- a/jspwiki-war/src/main/java/org/apache/wiki/rss/RSS10Feed.java
+++ b/jspwiki-war/src/main/java/org/apache/wiki/rss/RSS10Feed.java
@@ -1,4 +1,4 @@
-/* 
+/*
     Licensed to the Apache Software Foundation (ASF) under one
     or more contributor license agreements.  See the NOTICE file
     distributed with this work for additional information
@@ -14,7 +14,7 @@
     "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
     KIND, either express or implied.  See the License for the
     specific language governing permissions and limitations
-    under the License.  
+    under the License.
  */
 package org.apache.wiki.rss;
 
@@ -35,7 +35,7 @@ import org.jdom2.Namespace;
  * <A HREF="http://usemod.com/cgi-bin/mb.pl?ModWiki">UseMod:ModWiki</A>.
  */
 public class RSS10Feed extends Feed {
-    
+
     private static final Namespace NS_XMNLS = Namespace.getNamespace( "http://purl.org/rss/1.0/" );
     private static final Namespace NS_RDF = Namespace.getNamespace( "rdf", "http://www.w3.org/1999/02/22-rdf-syntax-ns#" );
     private static final Namespace NS_DC = Namespace.getNamespace( "dc", "http://purl.org/dc/elements/1.1/" );
@@ -44,7 +44,7 @@ public class RSS10Feed extends Feed {
     /**
      * Create an RSS 1.0 feed for a given context.
      *
-     * @param context {@inheritDoc}
+     * @param context The WikiContext.
      */
     public RSS10Feed( WikiContext context ) {
         super( context );
@@ -96,7 +96,7 @@ public class RSS10Feed extends Feed {
             cal.setTime(p.getLastModified());
             cal.add( Calendar.MILLISECOND,
                     - ( cal.get( Calendar.ZONE_OFFSET ) +
-                             ( cal.getTimeZone().inDaylightTime( p.getLastModified() ) ? cal.get( Calendar.DST_OFFSET ) 
+                             ( cal.getTimeZone().inDaylightTime( p.getLastModified() ) ? cal.get( Calendar.DST_OFFSET )
                                                                                        : 0 ) ) );
 
             item.addContent( new Element( "date", NS_DC ).addContent( iso8601fmt.format( cal.getTime() ) ) );
@@ -116,7 +116,7 @@ public class RSS10Feed extends Feed {
             if( m_wikiContext.getEngine().pageExists(author) ) {
                 description.setAttribute( "link", engine.getURL( WikiContext.VIEW, author, null, true ), NS_XMNLS );
             }
-            
+
             description.addContent( new Element("value", NS_XMNLS).addContent( author) );
             contributor.addContent( description );
            */
@@ -161,7 +161,7 @@ public class RSS10Feed extends Feed {
      */
     @Override
     public String getString() {
-        Element root = new Element( "RDF", NS_RDF ); 
+        Element root = new Element( "RDF", NS_RDF );
         root.addContent( getChannelElement() );
         root.addNamespaceDeclaration( NS_XMNLS );
         root.addNamespaceDeclaration( NS_RDF );

-- 
To stop receiving notification emails like this one, please contact
juanpablo@apache.org.

Mime
View raw message