The {@link #generateXML} method in this class provides a default - * XML dressing around a Portlet. This dressing is used by Portal's - * stylesheet rules to generate a title and frame around each Portlet. - * Programmers looking to implement a Portlet should extend this class - * and override {@link #generateBodyXML}.
+ *+ * The {@link #generateXML} method in this class provides a default XML dressing around a Portlet. + * This dressing is used by Portal's stylesheet rules to generate a title and frame around each + * Portlet. Programmers looking to implement a Portlet should extend this class and override + * {@link #generateBodyXML}.
* * @see com.arsdigita.bebop.portal.Portal * @see com.arsdigita.bebop.portal.PortalModel * @see com.arsdigita.bebop.portal.PortalModelBuilder * @see Portlet - * @author Justin Ross - * @author James Parsons + * @author Justin Ross + * @author James Parsons * @version $Id: AbstractPortlet.java 287 2005-02-22 00:29:02Z sskracic $ */ public abstract class AbstractPortlet implements Portlet, BebopConstants { @@ -62,11 +61,10 @@ public abstract class AbstractPortlet implements Portlet, BebopConstants { public static final String NARROW_PROFILE = "narrow"; /** - * An implementation of {@link Portlet#generateXML} that provides - * a default Portlet mini-schema. Portlet implementers - * cannot override this method, as it is meant to give - * the Portal stylesheet something to grab on to. If you really - * want to go your own way, implement Portlet instead of extending + * An implementation of {@link Portlet#generateXML} that provides a default Portlet mini-schema. + * Portlet implementers + * cannot override this method, as it is meant to give the Portal stylesheet something + * to grab on to. If you really want to go your own way, implement Portlet instead of extending * AbstractPortlet. * *
@@ -75,17 +73,18 @@ public abstract class AbstractPortlet implements Portlet, BebopConstants {
* </bebop:portlet>
* null.
+ * @param parentElement The Element to which to attach the XML that this method produces. Must
+ * not be null.
+ *
+ *
*/
- public final void generateXML(PageState pageState,
- Element parentElement) {
- Element portletElement = parentElement.newChildElement(BEBOP_PORTLET,
- Component.BEBOP_XML_NS);
+ @Override
+ public final void generateXML(final PageState pageState,
+ final Element parentElement) {
+ final Element portletElement = parentElement.newChildElement(BEBOP_PORTLET,
+ Component.BEBOP_XML_NS);
portletElement.addAttribute("title", getTitle());
portletElement.addAttribute("cellNumber",
Integer.toString(getCellNumber()));
@@ -97,43 +96,40 @@ public abstract class AbstractPortlet implements Portlet, BebopConstants {
}
/**
- * Generates XML for the body (not the frame) of this Portlet. It's
- * the primary intention of this class that programmers override
- * this particular method.
+ * Generates XML for the body (not the frame) of this Portlet. It's the primary intention of
+ * this class that programmers override this particular method.
*
- * @param pageState the PageState representing the current request
- * @param parentElement the Element to which to attach the XML
- * that this method produces
- * @pre pageState != null
- * @pre parentElement != null
+ * @param pageState The PageState representing the current request. Must not be
+ * null.
+ * @param parentElement The Element to which to attach the XML that this method produces. Must
+ * not be null.
*/
protected abstract void generateBodyXML(PageState pageState,
Element parentElement);
/**
- * Gets the cell number of this portlet. A cell is one of several
- * distinct regions, often columns, in a portal's layout.
+ * Gets the cell number of this portlet. A cell is one of several distinct regions, often
+ * columns, in a portal's layout.
*
- * @return the cell number of this portlet, or 1 if
- * the cell number is not set.
+ * @return The cell number of this portlet, or 1 if the cell number is not set.
*/
public final int getCellNumber() {
return m_cellNumber;
}
/**
- * Sets the cell number of this portlet. A cell is one of several
- * distinct regions, often columns, in a portal's layout.
+ * Sets the cell number of this portlet. A cell is one of several distinct regions, often
+ * columns, in a portal's layout.
*
- * @param cellNumber the cell number of this portlet
+ * @param cellNumber The cell number of this portlet
*/
- public final void setCellNumber(int cellNumber) {
+ public final void setCellNumber(final int cellNumber) {
m_cellNumber = cellNumber;
}
/**
- * Gets the sort key of this portlet. The sort key is used to
- * order the portlets in a given cell.
+ * Gets the sort key of this portlet. The sort key is used to order the portlets in a given
+ * cell.
*
* @return the sort key of this portlet, or 0 if the sort key is not set.
*/
@@ -142,22 +138,21 @@ public abstract class AbstractPortlet implements Portlet, BebopConstants {
}
/**
- * Sets the sort key of this portlet. The sort key is used to
- * order the portlets in a given cell.
+ * Sets the sort key of this portlet. The sort key is used to order the portlets in a given
+ * cell.
*
* @param sortKey the sort key of this portlet
*/
- public final void setSortKey(int sortKey) {
+ public final void setSortKey(final int sortKey) {
m_sortKey = sortKey;
}
/**
- * Gets the profile of this portlet, which describes the form
- * factor of this portlet. There are two profiles, wide
- * and narrow.
+ * Gets the profile of this portlet, which describes the form factor of this portlet. There are
+ * two profiles, wide and narrow.
+ *
+ * @return the profile of this portlet, or an empty string if the profile is not set.
*
- * @return the profile of this portlet, or an empty string if the
- * profile is not set.
* @post return != null
*/
public final String getProfile() {
@@ -165,24 +160,23 @@ public abstract class AbstractPortlet implements Portlet, BebopConstants {
}
/**
- * Sets the profile of this portlet. Profile describes the form
- * factor of this portlet. There are two profiles, wide
- * and narrow. Use {@link #WIDE_PROFILE} or {@link
+ * Sets the profile of this portlet. Profile describes the form factor of this portlet. There
+ * are two profiles, wide and narrow. Use {@link #WIDE_PROFILE} or {@link
* #NARROW_PROFILE} to specify the profile type.
*
- * @param profile the profile of this portlet
- * @pre profile != null
+ * @param profile The profile of this portlet. Must not be null.
+ *
*/
- public final void setProfile(String profile) {
+ public final void setProfile(final String profile) {
m_profile = profile;
}
/**
* Gets the title of this portlet.
*
- * @return the title of this portlet, or an empty string
- * if the title is not set.
- * @post return != null
+ * @return The title of this portlet, or an empty string if the title is not set. This method
+ * never returns null.
+ *
*/
public final String getTitle() {
return m_title;
@@ -190,11 +184,11 @@ public abstract class AbstractPortlet implements Portlet, BebopConstants {
/**
* Sets the title of this portlet.
- *
- * @return the title of this portlet.
- * @post return != null
+ *
+ * @param title The (new) title of this portlet.
*/
- public final void setTitle(String title) {
+ public final void setTitle(final String title) {
m_title = title;
}
+
}
diff --git a/ccm-core/src/com/arsdigita/bebop/BaseLink.java b/ccm-core/src/com/arsdigita/bebop/BaseLink.java
index 5209292e1..c1f61735d 100755
--- a/ccm-core/src/com/arsdigita/bebop/BaseLink.java
+++ b/ccm-core/src/com/arsdigita/bebop/BaseLink.java
@@ -99,7 +99,7 @@ public abstract class BaseLink extends TextStylable
* @param child label component, text, image, etc.
* @param url
*/
- public BaseLink(Component child, String url) {
+ public BaseLink(final Component child, final String url) {
super();
m_url = url;
m_child = child;
@@ -111,7 +111,7 @@ public abstract class BaseLink extends TextStylable
* @param label as text
* @param url
*/
- public BaseLink(String label, String url) {
+ public BaseLink(final String label, final String url) {
this(new Label(label), url);
}
@@ -119,12 +119,12 @@ public abstract class BaseLink extends TextStylable
* Constructor.
*
* @param child
- * @param l
+ * @param listener
*/
- public BaseLink(Component child, PrintListener l) {
+ public BaseLink(final Component child, final PrintListener listener) {
this(child, "");
try {
- addPrintListener(l);
+ addPrintListener(listener);
} catch (TooManyListenersException e) {
// Can't happen
throw new UncheckedWrapperException("Too many listeners: " + e.getMessage(), e);
@@ -135,24 +135,24 @@ public abstract class BaseLink extends TextStylable
* Constructor.
*
* @param label
- * @param l
+ * @param listener
*/
- public BaseLink(String label, PrintListener l) {
- this(new Label(label), l);
+ public BaseLink(final String label, final PrintListener listener) {
+ this(new Label(label), listener);
}
/**
* Constructor.
*
- * @param l
+ * @param listener
*/
- public BaseLink(PrintListener l) {
- this("", l);
+ public BaseLink(final PrintListener listener) {
+ this("", listener);
}
@Override
public Object clone() throws CloneNotSupportedException {
- BaseLink result = (BaseLink) super.clone();
+ final BaseLink result = (BaseLink) super.clone();
result.m_printListener = null;
return result;
}
@@ -162,12 +162,12 @@ public abstract class BaseLink extends TextStylable
* Since the PrintListener is expected to modify the
* target of the PrintEvent, only one print listener can be
* set for a link.
- * @param listener the print listener
+ * @param listener The print listener. Must not null.
* @throws IllegalArgumentException if listener is null.
* @throws TooManyListenersException if a print listener has previously been
* added.
- * @pre listener != null */
- public void addPrintListener(PrintListener listener)
+ */
+ public void addPrintListener(final PrintListener listener)
throws IllegalStateException, TooManyListenersException {
if (listener == null) {
throw new IllegalArgumentException("Argument listener can not be null");
@@ -183,14 +183,12 @@ public abstract class BaseLink extends TextStylable
* listener is not the listener that was added with {@link #addPrintListener
* addPrintListener}, an IllegalArgumentException will be thrown.
*
- * @param listener the listener that was previously added with
- * addPrintListener
- * @throws IllegalArgumentException if
- * listener is not the currently registered print listener or
- * is
- * null. @pre listener != null
+ * @param listener The listener that was previously added with addPrintListener.
+ * Must not be null.
+ * @throws IllegalArgumentException if listener is not the currently registered
+ * print listener or is null.
*/
- public void removePrintListener(PrintListener listener)
+ public void removePrintListener(final PrintListener listener)
throws IllegalArgumentException {
if (listener == null) {
throw new IllegalArgumentException("listener can not be null");
@@ -201,7 +199,7 @@ public abstract class BaseLink extends TextStylable
m_printListener = null;
}
- protected BaseLink firePrintEvent(PageState state) {
+ protected BaseLink firePrintEvent(final PageState state) {
BaseLink l = this;
if (m_printListener != null) {
try {
@@ -219,7 +217,7 @@ public abstract class BaseLink extends TextStylable
return m_child;
}
- public void setChild(Component child) {
+ public void setChild(final Component child) {
Assert.isUnlocked(this);
m_child = child;
}
@@ -228,7 +226,7 @@ public abstract class BaseLink extends TextStylable
return m_url;
}
- public final void setTarget(String url) {
+ public final void setTarget(final String url) {
Assert.isUnlocked(this);
m_url = url;
@@ -237,14 +235,14 @@ public abstract class BaseLink extends TextStylable
/**
* Sets the type of link this link represents.
*
- * @param t the type of link
+ * @param type the type of link
*/
- protected void setTypeAttr(String t) {
+ protected void setTypeAttr(final String type) {
Assert.isUnlocked(this);
- setAttribute(TYPE_ATTR, t);
+ setAttribute(TYPE_ATTR, type);
}
- protected abstract void generateURL(PageState state, Element parent);
+ protected abstract void generateURL(final PageState state, final Element parent);
/**
* Generates a DOM fragment:
@@ -253,17 +251,21 @@ public abstract class BaseLink extends TextStylable
*
* The href attribute contains the target the link
* should point to. The type attribute is used to
- * give more finegrained control over which kind of link this element
+ * give more fine grained control over which kind of link this element
* represents. The types are link for a
* Link, control for a {@link ControlLink},
* and toggle for a {@link ToggleLink}. There may be
* additional attributes depending on what type of link this link
* represents.
+ *
+ * @param state The current {@link PageState}.
+ * @param parent The XML element to attach the XML to.
+ *
* @see ControlLink#generateXML
* @see ToggleLink#generateXML
*/
@Override
- public void generateXML(PageState state, Element parent) {
+ public void generateXML(final PageState state, final Element parent) {
if (isVisible(state)) {
BaseLink target = firePrintEvent(state);
Element link = parent.newChildElement("bebop:link", BEBOP_XML_NS);
@@ -278,7 +280,7 @@ public abstract class BaseLink extends TextStylable
}
}
- private String getAbsoluteUrl(PageState ps, String sUrl) {
+ private String getAbsoluteUrl(final PageState state, final String sUrl) {
String sReturn = "";
if ((sUrl.indexOf(":") != -1) || sUrl.indexOf("/") == 0) {
@@ -290,7 +292,7 @@ public abstract class BaseLink extends TextStylable
//get the current URL
String sThisURL = "";
try {
- sThisURL = ps.stateAsURL();
+ sThisURL = state.stateAsURL();
} catch (java.io.IOException ioe) {
//ignore
}
@@ -308,18 +310,23 @@ public abstract class BaseLink extends TextStylable
return sReturn;
}
- //sets up no-JavaScript fallback HTML
- protected void setupNoJavascriptURL(PageState ps, Element link) {
+ /**
+ * Sets up no-JavaScript fallback HTML
+ *
+ * @param state The current {@link PageState}.
+ * @param link The link element.
+ */
+ protected void setupNoJavascriptURL(final PageState state, final Element link) {
String sURL = null;
if (m_sConfirmMsg.length() > 0
|| (m_confirmMsg != null && m_confirmMsg.localize().toString().length() > 0)) {
//if we want the confirm link, create the link
- String sOkUrl = getAbsoluteUrl(ps, link.getAttribute(HREF));
+ String sOkUrl = getAbsoluteUrl(state, link.getAttribute(HREF));
String sCancelUrl = null;
try {
- sCancelUrl = ps.stateAsURL();
+ sCancelUrl = state.stateAsURL();
} catch (java.io.IOException e) {
Assert.fail("Could not get current page state as URL");
}
@@ -349,10 +356,10 @@ public abstract class BaseLink extends TextStylable
* more attributes than the ones {@link #generateXML generateXML}
* produces by default.
*
- * @param state the current request
- * @param link the XML element representing this link
+ * @param state The current request
+ * @param link The XML element representing this link
*/
- protected void generateExtraXMLAttributes(PageState state, Element link) {
+ protected void generateExtraXMLAttributes(final PageState state, final Element link) {
}
/**
@@ -360,12 +367,12 @@ public abstract class BaseLink extends TextStylable
* protection for this link. Not for confirmation messages; Should call
* setConfirmation for that.
*
- * @param value
- * @pre value.toLowerCase().startsWith("return confirm(") == false
+ * @param value The confirmation link. To not use the value {@code return confirm(} with this
+ * method.
*
* @see #setConfirmation
*/
- public void setOnClick(String value) {
+ public void setOnClick(final String value) {
//should not use this method to set confirmation messages--should
//use setConfirmation() instead, or else the javascript will break
if (value != null) {
@@ -389,12 +396,10 @@ public abstract class BaseLink extends TextStylable
* Subsequent calls to setOnClick will undo the effect of this method.
*
* @param message the confirmation message presented to the user. This
- * message cannot have an apostrophe or back slash
- *
- * @pre message.indexOf("'") == -1 && message.indexOf("\\") == -1
+ * message cannot have an apostrophe or back slash.
*
*/
- public void setConfirmation(String message) {
+ public void setConfirmation(final String message) {
//make sure that the message doesn't have any apostrophe's
//or back slashes
@@ -411,7 +416,7 @@ public abstract class BaseLink extends TextStylable
* Set a GlobalizedMessage as confirmation message
* @param msg
*/
- public void setConfirmation(GlobalizedMessage msg) {
+ public void setConfirmation(final GlobalizedMessage msg) {
m_confirmMsg = msg;
}
@@ -421,7 +426,7 @@ public abstract class BaseLink extends TextStylable
* @param state PageState
* @param link Parent element
*/
- private void exportConfirmAttributes(PageState state, Element link) {
+ private void exportConfirmAttributes(final PageState state, final Element link) {
// If a confirmation message is set
if (m_sConfirmMsg.length() > 0 || m_confirmMsg != null) {
@@ -445,7 +450,7 @@ public abstract class BaseLink extends TextStylable
}
}
- public final void setNoJavascriptTarget(String sURL) {
+ public final void setNoJavascriptTarget(final String sURL) {
Assert.isUnlocked(this);
m_noJavascriptURL = sURL;
}
diff --git a/ccm-core/src/com/arsdigita/persistence/PooledConnectionSource.java b/ccm-core/src/com/arsdigita/persistence/PooledConnectionSource.java
index 52ee478eb..ff0f8ede2 100755
--- a/ccm-core/src/com/arsdigita/persistence/PooledConnectionSource.java
+++ b/ccm-core/src/com/arsdigita/persistence/PooledConnectionSource.java
@@ -127,7 +127,6 @@ public class PooledConnectionSource implements ConnectionSource {
* cause problems (memory etc.) with PostgreSQL.
*/
try {
-
result.setAutoCommit(false);
} catch (SQLException ex) {
s_log.warn("Failed to set autocommit to false");
diff --git a/ccm-core/src/com/arsdigita/web/CCMApplicationContextListener.java b/ccm-core/src/com/arsdigita/web/CCMApplicationContextListener.java
index 81fb20992..5558a66de 100644
--- a/ccm-core/src/com/arsdigita/web/CCMApplicationContextListener.java
+++ b/ccm-core/src/com/arsdigita/web/CCMApplicationContextListener.java
@@ -16,7 +16,6 @@
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*
*/
-
package com.arsdigita.web;
import com.arsdigita.runtime.CCMResourceManager;
@@ -35,62 +34,59 @@ import org.apache.log4j.LogManager;
import org.apache.log4j.PropertyConfigurator;
/**
- * Web application lifecycle listener, used to perform central initialization
- * tasks at CCM startup in a servlet container / web application server,
- * expecially setting the runtime context (file locations) and (in the future)
- * the database connection.
+ * Web application lifecycle listener, used to perform central initialisation tasks at CCM startup
+ * in a Servlet container / web application server, expecially setting the runtime context (file
+ * locations) and (in the future) the database connection.
*
- * The methods of this classes are by definition only invoked by the servlet
- * container / web application server, not by any servlet or java class of
- * the application itself! Invokation is managed by the deployment descriptor.
+ * The methods of this classes are by definition only invoked by the Servlet container / web
+ * application server, not by any Servlet or java class of the application itself! Invocation is
+ * managed by the deployment descriptor.
*
* Note! Don't forget to configure it in web.xml deployment descriptor!
- *
-
-
-
-
+
+
+
+
-
-
+
+