Author: jalkanen
Date: Wed Jun 25 14:17:27 2008
New Revision: 671664
URL: http://svn.apache.org/viewvc?rev=671664&view=rev
Log:
Fixed a bunch of CheckStyle warnings - note that some previously public static
strings were made private. This is in the principle of information hiding -
there isn't much use for everybody to use them, since they're already
documented elsewhere.
Modified:
incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/parser/CreoleToJSPWikiTranslator.java
incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/parser/JSPWikiMarkupParser.java
incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/plugin/BugReportHandler.java
incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/plugin/Denounce.java
incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/plugin/Image.java
incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/plugin/IndexPlugin.java
incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/plugin/InsertPage.java
incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/plugin/Note.java
incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/plugin/WeblogArchivePlugin.java
incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/plugin/WeblogEntryPlugin.java
incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/plugin/WeblogPlugin.java
Modified:
incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/parser/CreoleToJSPWikiTranslator.java
URL:
http://svn.apache.org/viewvc/incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/parser/CreoleToJSPWikiTranslator.java?rev=671664&r1=671663&r2=671664&view=diff
==============================================================================
---
incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/parser/CreoleToJSPWikiTranslator.java
(original)
+++
incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/parser/CreoleToJSPWikiTranslator.java
Wed Jun 25 14:17:27 2008
@@ -64,12 +64,16 @@
// [{$creolepagefilter.creoleversion}]
// [{$creolepagefilter.linebreak}] -> bloglike/wikilike
+ /** The version of the filter. */
public static final String VAR_VERSION = "1.0.3";
+ /** The version of Creole that this filter supports. */
public static final String VAR_CREOLE_VERSION = "1.0";
+ /** The linebreak style "bloglike". */
public static final String VAR_LINEBREAK_BLOGLIKE = "bloglike";
+ /** The linebreak style "c2like". */
public static final String VAR_LINEBREAK_C2LIKE = "c2like";
private static final String CREOLE_BOLD =
"\\*\\*((?s:.)*?)(\\*\\*|(\n\n|\r\r|\r\n\r\n))";
@@ -167,6 +171,14 @@
private ArrayList<String> m_hashList = new ArrayList<String>();
+ /**
+ * I have no idea what this method does. Could someone please tell me?
+ *
+ * @param wikiProps A property set
+ * @param content The content to translate?
+ * @param username The username in the signature?
+ * @return Probably some translated content.
+ */
public String translateSignature(Properties wikiProps, final String
content, String username)
{
@@ -199,7 +211,13 @@
return result;
}
- /** Translates Creole markup to JSPWiki markup */
+ /**
+ * Translates Creole markup to JSPWiki markup
+ *
+ * @param wikiProps A set of Wiki Properties
+ * @param content Creole markup
+ * @return Wiki markup
+ */
public String translate(Properties wikiProps, final String content)
{
boolean blogLineBreaks = false;
@@ -357,7 +375,7 @@
* the protected markup with the the md5 hash of the markup.
*
* @param content
- * @return
+ * @return The content with protection
*/
private String protectMarkup(String content)
{
Modified:
incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/parser/JSPWikiMarkupParser.java
URL:
http://svn.apache.org/viewvc/incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/parser/JSPWikiMarkupParser.java?rev=671664&r1=671663&r2=671664&view=diff
==============================================================================
---
incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/parser/JSPWikiMarkupParser.java
(original)
+++
incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/parser/JSPWikiMarkupParser.java
Wed Jun 25 14:17:27 2008
@@ -894,7 +894,7 @@
* entities that are already escaped).
*
* @param buf
- * @return
+ * @return An escaped string.
*/
private String escapeHTMLEntities(String buf)
{
@@ -1250,7 +1250,7 @@
* What a crappy problem.
*
* @param url
- * @return
+ * @return An anchor Element containing the link.
*/
private Element makeDirectURILink( String url )
{
@@ -2278,7 +2278,7 @@
/**
* Handles constructs of type %%(style) and %%class
* @param newLine
- * @return
+ * @return An Element containing the div or span, depending on the
situation.
* @throws IOException
*/
private Element handleDiv( boolean newLine )
Modified:
incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/plugin/BugReportHandler.java
URL:
http://svn.apache.org/viewvc/incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/plugin/BugReportHandler.java?rev=671664&r1=671663&r2=671664&view=diff
==============================================================================
--- incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/plugin/BugReportHandler.java
(original)
+++ incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/plugin/BugReportHandler.java
Wed Jun 25 14:17:27 2008
@@ -50,14 +50,17 @@
{
private static Logger log = Logger.getLogger( BugReportHandler.class );
- public static final String TITLE = "title";
- public static final String DESCRIPTION = "description";
- public static final String VERSION = "version";
- public static final String MAPPINGS = "map";
- public static final String PAGE = "page";
+ private static final String TITLE = "title";
+ private static final String DESCRIPTION = "description";
+ private static final String VERSION = "version";
+ private static final String MAPPINGS = "map";
+ private static final String PAGE = "page";
- public static final String DEFAULT_DATEFORMAT = "dd-MMM-yyyy HH:mm:ss zzz";
+ private static final String DEFAULT_DATEFORMAT = "dd-MMM-yyyy HH:mm:ss
zzz";
+ /**
+ * [EMAIL PROTECTED]
+ */
public String execute( WikiContext context, Map params )
throws PluginException
{
Modified: incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/plugin/Denounce.java
URL:
http://svn.apache.org/viewvc/incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/plugin/Denounce.java?rev=671664&r1=671663&r2=671664&view=diff
==============================================================================
--- incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/plugin/Denounce.java
(original)
+++ incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/plugin/Denounce.java Wed Jun
25 14:17:27 2008
@@ -43,15 +43,15 @@
{
private static Logger log = Logger.getLogger(Denounce.class);
- public static final String PARAM_LINK = "link";
- public static final String PARAM_TEXT = "text";
+ private static final String PARAM_LINK = "link";
+ private static final String PARAM_TEXT = "text";
- public static final String PROPERTYFILE =
"com/ecyrd/jspwiki/plugin/denounce.properties";
- public static final String PROP_AGENTPATTERN = "denounce.agentpattern.";
- public static final String PROP_HOSTPATTERN = "denounce.hostpattern.";
- public static final String PROP_REFERERPATTERN =
"denounce.refererpattern.";
+ private static final String PROPERTYFILE =
"com/ecyrd/jspwiki/plugin/denounce.properties";
+ private static final String PROP_AGENTPATTERN = "denounce.agentpattern.";
+ private static final String PROP_HOSTPATTERN = "denounce.hostpattern.";
+ private static final String PROP_REFERERPATTERN =
"denounce.refererpattern.";
- public static final String PROP_DENOUNCETEXT = "denounce.denouncetext";
+ private static final String PROP_DENOUNCETEXT = "denounce.denouncetext";
private static ArrayList<Pattern> c_refererPatterns = new
ArrayList<Pattern>();
private static ArrayList<Pattern> c_agentPatterns = new
ArrayList<Pattern>();
Modified: incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/plugin/Image.java
URL:
http://svn.apache.org/viewvc/incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/plugin/Image.java?rev=671664&r1=671663&r2=671664&view=diff
==============================================================================
--- incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/plugin/Image.java (original)
+++ incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/plugin/Image.java Wed Jun 25
14:17:27 2008
@@ -38,18 +38,18 @@
public class Image
implements WikiPlugin
{
- public static final String PARAM_SRC = "src";
- public static final String PARAM_ALIGN = "align";
- public static final String PARAM_HEIGHT = "height";
- public static final String PARAM_WIDTH = "width";
- public static final String PARAM_ALT = "alt";
- public static final String PARAM_CAPTION = "caption";
- public static final String PARAM_LINK = "link";
- public static final String PARAM_TARGET = "target";
- public static final String PARAM_STYLE = "style";
- public static final String PARAM_CLASS = "class";
+ private static final String PARAM_SRC = "src";
+ private static final String PARAM_ALIGN = "align";
+ private static final String PARAM_HEIGHT = "height";
+ private static final String PARAM_WIDTH = "width";
+ private static final String PARAM_ALT = "alt";
+ private static final String PARAM_CAPTION = "caption";
+ private static final String PARAM_LINK = "link";
+ private static final String PARAM_TARGET = "target";
+ private static final String PARAM_STYLE = "style";
+ private static final String PARAM_CLASS = "class";
// public static final String PARAM_MAP = "map";
- public static final String PARAM_BORDER = "border";
+ private static final String PARAM_BORDER = "border";
/**
* This method is used to clean away things like quotation marks which
@@ -60,6 +60,9 @@
return TextUtil.replaceEntities( (String) params.get( paramId ) );
}
+ /**
+ * [EMAIL PROTECTED]
+ */
public String execute( WikiContext context, Map params )
throws PluginException
{
Modified: incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/plugin/IndexPlugin.java
URL:
http://svn.apache.org/viewvc/incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/plugin/IndexPlugin.java?rev=671664&r1=671663&r2=671664&view=diff
==============================================================================
--- incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/plugin/IndexPlugin.java
(original)
+++ incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/plugin/IndexPlugin.java Wed
Jun 25 14:17:27 2008
@@ -114,7 +114,7 @@
/**
* Create the DOM for a heading
* @param initialChar
- * @return
+ * @return A span element.
*/
private Element makeHeader( char initialChar )
{
@@ -131,7 +131,7 @@
* @param context
* @param include
* @param exclude
- * @return
+ * @return A list containing page names which matched the filters.
* @throws ProviderException
*/
private List<String> listPages( WikiContext context, String include,
String exclude )
Modified: incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/plugin/InsertPage.java
URL:
http://svn.apache.org/viewvc/incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/plugin/InsertPage.java?rev=671664&r1=671663&r2=671664&view=diff
==============================================================================
--- incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/plugin/InsertPage.java
(original)
+++ incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/plugin/InsertPage.java Wed
Jun 25 14:17:27 2008
@@ -35,17 +35,23 @@
public class InsertPage
implements WikiPlugin
{
- public static final String PARAM_PAGENAME = "page";
- public static final String PARAM_STYLE = "style";
- public static final String PARAM_MAXLENGTH = "maxlength";
- public static final String PARAM_CLASS = "class";
- public static final String PARAM_SECTION = "section";
- public static final String PARAM_DEFAULT = "default";
+ private static final String PARAM_PAGENAME = "page";
+ private static final String PARAM_STYLE = "style";
+ private static final String PARAM_MAXLENGTH = "maxlength";
+ private static final String PARAM_CLASS = "class";
+ private static final String PARAM_SECTION = "section";
+ private static final String PARAM_DEFAULT = "default";
private static final String DEFAULT_STYLE = "";
+ /** This attribute is stashed in the WikiContext to make sure that we don't
+ * have circular references.
+ */
public static final String ATTR_RECURSE =
"com.ecyrd.jspwiki.plugin.InsertPage.recurseCheck";
+ /**
+ * [EMAIL PROTECTED]
+ */
@SuppressWarnings("unchecked")
public String execute( WikiContext context, Map params )
throws PluginException
Modified: incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/plugin/Note.java
URL:
http://svn.apache.org/viewvc/incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/plugin/Note.java?rev=671664&r1=671663&r2=671664&view=diff
==============================================================================
--- incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/plugin/Note.java (original)
+++ incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/plugin/Note.java Wed Jun 25
14:17:27 2008
@@ -93,7 +93,6 @@
* Cleans the side.
*
* @param commandline
- * @return
*/
private String clean(String commandline)
{
Modified:
incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/plugin/WeblogArchivePlugin.java
URL:
http://svn.apache.org/viewvc/incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/plugin/WeblogArchivePlugin.java?rev=671664&r1=671663&r2=671664&view=diff
==============================================================================
---
incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/plugin/WeblogArchivePlugin.java
(original)
+++
incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/plugin/WeblogArchivePlugin.java
Wed Jun 25 14:17:27 2008
@@ -36,10 +36,13 @@
{
private static Logger log =
Logger.getLogger(WeblogArchivePlugin.class);
- public static final String PARAM_PAGE = "page";
+ private static final String PARAM_PAGE = "page";
private SimpleDateFormat m_monthUrlFormat;
+ /**
+ * [EMAIL PROTECTED]
+ */
public String execute( WikiContext context, Map params )
throws PluginException
{
Modified:
incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/plugin/WeblogEntryPlugin.java
URL:
http://svn.apache.org/viewvc/incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/plugin/WeblogEntryPlugin.java?rev=671664&r1=671663&r2=671664&view=diff
==============================================================================
--- incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/plugin/WeblogEntryPlugin.java
(original)
+++ incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/plugin/WeblogEntryPlugin.java
Wed Jun 25 14:17:27 2008
@@ -36,9 +36,9 @@
{
private static Logger log = Logger.getLogger(WeblogEntryPlugin.class);
- public static final int MAX_BLOG_ENTRIES = 10000; // Just a precaution.
+ private static final int MAX_BLOG_ENTRIES = 10000; // Just a precaution.
- public static final String PARAM_ENTRYTEXT = "entrytext";
+ private static final String PARAM_ENTRYTEXT = "entrytext";
/**
* Optional parameter: page that actually contains the blog.
* This lets us provide a "new entry" link for a blog page
@@ -47,6 +47,15 @@
// "page" for uniform naming with WeblogPlugin...
public static final String PARAM_BLOGNAME = "page";
+ /**
+ * Returns a new page name for entries. It goes through the list of
+ * all blog pages, and finds out the next in line.
+ *
+ * @param engine A WikiEngine
+ * @param blogName The page (or blog) name.
+ * @return A new name.
+ * @throws ProviderException If something goes wrong.
+ */
public String getNewEntryPage( WikiEngine engine, String blogName )
throws ProviderException
{
@@ -65,6 +74,9 @@
return blogPage;
}
+ /**
+ * [EMAIL PROTECTED]
+ */
public String execute( WikiContext context, Map params )
throws PluginException
{
Modified: incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/plugin/WeblogPlugin.java
URL:
http://svn.apache.org/viewvc/incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/plugin/WeblogPlugin.java?rev=671664&r1=671663&r2=671664&view=diff
==============================================================================
--- incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/plugin/WeblogPlugin.java
(original)
+++ incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/plugin/WeblogPlugin.java Wed
Jun 25 14:17:27 2008
@@ -78,29 +78,41 @@
implements WikiPlugin, ParserStagePlugin
{
private static Logger log = Logger.getLogger(WeblogPlugin.class);
- private static final Pattern headingPattern;
+ private static final Pattern HEADINGPATTERN;
/** How many days are considered by default. Default value is [EMAIL
PROTECTED] */
- public static final int DEFAULT_DAYS = 7;
- public static final String DEFAULT_PAGEFORMAT = "%p_blogentry_";
+ private static final int DEFAULT_DAYS = 7;
+ private static final String DEFAULT_PAGEFORMAT = "%p_blogentry_";
- public static final String DEFAULT_DATEFORMAT = "ddMMyy";
+ /** The default date format used in the blog entry page names. */
+ public static final String DEFAULT_DATEFORMAT = "ddMMyy";
- public static final String PARAM_STARTDATE = "startDate";
- public static final String PARAM_ENTRYFORMAT = "entryFormat";
- public static final String PARAM_DAYS = "days";
- public static final String PARAM_ALLOWCOMMENTS = "allowComments";
- public static final String PARAM_MAXENTRIES = "maxEntries";
- public static final String PARAM_PAGE = "page";
+ private static final String PARAM_STARTDATE = "startDate";
+ private static final String PARAM_ENTRYFORMAT = "entryFormat";
+ private static final String PARAM_DAYS = "days";
+ private static final String PARAM_ALLOWCOMMENTS = "allowComments";
+ private static final String PARAM_MAXENTRIES = "maxEntries";
+ private static final String PARAM_PAGE = "page";
+ /** The attribute which is stashed to the WikiPage attributes to check if
a page
+ * is a weblog or not. You may check for its presence.
+ */
public static final String ATTR_ISWEBLOG = "weblogplugin.isweblog";
static
{
// This is a pretty ugly, brute-force regex. But it will do for now...
- headingPattern = Pattern.compile("(<h[1-4].*>)(.*)(</h[1-4]>)",
Pattern.CASE_INSENSITIVE);
+ HEADINGPATTERN = Pattern.compile("(<h[1-4].*>)(.*)(</h[1-4]>)",
Pattern.CASE_INSENSITIVE);
}
+ /**
+ * Create an entry name based on the blogname, a date, and an entry
number.
+ *
+ * @param pageName Name of the blog
+ * @param date The date (in ddMMyy format)
+ * @param entryNum The entry number.
+ * @return A formatted page name.
+ */
public static String makeEntryPage( String pageName,
String date,
String entryNum )
@@ -108,16 +120,32 @@
return
TextUtil.replaceString(DEFAULT_PAGEFORMAT,"%p",pageName)+date+"_"+entryNum;
}
+ /**
+ * Return just the basename for entires without date and entry numebr.
+ *
+ * @param pageName The name of the blog.
+ * @return A formatted name.
+ */
public static String makeEntryPage( String pageName )
{
return TextUtil.replaceString(DEFAULT_PAGEFORMAT,"%p",pageName);
}
+ /**
+ * Returns the entry page without the entry number.
+ *
+ * @param pageName Blog name.
+ * @param date The date.
+ * @return A base name for the blog entries.
+ */
public static String makeEntryPage( String pageName, String date )
{
return TextUtil.replaceString(DEFAULT_PAGEFORMAT,"%p",pageName)+date;
}
+ /**
+ * [EMAIL PROTECTED]
+ */
@SuppressWarnings("unchecked")
public String execute( WikiContext context, Map params )
throws PluginException
@@ -296,7 +324,7 @@
// Extract the first h1/h2/h3 as title, and replace with null
buffer.append("<div class=\"weblogentrytitle\">\n");
- Matcher matcher = headingPattern.matcher( html );
+ Matcher matcher = HEADINGPATTERN.matcher( html );
if ( matcher.find() )
{
String title = matcher.group(2);
