Author: rahul
Date: Tue Sep 26 18:18:28 2006
New Revision: 450272
URL: http://svn.apache.org/viewvc?view=rev&rev=450272
Log:
Unused imports, Javadoc warnings, checkstyle reports. Cosmetic changes only.
Modified:
shale/sandbox/shale-dialog2-legacy/src/main/java/org/apache/shale/dialog2/legacy/Globals.java
shale/sandbox/shale-dialog2-legacy/src/main/java/org/apache/shale/dialog2/legacy/LegacyDialogContext.java
shale/sandbox/shale-dialog2-legacy/src/main/java/org/apache/shale/dialog2/legacy/LegacyDialogManager.java
shale/sandbox/shale-dialog2-legacy/src/main/java/org/apache/shale/dialog2/legacy/Position.java
shale/sandbox/shale-dialog2-legacy/src/main/java/org/apache/shale/dialog2/legacy/config/AbstractState.java
shale/sandbox/shale-dialog2-legacy/src/main/java/org/apache/shale/dialog2/legacy/config/ActionStateImpl.java
shale/sandbox/shale-dialog2-legacy/src/main/java/org/apache/shale/dialog2/legacy/config/ConfigurationParser.java
shale/sandbox/shale-dialog2-legacy/src/main/java/org/apache/shale/dialog2/legacy/config/DialogImpl.java
shale/sandbox/shale-dialog2-legacy/src/main/java/org/apache/shale/dialog2/legacy/config/EndStateImpl.java
shale/sandbox/shale-dialog2-legacy/src/main/java/org/apache/shale/dialog2/legacy/config/SubdialogStateImpl.java
shale/sandbox/shale-dialog2-legacy/src/main/java/org/apache/shale/dialog2/legacy/config/TransitionImpl.java
shale/sandbox/shale-dialog2-legacy/src/main/java/org/apache/shale/dialog2/legacy/config/ViewStateImpl.java
shale/sandbox/shale-dialog2-legacy/src/main/java/org/apache/shale/dialog2/legacy/model/ActionState.java
shale/sandbox/shale-dialog2-legacy/src/main/java/org/apache/shale/dialog2/legacy/model/Dialog.java
shale/sandbox/shale-dialog2-legacy/src/main/java/org/apache/shale/dialog2/legacy/model/State.java
shale/sandbox/shale-dialog2-legacy/src/main/java/org/apache/shale/dialog2/legacy/model/SubdialogState.java
shale/sandbox/shale-dialog2-legacy/src/main/java/org/apache/shale/dialog2/legacy/model/Transition.java
shale/sandbox/shale-dialog2-legacy/src/main/java/org/apache/shale/dialog2/legacy/model/ViewState.java
Modified:
shale/sandbox/shale-dialog2-legacy/src/main/java/org/apache/shale/dialog2/legacy/Globals.java
URL:
http://svn.apache.org/viewvc/shale/sandbox/shale-dialog2-legacy/src/main/java/org/apache/shale/dialog2/legacy/Globals.java?view=diff&rev=450272&r1=450271&r2=450272
==============================================================================
---
shale/sandbox/shale-dialog2-legacy/src/main/java/org/apache/shale/dialog2/legacy/Globals.java
(original)
+++
shale/sandbox/shale-dialog2-legacy/src/main/java/org/apache/shale/dialog2/legacy/Globals.java
Tue Sep 26 18:18:28 2006
@@ -24,7 +24,7 @@
* @since 1.0.4
*/
public class Globals {
-
+
/**
* <p>Context initialization paramater name under which a comma separated
Modified:
shale/sandbox/shale-dialog2-legacy/src/main/java/org/apache/shale/dialog2/legacy/LegacyDialogContext.java
URL:
http://svn.apache.org/viewvc/shale/sandbox/shale-dialog2-legacy/src/main/java/org/apache/shale/dialog2/legacy/LegacyDialogContext.java?view=diff&rev=450272&r1=450271&r2=450272
==============================================================================
---
shale/sandbox/shale-dialog2-legacy/src/main/java/org/apache/shale/dialog2/legacy/LegacyDialogContext.java
(original)
+++
shale/sandbox/shale-dialog2-legacy/src/main/java/org/apache/shale/dialog2/legacy/LegacyDialogContext.java
Tue Sep 26 18:18:28 2006
@@ -20,15 +20,15 @@
import java.util.ArrayList;
import java.util.List;
import java.util.Map;
+
import javax.faces.FacesException;
import javax.faces.application.ViewHandler;
import javax.faces.component.UIViewRoot;
import javax.faces.context.FacesContext;
import javax.faces.el.MethodBinding;
-import org.apache.shale.dialog2.Constants;
+
import org.apache.shale.dialog2.DialogContext;
import org.apache.shale.dialog2.DialogContextManager;
-import org.apache.shale.dialog2.legacy.config.ConfigurationParser;
import org.apache.shale.dialog2.legacy.model.ActionState;
import org.apache.shale.dialog2.legacy.model.Dialog;
import org.apache.shale.dialog2.legacy.model.EndState;
@@ -40,24 +40,22 @@
/**
* <p>Implementation of [EMAIL PROTECTED] DialogContext} for integrating
* legacy dialog support into the Shale Dialog Manager.</p>
- *
+ *
* <p><strong>IMPLEMENTATION NOTE</strong> - Takes on the responsibilities
* of the <code>org.apache.shale.dialog.Status</code> implementation in the
* original approach.</p>
- *
- *
+ *
* @since 1.0.4
*/
final class LegacyDialogContext implements DialogContext, Serializable {
-
+
// ------------------------------------------------------------
Constructors
/**
* <p>Construct a new instance.</p>
- *
- *
+ *
* @param manager [EMAIL PROTECTED] DialogContextManager} instance that
owns us
* @param dialog Configured dialog definition we will be following
* @param id Dialog identifier assigned to this instance
@@ -76,7 +74,7 @@
start(dialog);
}
-
+
// ------------------------------------------------------ DialogContext
Variables
@@ -365,6 +363,7 @@
* regenerating it if necessary first.</p>
*
* @param context FacesContext for the current request
+ * @return The [EMAIL PROTECTED] Dialog} instance we are executing
*/
private Dialog dialog(FacesContext context) {
@@ -381,6 +380,7 @@
* by logical dialog name.</p>
*
* @param context FacesContext for the current request
+ * @return The map of available dialogs, keyed by dialog logical name
*
* @exception IllegalStateException if dialog configuration has not
* been completed
@@ -409,6 +409,9 @@
/**
* <p>Return a <code>Position</code> representing the currently executing
* dialog and state (if any); otherwise, return <code>null</code>.</p>
+ *
+ * @return Position representing the currently executing dialog and
+ * state, may be null
*/
private Position peek() {
@@ -427,6 +430,10 @@
* <p>Pop the currently executing <code>Position</code> and return the
* previously executing <code>Position</code> (if any); otherwise,
* return <code>null</code>.</p>
+ *
+ * @return Position representing the previously executing dialog and
+ * state (may be null), currently executing dialog Position
+ * is lost.
*/
private Position pop() {
Modified:
shale/sandbox/shale-dialog2-legacy/src/main/java/org/apache/shale/dialog2/legacy/LegacyDialogManager.java
URL:
http://svn.apache.org/viewvc/shale/sandbox/shale-dialog2-legacy/src/main/java/org/apache/shale/dialog2/legacy/LegacyDialogManager.java?view=diff&rev=450272&r1=450271&r2=450272
==============================================================================
---
shale/sandbox/shale-dialog2-legacy/src/main/java/org/apache/shale/dialog2/legacy/LegacyDialogManager.java
(original)
+++
shale/sandbox/shale-dialog2-legacy/src/main/java/org/apache/shale/dialog2/legacy/LegacyDialogManager.java
Tue Sep 26 18:18:28 2006
@@ -20,10 +20,11 @@
import java.net.URL;
import java.util.Enumeration;
import java.util.HashMap;
-import java.util.List;
import java.util.Map;
+
import javax.faces.FacesException;
import javax.faces.context.FacesContext;
+
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.apache.shale.dialog2.Constants;
@@ -154,6 +155,7 @@
* resources will be processed.</p>
*
* @param context FacesContext for the current request
+ * @return The map of available dialogs, keyed by dialog logical name
*/
private Map dialogs(FacesContext context) {
@@ -267,7 +269,7 @@
EMBEDDED_CONFIGURATION_RESOURCE);
}
}
-
+
context.getExternalContext().getApplicationMap().put(Globals.DIALOGS,
this.dialogs);
return this.dialogs;
@@ -277,6 +279,8 @@
/**
* <p>Generate and return a new dialog identifier. FIXME - switch to
* something that creates randomized identifiers?</p>
+ *
+ * @return The new dialog identifier
*/
private String generateId() {
return "" + ++serial;
@@ -285,6 +289,8 @@
/**
* <p>Return the <code>Log</code> instance for this instance.</p>
+ *
+ * @return The [EMAIL PROTECTED] Log} instance used by this manager
*/
private Log log() {
if (this.log == null) {
Modified:
shale/sandbox/shale-dialog2-legacy/src/main/java/org/apache/shale/dialog2/legacy/Position.java
URL:
http://svn.apache.org/viewvc/shale/sandbox/shale-dialog2-legacy/src/main/java/org/apache/shale/dialog2/legacy/Position.java?view=diff&rev=450272&r1=450271&r2=450272
==============================================================================
---
shale/sandbox/shale-dialog2-legacy/src/main/java/org/apache/shale/dialog2/legacy/Position.java
(original)
+++
shale/sandbox/shale-dialog2-legacy/src/main/java/org/apache/shale/dialog2/legacy/Position.java
Tue Sep 26 18:18:28 2006
@@ -17,9 +17,10 @@
package org.apache.shale.dialog2.legacy;
import java.io.Serializable;
-import java.util.HashMap;
import java.util.Map;
+
import javax.faces.context.FacesContext;
+
import org.apache.shale.dialog2.legacy.model.Dialog;
import org.apache.shale.dialog2.legacy.model.State;
@@ -28,7 +29,7 @@
* a [EMAIL PROTECTED] Dialog}.</p>
*/
class Position implements Serializable {
-
+
// ------------------------------------------------------------
Constructors
@@ -75,7 +76,7 @@
*/
private String dialogName = null;
-
+
/**
* <p>The [EMAIL PROTECTED] State} that represents the current position
within the
* [EMAIL PROTECTED] Dialog} that is being executed. This value is
transient, and
@@ -96,6 +97,8 @@
/**
* <p>Return the data object associated with this dialog execution.</p>
+ *
+ * @return The associated data object for this dialog instance
*/
Object getData() {
return this.data;
@@ -115,6 +118,9 @@
/**
* <p>Return the [EMAIL PROTECTED] Dialog} whose execution is tracked by
this
* [EMAIL PROTECTED] Position}.</p>
+ *
+ * @return The [EMAIL PROTECTED] Dialog} being tracked by this [EMAIL
PROTECTED] Position}
+ * instance
*/
Dialog getDialog() {
if (this.dialog != null) {
@@ -131,6 +137,8 @@
/**
* <p>Set the [EMAIL PROTECTED] Dialog} whose execution is being tracked
by this
* [EMAIL PROTECTED] Position}.</p>
+ *
+ * @param dialog The [EMAIL PROTECTED] Dialog} instance being tracked
*/
private void setDialog(Dialog dialog) {
this.dialog = dialog;
@@ -141,6 +149,8 @@
/**
* <p>Return the [EMAIL PROTECTED] State} representing the current
execution position
* within the owning [EMAIL PROTECTED] Dialog}.</p>
+ *
+ * @return The current [EMAIL PROTECTED] State} within the owning [EMAIL
PROTECTED] Dialog}
*/
State getState() {
return this.state;
@@ -169,6 +179,8 @@
/**
* <p>Return a String representation of this object.</p>
+ *
+ * @return The String representation of this [EMAIL PROTECTED] Position}
instance
*/
public String toString() {
if (getState() == null) {
Modified:
shale/sandbox/shale-dialog2-legacy/src/main/java/org/apache/shale/dialog2/legacy/config/AbstractState.java
URL:
http://svn.apache.org/viewvc/shale/sandbox/shale-dialog2-legacy/src/main/java/org/apache/shale/dialog2/legacy/config/AbstractState.java?view=diff&rev=450272&r1=450271&r2=450272
==============================================================================
---
shale/sandbox/shale-dialog2-legacy/src/main/java/org/apache/shale/dialog2/legacy/config/AbstractState.java
(original)
+++
shale/sandbox/shale-dialog2-legacy/src/main/java/org/apache/shale/dialog2/legacy/config/AbstractState.java
Tue Sep 26 18:18:28 2006
@@ -102,6 +102,7 @@
* if any; otherwise, return <code>null</code>.</p>
*
* @param outcome Logical outcome for which to return a [EMAIL PROTECTED]
Transition}
+ * @return The matching [EMAIL PROTECTED] Transition}
*/
public Transition findTransition(String outcome) {
Modified:
shale/sandbox/shale-dialog2-legacy/src/main/java/org/apache/shale/dialog2/legacy/config/ActionStateImpl.java
URL:
http://svn.apache.org/viewvc/shale/sandbox/shale-dialog2-legacy/src/main/java/org/apache/shale/dialog2/legacy/config/ActionStateImpl.java?view=diff&rev=450272&r1=450271&r2=450272
==============================================================================
---
shale/sandbox/shale-dialog2-legacy/src/main/java/org/apache/shale/dialog2/legacy/config/ActionStateImpl.java
(original)
+++
shale/sandbox/shale-dialog2-legacy/src/main/java/org/apache/shale/dialog2/legacy/config/ActionStateImpl.java
Tue Sep 26 18:18:28 2006
@@ -57,6 +57,8 @@
/**
* <p>Render a printable version of this instance.</p>
+ *
+ * @return The printable version of this instance
*/
public String toString() {
Modified:
shale/sandbox/shale-dialog2-legacy/src/main/java/org/apache/shale/dialog2/legacy/config/ConfigurationParser.java
URL:
http://svn.apache.org/viewvc/shale/sandbox/shale-dialog2-legacy/src/main/java/org/apache/shale/dialog2/legacy/config/ConfigurationParser.java?view=diff&rev=450272&r1=450271&r2=450272
==============================================================================
---
shale/sandbox/shale-dialog2-legacy/src/main/java/org/apache/shale/dialog2/legacy/config/ConfigurationParser.java
(original)
+++
shale/sandbox/shale-dialog2-legacy/src/main/java/org/apache/shale/dialog2/legacy/config/ConfigurationParser.java
Tue Sep 26 18:18:28 2006
@@ -49,7 +49,7 @@
/**
* <p>Registration information for the DTD we will use to validate.</p>
*/
- private static final String REGISTRATIONS[] =
+ private static final String[] REGISTRATIONS =
{ "-//Apache Software Foundation//DTD Shale Dialog2 Configuration 1.0//EN",
"/org/apache/shale/dialog2/dialog2-config_1_0.dtd",
"-//Apache Software Foundation//DTD Shale Dialog2 Configuration 1.1//EN",
@@ -70,6 +70,8 @@
* <p>Return the <code>Map</code> of <code>Dialog</code> instances
* into which parsed information will be stored, keyed by dialog
* name.</p>
+ *
+ * @return The map of available [EMAIL PROTECTED] Dialog}s, keyed by name
*/
public Map getDialogs() {
return this.dialogs;
@@ -96,6 +98,8 @@
/**
* <p>Return the URL of the configuration resource to be parsed.</p>
+ *
+ * @return The URL of the dialogs configuration resource
*/
public URL getResource() {
return this.resource;
@@ -121,6 +125,8 @@
/**
* <p>Return a flag indicating whether we will be doing a validating parse
* or not. Default value is <code>true</code>.</p>
+ *
+ * @return Whether the parse is a validating one
*/
public boolean isValidating() {
return this.validating;
@@ -166,6 +172,9 @@
/**
* <p>Return a fully configured <code>Digester</code> instance.</p>
+ *
+ * @return The fully configured [EMAIL PROTECTED] Digester} instance for
parsing
+ * the dialog configuration resource
*/
private Digester digester() {
Modified:
shale/sandbox/shale-dialog2-legacy/src/main/java/org/apache/shale/dialog2/legacy/config/DialogImpl.java
URL:
http://svn.apache.org/viewvc/shale/sandbox/shale-dialog2-legacy/src/main/java/org/apache/shale/dialog2/legacy/config/DialogImpl.java?view=diff&rev=450272&r1=450271&r2=450272
==============================================================================
---
shale/sandbox/shale-dialog2-legacy/src/main/java/org/apache/shale/dialog2/legacy/config/DialogImpl.java
(original)
+++
shale/sandbox/shale-dialog2-legacy/src/main/java/org/apache/shale/dialog2/legacy/config/DialogImpl.java
Tue Sep 26 18:18:28 2006
@@ -77,6 +77,9 @@
* <p>Return the class of a JavaBean to be instantiated as the initial
* value of the <code>data</code> property of a newly instantiated
* <code>DialogContext</code>.</p>
+ *
+ * @return The JavaBean class whose instance becomes the <code>data</code>
+ * property of a new instance of this dialog
*/
public Class getDataClass() {
@@ -87,6 +90,8 @@
/**
* <p>Return the name of this [EMAIL PROTECTED] Dialog}.</p>
+ *
+ * @return The name of this [EMAIL PROTECTED] Dialog}
*/
public String getName() {
@@ -98,6 +103,8 @@
/**
* <p>Return the name of the starting [EMAIL PROTECTED] State} for this
* [EMAIL PROTECTED] Dialog}.</p>
+ *
+ * @return The starting state associated with this [EMAIL PROTECTED]
Dialog}
*/
public String getStart() {
@@ -110,6 +117,9 @@
* <p>Return an <code>Iterator</code> over the names of [EMAIL PROTECTED]
State}s
* that are owned by this [EMAIL PROTECTED] Dialog}. If there are no such
* [EMAIL PROTECTED] State}s, an empty <code>Iterator</code> is
returned.</p>
+ *
+ * @return An <code>Iterator</code> over all the [EMAIL PROTECTED] State}s
in this
+ * [EMAIL PROTECTED] Dialog}
*/
public Iterator getStateIds() {
@@ -123,6 +133,9 @@
* global [EMAIL PROTECTED] Transition}s for this [EMAIL PROTECTED]
Dialog}. If there are
* no such [EMAIL PROTECTED] Transition}s, an empty <code>Iterator</code>
is
* returned.</p>
+ *
+ * @return An <code>Iterator</code> over the logical outcomes of global
+ * [EMAIL PROTECTED] Transition}s for this [EMAIL PROTECTED]
Dialog}
*/
public Iterator getTransitionOutcomes() {
@@ -139,6 +152,7 @@
* if any. Otherwise, return <code>null</code>.</p>
*
* @param id Identifier of the requested [EMAIL PROTECTED] State}
+ * @return The [EMAIL PROTECTED] State} specified by the identifier, may
be null
*/
public State findState(String id) {
@@ -152,6 +166,7 @@
* if any; otherwise, return <code>null</code>.</p>
*
* @param outcome Logical outcome for which to return a [EMAIL PROTECTED]
Transition}
+ * @return The global [EMAIL PROTECTED] Transition} for the specified
logical outcome
*/
public Transition findTransition(String outcome) {
@@ -162,6 +177,8 @@
/**
* <p>Render a printable version of this instance.</p>
+ *
+ * @return A printable version of this instance
*/
public String toString() {
@@ -215,6 +232,9 @@
/**
* <p>Return the data class name for the <code>data</code> property
* of a newly instantiated <code>DialogContext</code>.</p>
+ *
+ * @return The fully qualified class name whose instance becomes the
+ * <code>data</code> property of a new instance of this dialog
*/
public String getDataClassName() {
Modified:
shale/sandbox/shale-dialog2-legacy/src/main/java/org/apache/shale/dialog2/legacy/config/EndStateImpl.java
URL:
http://svn.apache.org/viewvc/shale/sandbox/shale-dialog2-legacy/src/main/java/org/apache/shale/dialog2/legacy/config/EndStateImpl.java?view=diff&rev=450272&r1=450271&r2=450272
==============================================================================
---
shale/sandbox/shale-dialog2-legacy/src/main/java/org/apache/shale/dialog2/legacy/config/EndStateImpl.java
(original)
+++
shale/sandbox/shale-dialog2-legacy/src/main/java/org/apache/shale/dialog2/legacy/config/EndStateImpl.java
Tue Sep 26 18:18:28 2006
@@ -33,6 +33,8 @@
/**
* <p>Render a printable version of this instance.</p>
+ *
+ * @return The printable version of this instance
*/
public String toString() {
Modified:
shale/sandbox/shale-dialog2-legacy/src/main/java/org/apache/shale/dialog2/legacy/config/SubdialogStateImpl.java
URL:
http://svn.apache.org/viewvc/shale/sandbox/shale-dialog2-legacy/src/main/java/org/apache/shale/dialog2/legacy/config/SubdialogStateImpl.java?view=diff&rev=450272&r1=450271&r2=450272
==============================================================================
---
shale/sandbox/shale-dialog2-legacy/src/main/java/org/apache/shale/dialog2/legacy/config/SubdialogStateImpl.java
(original)
+++
shale/sandbox/shale-dialog2-legacy/src/main/java/org/apache/shale/dialog2/legacy/config/SubdialogStateImpl.java
Tue Sep 26 18:18:28 2006
@@ -55,6 +55,8 @@
/**
* <p>Render a printable version of this instance.</p>
+ *
+ * @return The printable version of this instance
*/
public String toString() {
Modified:
shale/sandbox/shale-dialog2-legacy/src/main/java/org/apache/shale/dialog2/legacy/config/TransitionImpl.java
URL:
http://svn.apache.org/viewvc/shale/sandbox/shale-dialog2-legacy/src/main/java/org/apache/shale/dialog2/legacy/config/TransitionImpl.java?view=diff&rev=450272&r1=450271&r2=450272
==============================================================================
---
shale/sandbox/shale-dialog2-legacy/src/main/java/org/apache/shale/dialog2/legacy/config/TransitionImpl.java
(original)
+++
shale/sandbox/shale-dialog2-legacy/src/main/java/org/apache/shale/dialog2/legacy/config/TransitionImpl.java
Tue Sep 26 18:18:28 2006
@@ -72,6 +72,8 @@
/**
* <p>Render a printable version of this instance.</p>
+ *
+ * @return The printable version of this instance
*/
public String toString() {
Modified:
shale/sandbox/shale-dialog2-legacy/src/main/java/org/apache/shale/dialog2/legacy/config/ViewStateImpl.java
URL:
http://svn.apache.org/viewvc/shale/sandbox/shale-dialog2-legacy/src/main/java/org/apache/shale/dialog2/legacy/config/ViewStateImpl.java?view=diff&rev=450272&r1=450271&r2=450272
==============================================================================
---
shale/sandbox/shale-dialog2-legacy/src/main/java/org/apache/shale/dialog2/legacy/config/ViewStateImpl.java
(original)
+++
shale/sandbox/shale-dialog2-legacy/src/main/java/org/apache/shale/dialog2/legacy/config/ViewStateImpl.java
Tue Sep 26 18:18:28 2006
@@ -56,6 +56,8 @@
/**
* <p>Render a printable version of this instance.</p>
+ *
+ * @return The printable version of this instance
*/
public String toString() {
Modified:
shale/sandbox/shale-dialog2-legacy/src/main/java/org/apache/shale/dialog2/legacy/model/ActionState.java
URL:
http://svn.apache.org/viewvc/shale/sandbox/shale-dialog2-legacy/src/main/java/org/apache/shale/dialog2/legacy/model/ActionState.java?view=diff&rev=450272&r1=450271&r2=450272
==============================================================================
---
shale/sandbox/shale-dialog2-legacy/src/main/java/org/apache/shale/dialog2/legacy/model/ActionState.java
(original)
+++
shale/sandbox/shale-dialog2-legacy/src/main/java/org/apache/shale/dialog2/legacy/model/ActionState.java
Tue Sep 26 18:18:28 2006
@@ -35,6 +35,8 @@
/**
* <p>Return the method binding expression specifying the method to be
* invoked when this [EMAIL PROTECTED] State} is entered.</p>
+ *
+ * @return The method binding expression to be invoked
*/
public String getMethod();
Modified:
shale/sandbox/shale-dialog2-legacy/src/main/java/org/apache/shale/dialog2/legacy/model/Dialog.java
URL:
http://svn.apache.org/viewvc/shale/sandbox/shale-dialog2-legacy/src/main/java/org/apache/shale/dialog2/legacy/model/Dialog.java?view=diff&rev=450272&r1=450271&r2=450272
==============================================================================
---
shale/sandbox/shale-dialog2-legacy/src/main/java/org/apache/shale/dialog2/legacy/model/Dialog.java
(original)
+++
shale/sandbox/shale-dialog2-legacy/src/main/java/org/apache/shale/dialog2/legacy/model/Dialog.java
Tue Sep 26 18:18:28 2006
@@ -57,12 +57,17 @@
* <p><strong>IMPLEMENTATION NOTE</strong> - Because the <code>data</code>
* object of <code>DialogContext</code> instances is stored in session
* scope, the <code>Class</code> specified here should be serializable.</p>
+ *
+ * @return The JavaBean class whose instance becomes the <code>data</code>
+ * property of a new instance of this dialog
*/
public Class getDataClass();
/**
* <p>Return the name of this [EMAIL PROTECTED] Dialog}.</p>
+ *
+ * @return The name of this [EMAIL PROTECTED] Dialog}
*/
public String getName();
@@ -70,6 +75,8 @@
/**
* <p>Return the name of the starting [EMAIL PROTECTED] State} for this
* [EMAIL PROTECTED] Dialog}.</p>
+ *
+ * @return The starting state associated with this [EMAIL PROTECTED]
Dialog}
*/
public String getStart();
@@ -78,6 +85,9 @@
* <p>Return an <code>Iterator</code> over the names of [EMAIL PROTECTED]
State}s
* that are owned by this [EMAIL PROTECTED] Dialog}. If there are no such
* [EMAIL PROTECTED] State}s, an empty <code>Iterator</code> is
returned.</p>
+ *
+ * @return An <code>Iterator</code> over all the [EMAIL PROTECTED] State}s
in this
+ * [EMAIL PROTECTED] Dialog}
*/
public Iterator getStateIds();
@@ -87,6 +97,9 @@
* global [EMAIL PROTECTED] Transition}s for this [EMAIL PROTECTED]
Dialog}. If there are
* no such [EMAIL PROTECTED] Transition}s, an empty <code>Iterator</code>
is
* returned.</p>
+ *
+ * @return An <code>Iterator</code> over the logical outcomes of global
+ * [EMAIL PROTECTED] Transition}s for this [EMAIL PROTECTED]
Dialog}
*/
public Iterator getTransitionOutcomes();
@@ -99,6 +112,7 @@
* if any. Otherwise, return <code>null</code>.</p>
*
* @param id Identifier of the requested [EMAIL PROTECTED] State}
+ * @return The [EMAIL PROTECTED] State} specified by the identifier, may
be null
*/
public State findState(String id);
@@ -108,6 +122,7 @@
* if any; otherwise, return <code>null</code>.</p>
*
* @param outcome Logical outcome for which to return a [EMAIL PROTECTED]
Transition}
+ * @return The global [EMAIL PROTECTED] Transition} for the specified
logical outcome
*/
public Transition findTransition(String outcome);
Modified:
shale/sandbox/shale-dialog2-legacy/src/main/java/org/apache/shale/dialog2/legacy/model/State.java
URL:
http://svn.apache.org/viewvc/shale/sandbox/shale-dialog2-legacy/src/main/java/org/apache/shale/dialog2/legacy/model/State.java?view=diff&rev=450272&r1=450271&r2=450272
==============================================================================
---
shale/sandbox/shale-dialog2-legacy/src/main/java/org/apache/shale/dialog2/legacy/model/State.java
(original)
+++
shale/sandbox/shale-dialog2-legacy/src/main/java/org/apache/shale/dialog2/legacy/model/State.java
Tue Sep 26 18:18:28 2006
@@ -48,6 +48,8 @@
/**
* <p>Return the [EMAIL PROTECTED] Dialog} that owns this [EMAIL
PROTECTED] State}.</p>
+ *
+ * @return The [EMAIL PROTECTED] Dialog} this [EMAIL PROTECTED] State}
belongs to
*/
public Dialog getDialog();
@@ -55,6 +57,8 @@
/**
* <p>Return the identifier of this [EMAIL PROTECTED] State}, which must
be unique
* among the [EMAIL PROTECTED] State}s owned by the same [EMAIL PROTECTED]
Dialog}.</p>
+ *
+ * @return The identifier for this [EMAIL PROTECTED] State}
*/
public String getName();
@@ -64,6 +68,9 @@
* local [EMAIL PROTECTED] Transition}s for this [EMAIL PROTECTED] State}.
If there are
* no such [EMAIL PROTECTED] Transition}s, an empty <code>Iterator</code>
is
* returned.</p>
+ *
+ * @return An [EMAIL PROTECTED] Iterator} over the logical outcomes of
local
+ * [EMAIL PROTECTED] Transition}s for this [EMAIL PROTECTED] State}
*/
public Iterator getTransitionOutcomes();
@@ -76,6 +83,7 @@
* if any; otherwise, return <code>null</code>.</p>
*
* @param outcome Logical outcome for which to return a [EMAIL PROTECTED]
Transition}
+ * @return The [EMAIL PROTECTED] Transition} for the specified outcome,
may be null
*/
public Transition findTransition(String outcome);
Modified:
shale/sandbox/shale-dialog2-legacy/src/main/java/org/apache/shale/dialog2/legacy/model/SubdialogState.java
URL:
http://svn.apache.org/viewvc/shale/sandbox/shale-dialog2-legacy/src/main/java/org/apache/shale/dialog2/legacy/model/SubdialogState.java?view=diff&rev=450272&r1=450271&r2=450272
==============================================================================
---
shale/sandbox/shale-dialog2-legacy/src/main/java/org/apache/shale/dialog2/legacy/model/SubdialogState.java
(original)
+++
shale/sandbox/shale-dialog2-legacy/src/main/java/org/apache/shale/dialog2/legacy/model/SubdialogState.java
Tue Sep 26 18:18:28 2006
@@ -32,6 +32,8 @@
/**
* <p>Return the name of the subordinate dialog to be executed
* by this state.</p>
+ *
+ * @return The name of the subdialog to be executed
*/
public String getDialogName();
Modified:
shale/sandbox/shale-dialog2-legacy/src/main/java/org/apache/shale/dialog2/legacy/model/Transition.java
URL:
http://svn.apache.org/viewvc/shale/sandbox/shale-dialog2-legacy/src/main/java/org/apache/shale/dialog2/legacy/model/Transition.java?view=diff&rev=450272&r1=450271&r2=450272
==============================================================================
---
shale/sandbox/shale-dialog2-legacy/src/main/java/org/apache/shale/dialog2/legacy/model/Transition.java
(original)
+++
shale/sandbox/shale-dialog2-legacy/src/main/java/org/apache/shale/dialog2/legacy/model/Transition.java
Tue Sep 26 18:18:28 2006
@@ -32,6 +32,9 @@
/**
* <p>Return the logical outcome used to select this [EMAIL PROTECTED]
Transition}.</p>
+ *
+ * @return The logical outcome that causes this [EMAIL PROTECTED]
Transition} to be
+ * followed
*/
public String getOutcome();
@@ -39,6 +42,8 @@
/**
* <p>Return the target [EMAIL PROTECTED] State} identifier for this
* [EMAIL PROTECTED] Transition}.</p>
+ *
+ * @return The identifier of the target [EMAIL PROTECTED] State}
*/
public String getTarget();
Modified:
shale/sandbox/shale-dialog2-legacy/src/main/java/org/apache/shale/dialog2/legacy/model/ViewState.java
URL:
http://svn.apache.org/viewvc/shale/sandbox/shale-dialog2-legacy/src/main/java/org/apache/shale/dialog2/legacy/model/ViewState.java?view=diff&rev=450272&r1=450271&r2=450272
==============================================================================
---
shale/sandbox/shale-dialog2-legacy/src/main/java/org/apache/shale/dialog2/legacy/model/ViewState.java
(original)
+++
shale/sandbox/shale-dialog2-legacy/src/main/java/org/apache/shale/dialog2/legacy/model/ViewState.java
Tue Sep 26 18:18:28 2006
@@ -35,6 +35,8 @@
/**
* <p>Return the view identifier of the JavaServer Faces view to render
* if this state is entered.</p>
+ *
+ * @return The view identifier of the JavaServer Faces view to render
*/
public String getViewId();
