You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@jspwiki.apache.org by ju...@apache.org on 2020/01/16 23:07:35 UTC
[jspwiki] 15/26: apply suggested intellij format
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
commit a08cf8ab37a26feff02f8247b97a25a4adcc1144
Author: juanpablo <ju...@apache.org>
AuthorDate: Tue Jan 14 00:44:54 2020 +0100
apply suggested intellij format
---
.../org/apache/wiki/event/PageEventFilter.java | 96 ++++++++--------------
.../java/org/apache/wiki/event/WikiEventUtils.java | 4 +-
.../java/org/apache/wiki/event/WikiPageEvent.java | 18 ++--
.../main/java/org/apache/wiki/rss/AtomFeed.java | 46 ++++-------
4 files changed, 61 insertions(+), 103 deletions(-)
diff --git a/jspwiki-main/src/main/java/org/apache/wiki/event/PageEventFilter.java b/jspwiki-main/src/main/java/org/apache/wiki/event/PageEventFilter.java
index ff26c5a..d957466 100644
--- a/jspwiki-main/src/main/java/org/apache/wiki/event/PageEventFilter.java
+++ b/jspwiki-main/src/main/java/org/apache/wiki/event/PageEventFilter.java
@@ -28,10 +28,8 @@ import java.util.Properties;
/**
* Fires WikiPageEvents for page events.
* <p>
- * Adding a PageEventFilter to the FilterManager will automatically
- * attach an event delegate with the WikiEventManager to provide for
- * firing and listener management. All that remains is then adding
- * the listener to the filter via the WikiEventManager. This is quite
+ * Adding a PageEventFilter to the FilterManager will automatically attach an event delegate with the WikiEventManager to provide for
+ * firing and listener management. All that remains is then adding the listener to the filter via the WikiEventManager. This is quite
* simple:
* </p>
* <pre>
@@ -41,48 +39,38 @@ import java.util.Properties;
* WikiEventManager.addWikiEventListener(filter,listener);
* </pre>
* <p>
- * This class provides convenience methods for adding and removing
- * WikiEventListeners.
+ * This class provides convenience methods for adding and removing WikiEventListeners.
* </p>
*
* @see org.apache.wiki.event.WikiEventManager
*/
-public class PageEventFilter extends BasicPageFilter
-{
+public class PageEventFilter extends BasicPageFilter {
/**
- * Called whenever a new PageFilter is instantiated and reset.
- */
- public void initialize( Properties properties )
- throws FilterException
- {
+ * Called whenever a new PageFilter is instantiated and reset.
+ */
+ public void initialize( final Properties properties ) throws FilterException {
//
}
/**
- * This method is called whenever a page has been loaded from the provider,
- * but not yet been sent through the TranslatorReader. Note that you cannot
- * do HTML translation here, because TranslatorReader is likely to escape it.
- *
- * @param wikiContext The current wikicontext.
- * @param content WikiMarkup.
- */
- public String preTranslate( WikiContext wikiContext, String content )
- throws FilterException
- {
+ * This method is called whenever a page has been loaded from the provider, but not yet been sent through the TranslatorReader.
+ * Note that you cannot do HTML translation here, because TranslatorReader is likely to escape it.
+ *
+ * @param wikiContext The current wikicontext.
+ * @param content WikiMarkup.
+ */
+ public String preTranslate( final WikiContext wikiContext, final String content ) {
fireEvent( WikiPageEvent.PRE_TRANSLATE, wikiContext );
return content;
}
/**
- * This method is called after a page has been fed through the TranslatorReader,
- * so anything you are seeing here is translated content. If you want to
- * do any of your own WikiMarkup2HTML translation, do it here.
- */
- public String postTranslate( WikiContext wikiContext, String htmlContent )
- throws FilterException
- {
+ * This method is called after a page has been fed through the TranslatorReader, so anything you are seeing here is translated content.
+ * If you want to do any of your own WikiMarkup2HTML translation, do it here.
+ */
+ public String postTranslate( final WikiContext wikiContext, final String htmlContent ) {
fireEvent( WikiPageEvent.POST_TRANSLATE, wikiContext );
return htmlContent;
}
@@ -91,74 +79,56 @@ public class PageEventFilter extends BasicPageFilter
/**
* This method is called before the page has been saved to the PageProvider.
*/
- public String preSave( WikiContext wikiContext, String content )
- throws FilterException
- {
+ public String preSave( final WikiContext wikiContext, final String content ) {
fireEvent( WikiPageEvent.PRE_SAVE, wikiContext );
return content;
}
/**
- * This method is called after the page has been successfully saved.
- * If the saving fails for any reason, then this method will not
+ * This method is called after the page has been successfully saved. If the saving fails for any reason, then this method will not
* be called.
* <p>
- * Since the result is discarded from this method, this is only useful
- * for things like counters, etc.
+ * Since the result is discarded from this method, this is only useful for things like counters, etc.
*/
- public void postSave( WikiContext wikiContext, String content )
- throws FilterException
- {
+ public void postSave( final WikiContext wikiContext, final String content ) {
fireEvent( WikiPageEvent.POST_SAVE, wikiContext );
}
// events processing .......................................................
-
/**
- * Registers a WikiEventListener with this instance.
- * This is a convenience method.
+ * Registers a WikiEventListener with this instance. This is a convenience method.
*
* @param listener the event listener
*/
- public final synchronized void addWikiEventListener( WikiEventListener listener )
- {
+ public final synchronized void addWikiEventListener( final WikiEventListener listener ) {
WikiEventManager.addWikiEventListener( this, listener );
}
/**
- * Un-registers a WikiEventListener with this instance.
- * This is a convenience method.
+ * Un-registers a WikiEventListener with this instance. This is a convenience method.
*
* @param listener the event listener
*/
- public final synchronized void removeWikiEventListener( WikiEventListener listener )
- {
+ public final synchronized void removeWikiEventListener( final WikiEventListener listener ) {
WikiEventManager.removeWikiEventListener( this, listener );
}
/**
- * Fires a WikiPageEvent of the provided type and page name
- * to all registered listeners. Only <tt>PAGE_LOCK</tt> and
- * <tt>PAGE_UNLOCK</tt> event types will fire an event; other
- * event types are ignored.
+ * Fires a WikiPageEvent of the provided type and page name to all registered listeners. Only <tt>PAGE_LOCK</tt> and
+ * <tt>PAGE_UNLOCK</tt> event types will fire an event; other event types are ignored.
*
* @see org.apache.wiki.event.WikiPageEvent
* @param type the WikiPageEvent type to be fired.
* @param context the WikiContext of the event.
*/
- protected final void fireEvent( int type, WikiContext context )
- {
- if ( WikiEventManager.isListening(this) && WikiPageEvent.isValidType(type) )
- {
- WikiPageEvent event = new WikiPageEvent(
- context.getEngine(),
- type,
- context.getPage().getName());
- WikiEventManager.fireEvent(this,event);
+ protected final void fireEvent( final int type, final WikiContext context ) {
+ if( WikiEventManager.isListening(this ) && WikiPageEvent.isValidType( type ) ) {
+ final WikiPageEvent event = new WikiPageEvent( context.getEngine(), type, context.getPage().getName() );
+ WikiEventManager.fireEvent(this, event );
}
}
-} // end org.apache.wiki.event.PageEventFilter
+}
diff --git a/jspwiki-main/src/main/java/org/apache/wiki/event/WikiEventUtils.java b/jspwiki-main/src/main/java/org/apache/wiki/event/WikiEventUtils.java
index bec5569..31cfd6b 100644
--- a/jspwiki-main/src/main/java/org/apache/wiki/event/WikiEventUtils.java
+++ b/jspwiki-main/src/main/java/org/apache/wiki/event/WikiEventUtils.java
@@ -20,7 +20,6 @@
package org.apache.wiki.event;
import org.apache.wiki.WikiEngine;
-import org.apache.wiki.api.engine.FilterManager;
/**
* A utility class that adds some JSPWiki-specific functionality to the
@@ -138,8 +137,7 @@ public class WikiEventUtils
|| type == WikiPageEvent.POST_SAVE_END )
{
// attach to FilterManager
- FilterManager fm = ((WikiEngine)client).getFilterManager();
- WikiEventManager.addWikiEventListener( fm, listener );
+ WikiEventManager.addWikiEventListener( ((WikiEngine)client).getFilterManager(), listener );
}
else //if ( type == WikiPageEvent.PRE_TRANSLATE
// || type == WikiPageEvent.POST_TRANSLATE
diff --git a/jspwiki-main/src/main/java/org/apache/wiki/event/WikiPageEvent.java b/jspwiki-main/src/main/java/org/apache/wiki/event/WikiPageEvent.java
index 034a1ad..07825de 100644
--- a/jspwiki-main/src/main/java/org/apache/wiki/event/WikiPageEvent.java
+++ b/jspwiki-main/src/main/java/org/apache/wiki/event/WikiPageEvent.java
@@ -68,7 +68,7 @@ package org.apache.wiki.event;
* Other WikiPageEvents include both <i>phase boundary</i> and <i>in-phase</i>
* events for saving, pre- and post-translating content. These are very noisy
* event types, but are not fired unless a listener is available. They are
- * generated by the {@link org.apache.wiki.filters.FilterManager},
+ * generated by the {@link org.apache.wiki.api.engine.FilterManager},
* {@link org.apache.wiki.event.PageEventFilter}, and potentially other
* implementing classes.
* </p>
@@ -104,7 +104,7 @@ public class WikiPageEvent extends WikiEvent
// PRE_TRANSLATE .........
/** Indicates the beginning of all wiki pre-translate page events. This is based
- * on events generated by {@link org.apache.wiki.filters.FilterManager}. */
+ * on events generated by {@link org.apache.wiki.api.engine.FilterManager}. */
public static final int PRE_TRANSLATE_BEGIN = 12;
/** Indicates a wiki pre-translate page event. This is based on events
@@ -112,13 +112,13 @@ public class WikiPageEvent extends WikiEvent
public static final int PRE_TRANSLATE = 13;
/** Indicates the end of all wiki pre-translate page events. This is based
- * on events generated by {@link org.apache.wiki.filters.FilterManager}. */
+ * on events generated by {@link org.apache.wiki.api.engine.FilterManager}. */
public static final int PRE_TRANSLATE_END = 14;
// POST_TRANSLATE ........
/** Indicates the beginning of all wiki post-translate page events. This is based
- * on events generated by {@link org.apache.wiki.filters.FilterManager}. */
+ * on events generated by {@link org.apache.wiki.api.engine.FilterManager}. */
public static final int POST_TRANSLATE_BEGIN = 15;
/** Indicates a wiki post-translate page event. This is based on events
@@ -126,13 +126,13 @@ public class WikiPageEvent extends WikiEvent
public static final int POST_TRANSLATE = 16;
/** Indicates the end of all wiki post-translate page events. This is based
- * on events generated by {@link org.apache.wiki.filters.FilterManager}. */
+ * on events generated by {@link org.apache.wiki.api.engine.FilterManager}. */
public static final int POST_TRANSLATE_END = 17;
// PRE_SAVE ..............
/** Indicates the beginning of all wiki pre-save page events. This is based
- * on events generated by {@link org.apache.wiki.filters.FilterManager}. */
+ * on events generated by {@link org.apache.wiki.api.engine.FilterManager}. */
public static final int PRE_SAVE_BEGIN = 18;
/** Indicates a wiki pre-save page event. This is based on events
@@ -140,13 +140,13 @@ public class WikiPageEvent extends WikiEvent
public static final int PRE_SAVE = 19;
/** Indicates the end of all wiki pre-save page events. This is based
- * on events generated by {@link org.apache.wiki.filters.FilterManager}. */
+ * on events generated by {@link org.apache.wiki.api.engine.FilterManager}. */
public static final int PRE_SAVE_END = 20;
// POST_SAVE .............
/** Indicates the beginning of all wiki post-save page events. This is based
- * on events generated by {@link org.apache.wiki.filters.FilterManager}. */
+ * on events generated by {@link org.apache.wiki.api.engine.FilterManager}. */
public static final int POST_SAVE_BEGIN = 21;
/** Indicates a wiki post-save page event. This is based on events
@@ -154,7 +154,7 @@ public class WikiPageEvent extends WikiEvent
public static final int POST_SAVE = 22;
/** Indicates the end of all wiki post-save page events. This is based
- * on events generated by {@link org.apache.wiki.filters.FilterManager}. */
+ * on events generated by {@link org.apache.wiki.api.engine.FilterManager}. */
public static final int POST_SAVE_END = 23;
// PAGE REQUESTS .........
diff --git a/jspwiki-main/src/main/java/org/apache/wiki/rss/AtomFeed.java b/jspwiki-main/src/main/java/org/apache/wiki/rss/AtomFeed.java
index cd0f213..3548c21 100644
--- a/jspwiki-main/src/main/java/org/apache/wiki/rss/AtomFeed.java
+++ b/jspwiki-main/src/main/java/org/apache/wiki/rss/AtomFeed.java
@@ -80,7 +80,7 @@ public class AtomFeed extends Feed
private Collection<Element> getItems()
{
- ArrayList<Element> list = new ArrayList<Element>();
+ ArrayList<Element> list = new ArrayList<>();
WikiEngine engine = m_wikiContext.getEngine();
ServletContext servletContext = null;
@@ -88,60 +88,50 @@ public class AtomFeed extends Feed
if( m_wikiContext.getHttpRequest() != null )
servletContext = m_wikiContext.getHttpRequest().getSession().getServletContext();
- for( Iterator< Entry > i = m_entries.iterator(); i.hasNext(); )
- {
- Entry e = i.next();
-
+ for( Entry e : m_entries ) {
WikiPage p = e.getPage();
- Element entryEl = getElement("entry");
+ Element entryEl = getElement( "entry" );
//
// Mandatory elements
//
- entryEl.addContent( getElement("id").setText( getEntryID(e)) );
- entryEl.addContent( getElement("title").setAttribute("type","html").setText( e.getTitle() ));
- entryEl.addContent( getElement("updated").setText( DateFormatUtils.formatUTC(p.getLastModified(),
- RFC3339FORMAT )));
+ entryEl.addContent( getElement( "id" ).setText( getEntryID( e ) ) );
+ entryEl.addContent( getElement( "title" ).setAttribute( "type", "html" ).setText( e.getTitle() ) );
+ entryEl.addContent( getElement( "updated" ).setText( DateFormatUtils.formatUTC( p.getLastModified(), RFC3339FORMAT ) ) );
//
// Optional elements
//
- entryEl.addContent( getElement("author").addContent( getElement("name").setText( e.getAuthor() )));
- entryEl.addContent( getElement("link").setAttribute("rel","alternate").setAttribute("href",e.getURL()));
- entryEl.addContent( getElement("content").setAttribute("type","html").setText( e.getContent() ));
+ entryEl.addContent( getElement( "author" ).addContent( getElement( "name" ).setText( e.getAuthor() ) ) );
+ entryEl.addContent( getElement( "link" ).setAttribute( "rel", "alternate" ).setAttribute( "href", e.getURL() ) );
+ entryEl.addContent( getElement( "content" ).setAttribute( "type", "html" ).setText( e.getContent() ) );
//
// Check for enclosures
//
- if( engine.getAttachmentManager().hasAttachments(p) && servletContext != null )
- {
- try
- {
- List< Attachment > c = engine.getAttachmentManager().listAttachments(p);
+ if( engine.getAttachmentManager().hasAttachments( p ) && servletContext != null ) {
+ try {
+ List<Attachment> c = engine.getAttachmentManager().listAttachments( p );
- for( Iterator< Attachment > a = c.iterator(); a.hasNext(); )
- {
+ for( Iterator<Attachment> a = c.iterator(); a.hasNext(); ) {
Attachment att = a.next();
- Element attEl = getElement("link");
- attEl.setAttribute( "rel","enclosure" );
- attEl.setAttribute( "href", engine.getURL(WikiContext.ATTACH, att.getName(), null, true ) );
- attEl.setAttribute( "length", Long.toString(att.getSize()) );
+ Element attEl = getElement( "link" );
+ attEl.setAttribute( "rel", "enclosure" );
+ attEl.setAttribute( "href", engine.getURL( WikiContext.ATTACH, att.getName(), null, true ) );
+ attEl.setAttribute( "length", Long.toString( att.getSize() ) );
attEl.setAttribute( "type", getMimeType( servletContext, att.getFileName() ) );
entryEl.addContent( attEl );
}
- }
- catch( ProviderException ex )
- {
+ } catch( ProviderException ex ) {
// FIXME: log.info("Can't get attachment data",ex);
}
}
-
list.add( entryEl );
}