Brought common.runtime up to jdt warning preferences for common and fixed resulting issues.
diff --git a/jsf/plugins/org.eclipse.jst.jsf.common.runtime/.settings/org.eclipse.jdt.core.prefs b/jsf/plugins/org.eclipse.jst.jsf.common.runtime/.settings/org.eclipse.jdt.core.prefs
index a1a8746..4f79f7b 100644
--- a/jsf/plugins/org.eclipse.jst.jsf.common.runtime/.settings/org.eclipse.jdt.core.prefs
+++ b/jsf/plugins/org.eclipse.jst.jsf.common.runtime/.settings/org.eclipse.jdt.core.prefs
@@ -1,11 +1,17 @@
-#Tue Oct 23 09:14:07 PDT 2007
+#Wed Jan 09 14:34:02 PST 2008
eclipse.preferences.version=1
+org.eclipse.jdt.core.compiler.codegen.inlineJsrBytecode=disabled
org.eclipse.jdt.core.compiler.codegen.targetPlatform=1.2
+org.eclipse.jdt.core.compiler.codegen.unusedLocal=preserve
org.eclipse.jdt.core.compiler.compliance=1.4
+org.eclipse.jdt.core.compiler.debug.lineNumber=generate
+org.eclipse.jdt.core.compiler.debug.localVariable=generate
+org.eclipse.jdt.core.compiler.debug.sourceFile=generate
+org.eclipse.jdt.core.compiler.doc.comment.support=enabled
org.eclipse.jdt.core.compiler.problem.annotationSuperInterface=warning
org.eclipse.jdt.core.compiler.problem.assertIdentifier=warning
-org.eclipse.jdt.core.compiler.problem.autoboxing=ignore
-org.eclipse.jdt.core.compiler.problem.deprecation=warning
+org.eclipse.jdt.core.compiler.problem.autoboxing=warning
+org.eclipse.jdt.core.compiler.problem.deprecation=error
org.eclipse.jdt.core.compiler.problem.deprecationInDeprecatedCode=disabled
org.eclipse.jdt.core.compiler.problem.deprecationWhenOverridingDeprecatedMethod=disabled
org.eclipse.jdt.core.compiler.problem.discouragedReference=ignore
@@ -13,17 +19,28 @@
org.eclipse.jdt.core.compiler.problem.enumIdentifier=warning
org.eclipse.jdt.core.compiler.problem.fallthroughCase=ignore
org.eclipse.jdt.core.compiler.problem.fatalOptionalError=enabled
-org.eclipse.jdt.core.compiler.problem.fieldHiding=ignore
+org.eclipse.jdt.core.compiler.problem.fieldHiding=warning
org.eclipse.jdt.core.compiler.problem.finalParameterBound=warning
org.eclipse.jdt.core.compiler.problem.finallyBlockNotCompletingNormally=warning
org.eclipse.jdt.core.compiler.problem.forbiddenReference=error
org.eclipse.jdt.core.compiler.problem.hiddenCatchBlock=warning
org.eclipse.jdt.core.compiler.problem.incompatibleNonInheritedInterfaceMethod=warning
-org.eclipse.jdt.core.compiler.problem.incompleteEnumSwitch=ignore
+org.eclipse.jdt.core.compiler.problem.incompleteEnumSwitch=warning
org.eclipse.jdt.core.compiler.problem.indirectStaticAccess=ignore
-org.eclipse.jdt.core.compiler.problem.localVariableHiding=ignore
+org.eclipse.jdt.core.compiler.problem.invalidJavadoc=error
+org.eclipse.jdt.core.compiler.problem.invalidJavadocTags=enabled
+org.eclipse.jdt.core.compiler.problem.invalidJavadocTagsDeprecatedRef=disabled
+org.eclipse.jdt.core.compiler.problem.invalidJavadocTagsNotVisibleRef=disabled
+org.eclipse.jdt.core.compiler.problem.invalidJavadocTagsVisibility=protected
+org.eclipse.jdt.core.compiler.problem.localVariableHiding=warning
org.eclipse.jdt.core.compiler.problem.methodWithConstructorName=warning
org.eclipse.jdt.core.compiler.problem.missingDeprecatedAnnotation=ignore
+org.eclipse.jdt.core.compiler.problem.missingJavadocComments=warning
+org.eclipse.jdt.core.compiler.problem.missingJavadocCommentsOverriding=disabled
+org.eclipse.jdt.core.compiler.problem.missingJavadocCommentsVisibility=protected
+org.eclipse.jdt.core.compiler.problem.missingJavadocTags=warning
+org.eclipse.jdt.core.compiler.problem.missingJavadocTagsOverriding=disabled
+org.eclipse.jdt.core.compiler.problem.missingJavadocTagsVisibility=protected
org.eclipse.jdt.core.compiler.problem.missingOverrideAnnotation=ignore
org.eclipse.jdt.core.compiler.problem.missingSerialVersion=warning
org.eclipse.jdt.core.compiler.problem.noEffectAssignment=warning
@@ -32,31 +49,31 @@
org.eclipse.jdt.core.compiler.problem.nullReference=ignore
org.eclipse.jdt.core.compiler.problem.overridingPackageDefaultMethod=warning
org.eclipse.jdt.core.compiler.problem.parameterAssignment=ignore
-org.eclipse.jdt.core.compiler.problem.possibleAccidentalBooleanAssignment=ignore
+org.eclipse.jdt.core.compiler.problem.possibleAccidentalBooleanAssignment=warning
org.eclipse.jdt.core.compiler.problem.potentialNullReference=ignore
-org.eclipse.jdt.core.compiler.problem.rawTypeReference=warning
+org.eclipse.jdt.core.compiler.problem.rawTypeReference=ignore
org.eclipse.jdt.core.compiler.problem.redundantNullCheck=ignore
org.eclipse.jdt.core.compiler.problem.specialParameterHidingField=disabled
org.eclipse.jdt.core.compiler.problem.staticAccessReceiver=warning
org.eclipse.jdt.core.compiler.problem.suppressWarnings=enabled
org.eclipse.jdt.core.compiler.problem.syntheticAccessEmulation=ignore
-org.eclipse.jdt.core.compiler.problem.typeParameterHiding=warning
-org.eclipse.jdt.core.compiler.problem.uncheckedTypeOperation=warning
-org.eclipse.jdt.core.compiler.problem.undocumentedEmptyBlock=ignore
+org.eclipse.jdt.core.compiler.problem.typeParameterHiding=ignore
+org.eclipse.jdt.core.compiler.problem.uncheckedTypeOperation=ignore
+org.eclipse.jdt.core.compiler.problem.undocumentedEmptyBlock=error
org.eclipse.jdt.core.compiler.problem.unhandledWarningToken=warning
-org.eclipse.jdt.core.compiler.problem.unnecessaryElse=ignore
-org.eclipse.jdt.core.compiler.problem.unnecessaryTypeCheck=ignore
+org.eclipse.jdt.core.compiler.problem.unnecessaryElse=warning
+org.eclipse.jdt.core.compiler.problem.unnecessaryTypeCheck=warning
org.eclipse.jdt.core.compiler.problem.unqualifiedFieldAccess=ignore
-org.eclipse.jdt.core.compiler.problem.unusedDeclaredThrownException=ignore
+org.eclipse.jdt.core.compiler.problem.unusedDeclaredThrownException=warning
org.eclipse.jdt.core.compiler.problem.unusedDeclaredThrownExceptionIncludeDocCommentReference=enabled
org.eclipse.jdt.core.compiler.problem.unusedDeclaredThrownExceptionWhenOverriding=disabled
-org.eclipse.jdt.core.compiler.problem.unusedImport=warning
+org.eclipse.jdt.core.compiler.problem.unusedImport=error
org.eclipse.jdt.core.compiler.problem.unusedLabel=warning
-org.eclipse.jdt.core.compiler.problem.unusedLocal=warning
+org.eclipse.jdt.core.compiler.problem.unusedLocal=error
org.eclipse.jdt.core.compiler.problem.unusedParameter=ignore
org.eclipse.jdt.core.compiler.problem.unusedParameterIncludeDocCommentReference=enabled
org.eclipse.jdt.core.compiler.problem.unusedParameterWhenImplementingAbstract=disabled
org.eclipse.jdt.core.compiler.problem.unusedParameterWhenOverridingConcrete=disabled
-org.eclipse.jdt.core.compiler.problem.unusedPrivateMember=warning
+org.eclipse.jdt.core.compiler.problem.unusedPrivateMember=error
org.eclipse.jdt.core.compiler.problem.varargsArgumentNeedCast=warning
org.eclipse.jdt.core.compiler.source=1.3
diff --git a/jsf/plugins/org.eclipse.jst.jsf.common.runtime/src/org/eclipse/jst/jsf/common/runtime/internal/JSFCommonRuntimePlugin.java b/jsf/plugins/org.eclipse.jst.jsf.common.runtime/src/org/eclipse/jst/jsf/common/runtime/internal/JSFCommonRuntimePlugin.java
index f7724d0..d17c6f5 100644
--- a/jsf/plugins/org.eclipse.jst.jsf.common.runtime/src/org/eclipse/jst/jsf/common/runtime/internal/JSFCommonRuntimePlugin.java
+++ b/jsf/plugins/org.eclipse.jst.jsf.common.runtime/src/org/eclipse/jst/jsf/common/runtime/internal/JSFCommonRuntimePlugin.java
@@ -11,45 +11,52 @@
*/
public class JSFCommonRuntimePlugin extends Plugin {
- // The plug-in ID
- public static final String PLUGIN_ID = "CommonComponentPlugin";
+ /**
+ * The plug-in ID
+ */
+ public static final String PLUGIN_ID = "CommonComponentPlugin";
- // The shared instance
- private static JSFCommonRuntimePlugin plugin;
-
- /**
- * The constructor
- */
- public JSFCommonRuntimePlugin() {
- }
+ // The shared instance
+ private static JSFCommonRuntimePlugin plugin;
- /*
- * (non-Javadoc)
- * @see org.eclipse.ui.plugin.AbstractUIPlugin#start(org.osgi.framework.BundleContext)
- */
- public void start(final BundleContext context) throws Exception {
- super.start(context);
- plugin = this;
- }
+ /**
+ * The constructor
+ */
+ public JSFCommonRuntimePlugin() {
+ // empty constructor
+ }
- /*
- * (non-Javadoc)
- * @see org.eclipse.ui.plugin.AbstractUIPlugin#stop(org.osgi.framework.BundleContext)
- */
- public void stop(final BundleContext context) throws Exception {
- plugin = null;
- super.stop(context);
- }
+ /*
+ * (non-Javadoc)
+ * @see org.eclipse.ui.plugin.AbstractUIPlugin#start(org.osgi.framework.BundleContext)
+ */
+ public void start(final BundleContext context) throws Exception {
+ super.start(context);
+ plugin = this;
+ }
- /**
- * Returns the shared instance
- *
- * @return the shared instance
- */
- public static JSFCommonRuntimePlugin getDefault() {
- return plugin;
- }
+ /*
+ * (non-Javadoc)
+ * @see org.eclipse.ui.plugin.AbstractUIPlugin#stop(org.osgi.framework.BundleContext)
+ */
+ public void stop(final BundleContext context) throws Exception {
+ plugin = null;
+ super.stop(context);
+ }
+ /**
+ * Returns the shared instance
+ *
+ * @return the shared instance
+ */
+ public static JSFCommonRuntimePlugin getDefault() {
+ return plugin;
+ }
+
+ /**
+ * @param message
+ * @param t
+ */
public static void log(final String message, final Throwable t)
{
final ILog log = getDefault().getLog();
diff --git a/jsf/plugins/org.eclipse.jst.jsf.common.runtime/src/org/eclipse/jst/jsf/common/runtime/internal/debug/ComponentTreeMessage.java b/jsf/plugins/org.eclipse.jst.jsf.common.runtime/src/org/eclipse/jst/jsf/common/runtime/internal/debug/ComponentTreeMessage.java
index c24e1d5..7507739 100644
--- a/jsf/plugins/org.eclipse.jst.jsf.common.runtime/src/org/eclipse/jst/jsf/common/runtime/internal/debug/ComponentTreeMessage.java
+++ b/jsf/plugins/org.eclipse.jst.jsf.common.runtime/src/org/eclipse/jst/jsf/common/runtime/internal/debug/ComponentTreeMessage.java
@@ -3,6 +3,12 @@
import org.eclipse.jst.jsf.common.runtime.internal.model.component.ComponentInfo;
+/**
+ * Represents a component tree in message for that can be serialized.
+ *
+ * @author cbateman
+ *
+ */
public class ComponentTreeMessage extends JSFMonitorMessage
{
/**
@@ -14,19 +20,31 @@
private RenderNode _renderRoot;
// private HashMap<String, ComponentInfo> _idIndex;
+ /**
+ * default constructor
+ */
public ComponentTreeMessage()
{
//_idIndex = new HashMap<String, ComponentInfo>();
}
+ /**
+ * @return the view id
+ */
public final String getViewId() {
return _viewId;
}
+ /**
+ * @return the componentinfo at the root of the component tree
+ */
public final ComponentInfo getTreeRoot() {
return _treeRoot;
}
+ /**
+ * @return the rendered root node
+ */
public final RenderNode getRenderRoot() {
return _renderRoot;
}
diff --git a/jsf/plugins/org.eclipse.jst.jsf.common.runtime/src/org/eclipse/jst/jsf/common/runtime/internal/debug/MonitorMessageFactory.java b/jsf/plugins/org.eclipse.jst.jsf.common.runtime/src/org/eclipse/jst/jsf/common/runtime/internal/debug/MonitorMessageFactory.java
index 19d5c5e..eef2154 100644
--- a/jsf/plugins/org.eclipse.jst.jsf.common.runtime/src/org/eclipse/jst/jsf/common/runtime/internal/debug/MonitorMessageFactory.java
+++ b/jsf/plugins/org.eclipse.jst.jsf.common.runtime/src/org/eclipse/jst/jsf/common/runtime/internal/debug/MonitorMessageFactory.java
@@ -2,8 +2,20 @@
import org.eclipse.jst.jsf.common.runtime.internal.model.component.ComponentInfo;
+/**
+ * Creates JSF remote monitor messages.
+ *
+ * @author cbateman
+ *
+ */
public class MonitorMessageFactory
{
+ /**
+ * @param viewId
+ * @param root
+ * @param renderRoot
+ * @return a new component tree message for the parameters
+ */
public static ComponentTreeMessage createTreeMessage(final String viewId, final ComponentInfo root, final RenderNode renderRoot)
{
ComponentTreeMessage message = new ComponentTreeMessage();
diff --git a/jsf/plugins/org.eclipse.jst.jsf.common.runtime/src/org/eclipse/jst/jsf/common/runtime/internal/debug/RenderAttribute.java b/jsf/plugins/org.eclipse.jst.jsf.common.runtime/src/org/eclipse/jst/jsf/common/runtime/internal/debug/RenderAttribute.java
index 910fbc5..1a763f6 100644
--- a/jsf/plugins/org.eclipse.jst.jsf.common.runtime/src/org/eclipse/jst/jsf/common/runtime/internal/debug/RenderAttribute.java
+++ b/jsf/plugins/org.eclipse.jst.jsf.common.runtime/src/org/eclipse/jst/jsf/common/runtime/internal/debug/RenderAttribute.java
@@ -1,5 +1,11 @@
package org.eclipse.jst.jsf.common.runtime.internal.debug;
+/**
+ * Information about a rendered XML attribute
+ *
+ * @author cbateman
+ *
+ */
public class RenderAttribute extends JSFMonitorMessage {
/**
@@ -11,18 +17,32 @@
private final String _value; // the rendered value of the node
private final String _propertyName; // the property name on the corresponding component
// may be null
+ /**
+ * @param name
+ * @param value
+ * @param propertyName
+ */
public RenderAttribute(String name, String value, String propertyName) {
super();
_name = name;
_propertyName = propertyName;
_value = value;
}
+ /**
+ * @return the name of the attribute
+ */
public final String getName() {
return _name;
}
+ /**
+ * @return the attribute's value
+ */
public final String getValue() {
return _value;
}
+ /**
+ * @return the name of the corresponding component property if any.
+ */
public final String getPropertyName() {
return _propertyName;
}
diff --git a/jsf/plugins/org.eclipse.jst.jsf.common.runtime/src/org/eclipse/jst/jsf/common/runtime/internal/debug/RenderNode.java b/jsf/plugins/org.eclipse.jst.jsf.common.runtime/src/org/eclipse/jst/jsf/common/runtime/internal/debug/RenderNode.java
index d2ff6ef..1096f9d 100644
--- a/jsf/plugins/org.eclipse.jst.jsf.common.runtime/src/org/eclipse/jst/jsf/common/runtime/internal/debug/RenderNode.java
+++ b/jsf/plugins/org.eclipse.jst.jsf.common.runtime/src/org/eclipse/jst/jsf/common/runtime/internal/debug/RenderNode.java
@@ -4,6 +4,12 @@
import java.util.Iterator;
import java.util.List;
+/**
+ * A rendered XML node.
+ *
+ * @author cbateman
+ *
+ */
public class RenderNode extends JSFMonitorMessage
{
/**
@@ -16,6 +22,10 @@
private final List/*<RenderedAttribute>*/ _renderedAttributes; // attributes
private final List _children; // the rendered children of renderedNode based
// on the output document hiearchy
+ /**
+ * @param componentId
+ * @param renderedNodeName
+ */
public RenderNode(String componentId, String renderedNodeName) {
super();
_componentId = componentId;
@@ -24,15 +34,27 @@
_children = new ArrayList();
_renderedAttributes = new ArrayList();
}
+ /**
+ * @return the corresponding component's id
+ */
public final String getComponentId() {
return _componentId;
}
+ /**
+ * @return the node's children
+ */
public final List getChildren() {
return _children;
}
+ /**
+ * @return the name of the rendered node (element)
+ */
public final String getRenderedNodeName() {
return _renderedNodeName;
}
+ /**
+ * @return the attributes of this node as rendered.
+ */
public final List getRenderedAttributes() {
return _renderedAttributes;
}
diff --git a/jsf/plugins/org.eclipse.jst.jsf.common.runtime/src/org/eclipse/jst/jsf/common/runtime/internal/model/ViewObject.java b/jsf/plugins/org.eclipse.jst.jsf.common.runtime/src/org/eclipse/jst/jsf/common/runtime/internal/model/ViewObject.java
index c4de29e..64c28b7 100644
--- a/jsf/plugins/org.eclipse.jst.jsf.common.runtime/src/org/eclipse/jst/jsf/common/runtime/internal/model/ViewObject.java
+++ b/jsf/plugins/org.eclipse.jst.jsf.common.runtime/src/org/eclipse/jst/jsf/common/runtime/internal/model/ViewObject.java
@@ -62,9 +62,8 @@
if (decorators == null) {
return Collections.EMPTY_LIST;
- } else {
- return Collections.unmodifiableList(decorators);
}
+ return Collections.unmodifiableList(decorators);
}
/**
diff --git a/jsf/plugins/org.eclipse.jst.jsf.common.runtime/src/org/eclipse/jst/jsf/common/runtime/internal/model/bean/DataModelInfo.java b/jsf/plugins/org.eclipse.jst.jsf.common.runtime/src/org/eclipse/jst/jsf/common/runtime/internal/model/bean/DataModelInfo.java
index aaaedff..b07a1bd 100644
--- a/jsf/plugins/org.eclipse.jst.jsf.common.runtime/src/org/eclipse/jst/jsf/common/runtime/internal/model/bean/DataModelInfo.java
+++ b/jsf/plugins/org.eclipse.jst.jsf.common.runtime/src/org/eclipse/jst/jsf/common/runtime/internal/model/bean/DataModelInfo.java
@@ -21,6 +21,13 @@
private final int _rowIndex;
private final SerializableObject _wrappedData;
+ /**
+ * @param rowAvailable
+ * @param rowCount
+ * @param rowData
+ * @param rowIndex
+ * @param wrappedData
+ */
public DataModelInfo(boolean rowAvailable, int rowCount, Object rowData,
int rowIndex, Object wrappedData) {
super();
@@ -31,18 +38,34 @@
_wrappedData = new SerializableObject(wrappedData);
}
+ /**
+ * @return true if the current row is available
+ */
public final boolean isRowAvailable() {
return _rowAvailable;
}
+ /**
+ * @return the row count of this model
+ */
public final int getRowCount() {
return _rowCount;
}
+ /**
+ * @return the row data
+ */
public final Object getRowData() {
return _rowData.getMaybeSerializable();
}
+ /**
+ * @return the row index
+ */
public final int getRowIndex() {
return _rowIndex;
}
+ /**
+ * @return the wrapped data. may be null if wrapped object was not
+ * serializable.
+ */
public final Object getWrappedData() {
return _wrappedData.getMaybeSerializable();
}
diff --git a/jsf/plugins/org.eclipse.jst.jsf.common.runtime/src/org/eclipse/jst/jsf/common/runtime/internal/model/bean/SerializableObject.java b/jsf/plugins/org.eclipse.jst.jsf.common.runtime/src/org/eclipse/jst/jsf/common/runtime/internal/model/bean/SerializableObject.java
index 9488d75..85c222e 100644
--- a/jsf/plugins/org.eclipse.jst.jsf.common.runtime/src/org/eclipse/jst/jsf/common/runtime/internal/model/bean/SerializableObject.java
+++ b/jsf/plugins/org.eclipse.jst.jsf.common.runtime/src/org/eclipse/jst/jsf/common/runtime/internal/model/bean/SerializableObject.java
@@ -20,6 +20,9 @@
private static final long serialVersionUID = 9133733048469500692L;
private Object _maybeSerializable;
+ /**
+ * @param maybeSerializable
+ */
public SerializableObject(Object maybeSerializable)
{
_maybeSerializable = maybeSerializable;
@@ -35,6 +38,9 @@
// _maybeSerializable = null;
// }
+ /**
+ * @return the actual value
+ */
public final Object getMaybeSerializable() {
return _maybeSerializable;
}
diff --git a/jsf/plugins/org.eclipse.jst.jsf.common.runtime/src/org/eclipse/jst/jsf/common/runtime/internal/model/behavioural/ActionSourceInfo.java b/jsf/plugins/org.eclipse.jst.jsf.common.runtime/src/org/eclipse/jst/jsf/common/runtime/internal/model/behavioural/ActionSourceInfo.java
index e6536a1..c0e0ea2 100644
--- a/jsf/plugins/org.eclipse.jst.jsf.common.runtime/src/org/eclipse/jst/jsf/common/runtime/internal/model/behavioural/ActionSourceInfo.java
+++ b/jsf/plugins/org.eclipse.jst.jsf.common.runtime/src/org/eclipse/jst/jsf/common/runtime/internal/model/behavioural/ActionSourceInfo.java
@@ -6,6 +6,12 @@
import org.eclipse.jst.jsf.common.runtime.internal.model.decorator.ActionListenerDecorator;
+/**
+ * Implementation of the ActionSourceInfo.
+ *
+ * @author cbateman
+ *
+ */
public class ActionSourceInfo implements IActionSourceInfo
{
/**
@@ -18,6 +24,11 @@
private final boolean _immediate;
private List/*<ActionListenerDecorator>*/ _actionListeners;
+ /**
+ * @param action
+ * @param actionListener
+ * @param immediate
+ */
public ActionSourceInfo(final String action, final String actionListener,
final boolean immediate)
{
diff --git a/jsf/plugins/org.eclipse.jst.jsf.common.runtime/src/org/eclipse/jst/jsf/common/runtime/internal/model/behavioural/ActionSourceInfo2.java b/jsf/plugins/org.eclipse.jst.jsf.common.runtime/src/org/eclipse/jst/jsf/common/runtime/internal/model/behavioural/ActionSourceInfo2.java
index 34492aa..0815a07 100644
--- a/jsf/plugins/org.eclipse.jst.jsf.common.runtime/src/org/eclipse/jst/jsf/common/runtime/internal/model/behavioural/ActionSourceInfo2.java
+++ b/jsf/plugins/org.eclipse.jst.jsf.common.runtime/src/org/eclipse/jst/jsf/common/runtime/internal/model/behavioural/ActionSourceInfo2.java
@@ -1,5 +1,11 @@
package org.eclipse.jst.jsf.common.runtime.internal.model.behavioural;
+/**
+ * Implementation of the IActionSource2Info
+ *
+ * @author cbateman
+ *
+ */
public class ActionSourceInfo2 extends ActionSourceInfo implements
IActionSource2Info
{
@@ -9,6 +15,12 @@
private static final long serialVersionUID = 5811194815559772378L;
private final String _actionExpression;
+ /**
+ * @param action
+ * @param actionListener
+ * @param immediate
+ * @param actionExpression
+ */
public ActionSourceInfo2(final String action, final String actionListener,
final boolean immediate, final String actionExpression) {
super(action, actionListener, immediate);
diff --git a/jsf/plugins/org.eclipse.jst.jsf.common.runtime/src/org/eclipse/jst/jsf/common/runtime/internal/model/behavioural/EditableValueHolderInfo.java b/jsf/plugins/org.eclipse.jst.jsf.common.runtime/src/org/eclipse/jst/jsf/common/runtime/internal/model/behavioural/EditableValueHolderInfo.java
index 21022a9..d9b9689 100644
--- a/jsf/plugins/org.eclipse.jst.jsf.common.runtime/src/org/eclipse/jst/jsf/common/runtime/internal/model/behavioural/EditableValueHolderInfo.java
+++ b/jsf/plugins/org.eclipse.jst.jsf.common.runtime/src/org/eclipse/jst/jsf/common/runtime/internal/model/behavioural/EditableValueHolderInfo.java
@@ -8,6 +8,12 @@
import org.eclipse.jst.jsf.common.runtime.internal.model.decorator.ValidatorDecorator;
import org.eclipse.jst.jsf.common.runtime.internal.model.decorator.ValueChangeListenerDecorator;
+/**
+ * Implementation of the IEditableValueHolderInfo
+ *
+ * @author cbateman
+ *
+ */
public class EditableValueHolderInfo extends ValueHolderInfo implements
IEditableValueHolderInfo
{
@@ -26,6 +32,18 @@
private List _validators;
private List _valueChangeListeners;
+ /**
+ * @param converterDecorator
+ * @param localValue
+ * @param value
+ * @param isImmediate
+ * @param isRequired
+ * @param isValid
+ * @param localSetValue
+ * @param submittedValue
+ * @param validator
+ * @param valueChangeListener
+ */
public EditableValueHolderInfo(final ConverterDecorator converterDecorator,
final Object localValue, final Object value, final boolean isImmediate,
final boolean isRequired, final boolean isValid, final boolean localSetValue,
diff --git a/jsf/plugins/org.eclipse.jst.jsf.common.runtime/src/org/eclipse/jst/jsf/common/runtime/internal/model/behavioural/ValueHolderInfo.java b/jsf/plugins/org.eclipse.jst.jsf.common.runtime/src/org/eclipse/jst/jsf/common/runtime/internal/model/behavioural/ValueHolderInfo.java
index 1cab437..2a1ee6c 100644
--- a/jsf/plugins/org.eclipse.jst.jsf.common.runtime/src/org/eclipse/jst/jsf/common/runtime/internal/model/behavioural/ValueHolderInfo.java
+++ b/jsf/plugins/org.eclipse.jst.jsf.common.runtime/src/org/eclipse/jst/jsf/common/runtime/internal/model/behavioural/ValueHolderInfo.java
@@ -2,6 +2,12 @@
import org.eclipse.jst.jsf.common.runtime.internal.model.decorator.ConverterDecorator;
+/**
+ * Implementation of the IValueHolderInfo.
+ *
+ * @author cbateman
+ *
+ */
public class ValueHolderInfo implements IValueHolderInfo
{
/**
@@ -9,10 +15,24 @@
*/
private static final long serialVersionUID = 5000699728360703727L;
+ /**
+ * the value (may include EL evaluation)
+ */
protected final Object _value;
+ /**
+ * the raw value before EL evaluation.
+ */
protected final Object _localValue;
+ /**
+ * the converter or null if none.
+ */
protected final ConverterDecorator _converterDecorator;
+ /**
+ * @param converterDecorator
+ * @param localValue
+ * @param value
+ */
public ValueHolderInfo(final ConverterDecorator converterDecorator,
final Object localValue, final Object value) {
super();
diff --git a/jsf/plugins/org.eclipse.jst.jsf.common.runtime/src/org/eclipse/jst/jsf/common/runtime/internal/model/component/ComponentFactory.java b/jsf/plugins/org.eclipse.jst.jsf.common.runtime/src/org/eclipse/jst/jsf/common/runtime/internal/model/component/ComponentFactory.java
index dc135f2..fd8bd4d 100644
--- a/jsf/plugins/org.eclipse.jst.jsf.common.runtime/src/org/eclipse/jst/jsf/common/runtime/internal/model/component/ComponentFactory.java
+++ b/jsf/plugins/org.eclipse.jst.jsf.common.runtime/src/org/eclipse/jst/jsf/common/runtime/internal/model/component/ComponentFactory.java
@@ -12,25 +12,78 @@
import org.eclipse.jst.jsf.common.runtime.internal.model.event.IActionListenerInfo;
import org.eclipse.jst.jsf.common.runtime.internal.model.event.IValueChangeListenerInfo;
+/**
+ * Factory for creating component related objects.
+ *
+ * @author cbateman
+ *
+ */
public class ComponentFactory {
+ /**
+ * The key for the standard ValueHolder adapter interface
+ */
public final static Class VALUE_HOLDER = IValueHolderInfo.class;
+ /**
+ * The key for the standard EditableValueHolder adapter interface
+ */
public final static Class EDITABLE_VALUE_HOLDER = IEditableValueHolderInfo.class;
+ /**
+ * The key for the standard ActionSource adapter interface
+ */
public final static Class ACTION_SOURCE = IActionSourceInfo.class;
+ /**
+ * The key for the standard ActionSource2 adapter interface
+ */
public final static Class ACTION_SOURCE2 = IActionSource2Info.class;
- public final static Class CONVERTER = ConverterDecorator.class;
- public final static Class FACET = FacetDecorator.class;
- public final static Class VALIDATOR = ValidatorDecorator.class;
- public final static Class VALUE_CHANGE_LISTENER = IValueChangeListenerInfo.class;
- public final static Class ACTION_LISTENER = IActionListenerInfo.class;
+ /**
+ * The key for the standard NamingContainer adapter interface
+ */
public final static Class NAMING_CONTAINER = INamingContainerInfo.class;
+
+ /**
+ * The key for the standard Converter decorator
+ */
+ public final static Class CONVERTER = ConverterDecorator.class;
+ /**
+ * The key for the standard Facet decorator
+ */
+ public final static Class FACET = FacetDecorator.class;
+ /**
+ * The key for the standard Validator decorator
+ */
+ public final static Class VALIDATOR = ValidatorDecorator.class;
+ /**
+ * The key for the standard ValueChangeListener decorator
+ */
+ public final static Class VALUE_CHANGE_LISTENER = IValueChangeListenerInfo.class;
+ /**
+ * The key for the standard ActionListener decorator
+ */
+ public final static Class ACTION_LISTENER = IActionListenerInfo.class;
+
+ /**
+ * @param id
+ * @param parent
+ * @param typeInfo
+ * @param isRendered
+ * @return a new component info
+ */
public static ComponentInfo createComponentInfo(final String id,
final ComponentInfo parent, final ComponentTypeInfo typeInfo,
final boolean isRendered) {
return new ComponentInfo(id, parent, typeInfo, isRendered);
}
+ /**
+ * @param id
+ * @param parent
+ * @param typeInfo
+ * @param editableValueHolder
+ * @param isRendered
+ * @return a new UIInputInfo
+ */
public static UIInputInfo createUIInputInfo(final String id,
final ComponentInfo parent, final ComponentTypeInfo typeInfo,
final IEditableValueHolderInfo editableValueHolder,
@@ -39,6 +92,14 @@
isRendered);
}
+ /**
+ * @param id
+ * @param parent
+ * @param typeInfo
+ * @param valueHolderInfo
+ * @param isRendered
+ * @return a new UIOutputInfo
+ */
public static UIOutputInfo createUIOutputInfo(final String id,
final ComponentInfo parent, final ComponentTypeInfo typeInfo,
final IValueHolderInfo valueHolderInfo, final boolean isRendered) {
@@ -46,6 +107,14 @@
isRendered);
}
+ /**
+ * @param id
+ * @param parent
+ * @param typeInfo
+ * @param actionSourceInfo
+ * @param isRendered
+ * @return a new UICommandInfo
+ */
public static UICommandInfo createUICommandInfo(final String id,
final ComponentInfo parent, final ComponentTypeInfo typeInfo,
final IActionSourceInfo actionSourceInfo, final boolean isRendered) {
@@ -53,6 +122,15 @@
actionSourceInfo);
}
+ /**
+ * @param id
+ * @param parent
+ * @param typeInfo
+ * @param isRendered
+ * @param prependId
+ * @param submitted
+ * @return a new UIFormInfo
+ */
public static UIFormInfo createUIFormInfo(final String id,
final ComponentInfo parent, final ComponentTypeInfo typeInfo,
final boolean isRendered, final boolean prependId,
@@ -61,6 +139,24 @@
submitted);
}
+ /**
+ * @param id
+ * @param parent
+ * @param typeInfo
+ * @param isRendered
+ * @param dataModel
+ * @param first
+ * @param footer
+ * @param header
+ * @param rowCount
+ * @param rowAvailable
+ * @param rowData
+ * @param rowIndex
+ * @param rows
+ * @param value
+ * @param var
+ * @return a new UIDataInfo
+ */
public static UIDataInfo createUIDataInfo(final String id,
final ComponentInfo parent, final ComponentTypeInfo typeInfo,
final boolean isRendered, final DataModelInfo dataModel,
diff --git a/jsf/plugins/org.eclipse.jst.jsf.common.runtime/src/org/eclipse/jst/jsf/common/runtime/internal/model/component/ComponentInfo.java b/jsf/plugins/org.eclipse.jst.jsf.common.runtime/src/org/eclipse/jst/jsf/common/runtime/internal/model/component/ComponentInfo.java
index 386d942..e51ad1e 100644
--- a/jsf/plugins/org.eclipse.jst.jsf.common.runtime/src/org/eclipse/jst/jsf/common/runtime/internal/model/component/ComponentInfo.java
+++ b/jsf/plugins/org.eclipse.jst.jsf.common.runtime/src/org/eclipse/jst/jsf/common/runtime/internal/model/component/ComponentInfo.java
@@ -6,7 +6,6 @@
import java.util.Iterator;
import java.util.List;
-import org.eclipse.jst.jsf.common.runtime.internal.debug.RenderNode;
import org.eclipse.jst.jsf.common.runtime.internal.model.ViewObject;
import org.eclipse.jst.jsf.common.runtime.internal.model.decorator.FacetDecorator;
@@ -26,12 +25,29 @@
private final static int DEFAULT_ARRAY_SIZE = 4;
+ /**
+ * the component id
+ */
protected final String _id;
+ /**
+ * the component's parent or null if none
+ */
protected final ComponentInfo _parent;
+ /**
+ * the type info for this component
+ */
protected final ComponentTypeInfo _componentTypeInfo;
+ /**
+ * the rendered flage
+ */
protected final boolean _isRendered;
- protected RenderNode _rootRenderedNode; // may be null if we don't have it
+ /**
+ * @param id
+ * @param parent
+ * @param componentTypeInfo
+ * @param isRendered
+ */
protected ComponentInfo(final String id, final ComponentInfo parent, final ComponentTypeInfo componentTypeInfo, final boolean isRendered)
{
_id = translateForNull(id);
@@ -52,10 +68,16 @@
private List/*<ComponentInfo>*/ _children;
+ /**
+ * @return the id
+ */
public final String getId() {
return _id;
}
+ /**
+ * @return the component type info
+ */
public final ComponentTypeInfo getComponentTypeInfo() {
return _componentTypeInfo;
}
@@ -74,7 +96,7 @@
/**
* Get the sub-set of {@link #getChildren()} that are facets.
- * This is a convenience method for {@link #getDecorators(FacetDecorator.class)}
+ * This is a convenience method for {@link #getDecorators(Class)}
*
* @return all component children that are facets
*/
@@ -105,6 +127,11 @@
addDecorator(new FacetDecorator(name, facetComponent));
}
+ /**
+ * @param component
+ * @return if component corresponds to a facet of this component, returns
+ * the name of that facet. Returns null if not found.
+ */
public final String getFacetName(final ComponentInfo component)
{
if (component == null) return null;
@@ -124,6 +151,11 @@
return null;
}
+ /**
+ * @param name
+ * @return if this has a facet called name, then returns it's single root
+ * component.
+ */
public final ComponentInfo getFacet(final String name)
{
if (name == null) return null;
@@ -152,25 +184,24 @@
+ _componentTypeInfo.getRenderFamily();
}
+ /**
+ * @return used for toString. Clients should not use.
+ */
public String getMostSpecificComponentName()
{
return "Component";
}
- public final void setRenderNode(final RenderNode rootNode)
- {
- _rootRenderedNode = rootNode;
- }
-
- public final RenderNode getRenderNode()
- {
- return _rootRenderedNode;
- }
-
+ /**
+ * @return the parent of this component or null.
+ */
public final ComponentInfo getParent() {
return _parent;
}
+ /**
+ * @return the rendered flag
+ */
public final boolean isRendered() {
return _isRendered;
}
diff --git a/jsf/plugins/org.eclipse.jst.jsf.common.runtime/src/org/eclipse/jst/jsf/common/runtime/internal/model/component/ComponentTypeInfo.java b/jsf/plugins/org.eclipse.jst.jsf.common.runtime/src/org/eclipse/jst/jsf/common/runtime/internal/model/component/ComponentTypeInfo.java
index 0c1bd35..f0a675a 100644
--- a/jsf/plugins/org.eclipse.jst.jsf.common.runtime/src/org/eclipse/jst/jsf/common/runtime/internal/model/component/ComponentTypeInfo.java
+++ b/jsf/plugins/org.eclipse.jst.jsf.common.runtime/src/org/eclipse/jst/jsf/common/runtime/internal/model/component/ComponentTypeInfo.java
@@ -3,17 +3,41 @@
import org.eclipse.jst.jsf.common.runtime.internal.model.types.IClassTypeInfo;
import org.eclipse.jst.jsf.common.runtime.internal.model.types.TypeInfo;
+/**
+ * Type information about a UIComponent
+ *
+ * @author cbateman
+ *
+ */
public class ComponentTypeInfo extends TypeInfo implements IClassTypeInfo {
/**
* serializable uid
*/
private static final long serialVersionUID = -311156682935177206L;
+ /**
+ * the ComponentType (see JSF spec for definition)
+ */
protected final String _componentType; // may be null, since may not be
// known at runtime
+ /**
+ * the fully qualified class name of the implementation class for this component.
+ */
protected final String _componentClass;
+ /**
+ * the component family (see JSF spec)
+ */
protected final String _componentFamily;
+ /**
+ * the render family (see JSF spec)
+ */
protected final String _renderFamily;
+ /**
+ * @param componentType
+ * @param componentClass
+ * @param componentFamily
+ * @param renderFamily
+ */
public ComponentTypeInfo(final String componentType,
final String componentClass, final String componentFamily,
final String renderFamily) {
@@ -23,6 +47,9 @@
_renderFamily = renderFamily;
}
+ /**
+ * @return the component type or null if unknown (may not be at runtime)
+ */
public final String getComponentType() {
return _componentType;
}
@@ -31,10 +58,16 @@
return _componentClass;
}
+ /**
+ * @return the component family
+ */
public final String getComponentFamily() {
return _componentFamily;
}
+ /**
+ * @return the render family
+ */
public final String getRenderFamily() {
return _renderFamily;
}
diff --git a/jsf/plugins/org.eclipse.jst.jsf.common.runtime/src/org/eclipse/jst/jsf/common/runtime/internal/model/component/UICommandInfo.java b/jsf/plugins/org.eclipse.jst.jsf.common.runtime/src/org/eclipse/jst/jsf/common/runtime/internal/model/component/UICommandInfo.java
index da4bfa6..35d1056 100644
--- a/jsf/plugins/org.eclipse.jst.jsf.common.runtime/src/org/eclipse/jst/jsf/common/runtime/internal/model/component/UICommandInfo.java
+++ b/jsf/plugins/org.eclipse.jst.jsf.common.runtime/src/org/eclipse/jst/jsf/common/runtime/internal/model/component/UICommandInfo.java
@@ -7,6 +7,11 @@
import org.eclipse.jst.jsf.common.runtime.internal.model.behavioural.IActionSourceInfo;
import org.eclipse.jst.jsf.common.runtime.internal.model.decorator.ActionListenerDecorator;
+/**
+ * An design time analog of the standard UICommand.
+ * @author cbateman
+ *
+ */
public class UICommandInfo extends ComponentInfo implements IActionSource2Info {
private final String _actionExpression;
private final String _actionListener;
@@ -17,6 +22,13 @@
*/
private static final long serialVersionUID = -9025172832535840949L;
+ /**
+ * @param id
+ * @param parent
+ * @param componentTypeInfo
+ * @param isRendered
+ * @param actionSourceInfo
+ */
protected UICommandInfo(final String id, final ComponentInfo parent,
final ComponentTypeInfo componentTypeInfo,
final boolean isRendered, final IActionSourceInfo actionSourceInfo) {
diff --git a/jsf/plugins/org.eclipse.jst.jsf.common.runtime/src/org/eclipse/jst/jsf/common/runtime/internal/model/component/UIDataInfo.java b/jsf/plugins/org.eclipse.jst.jsf.common.runtime/src/org/eclipse/jst/jsf/common/runtime/internal/model/component/UIDataInfo.java
index e7065f0..54405de 100644
--- a/jsf/plugins/org.eclipse.jst.jsf.common.runtime/src/org/eclipse/jst/jsf/common/runtime/internal/model/component/UIDataInfo.java
+++ b/jsf/plugins/org.eclipse.jst.jsf.common.runtime/src/org/eclipse/jst/jsf/common/runtime/internal/model/component/UIDataInfo.java
@@ -11,7 +11,13 @@
*
*/
public class UIDataInfo extends ComponentInfo implements INamingContainerInfo {
+ /**
+ * the standard name for the footer facet
+ */
public final static String FACET_NAME_FOOTER = "footer";
+ /**
+ * the standard name for the header facet.
+ */
public final static String FACET_NAME_HEADER = "header";
/**
* serialization id
@@ -28,6 +34,23 @@
private final SerializableObject _value;
private final String _var;
+ /**
+ * @param id
+ * @param parent
+ * @param componentTypeInfo
+ * @param isRendered
+ * @param dataModel
+ * @param first
+ * @param footer
+ * @param header
+ * @param rowCount
+ * @param rowAvailable
+ * @param rowData
+ * @param rowIndex
+ * @param rows
+ * @param value
+ * @param var
+ */
public UIDataInfo(final String id, final ComponentInfo parent,
final ComponentTypeInfo componentTypeInfo,
final boolean isRendered, final DataModelInfo dataModel,
@@ -56,47 +79,80 @@
}
}
+ /**
+ * @return the data model
+ */
public final DataModelInfo getDataModel() {
return _dataModel;
}
+ /**
+ * @return the first row
+ */
public final int getFirst() {
return _first;
}
+ /**
+ * @return the row count
+ */
public final int getRowCount() {
return _rowCount;
}
+ /**
+ * @return true if the row is available
+ */
public final boolean isRowAvailable() {
return _rowAvailable;
}
+ /**
+ * @return the row data (may be null if not serialiable)
+ */
public final Object getRowData() {
return _rowData.getMaybeSerializable();
}
+ /**
+ * @return the row index
+ */
public final int getRowIndex() {
return _rowIndex;
}
+ /**
+ * @return the rows
+ */
public final int getRows() {
return _rows;
}
+ /**
+ * @return the value of the model (may be null if not serialiable)
+ */
public final Object getValue() {
return _value.getMaybeSerializable();
}
+ /**
+ * @return the name used to define the EL row variable
+ */
public final String getVar() {
return _var;
}
+ /**
+ * @return the header facet or null.
+ */
public final ComponentInfo getHeader()
{
return getFacet(FACET_NAME_HEADER);
}
+ /**
+ * @return the footer facet or null.
+ */
public final ComponentInfo getFooter()
{
return getFacet(FACET_NAME_FOOTER);
diff --git a/jsf/plugins/org.eclipse.jst.jsf.common.runtime/src/org/eclipse/jst/jsf/common/runtime/internal/model/component/UIFormInfo.java b/jsf/plugins/org.eclipse.jst.jsf.common.runtime/src/org/eclipse/jst/jsf/common/runtime/internal/model/component/UIFormInfo.java
index a9d7d55..0ed3fcf 100644
--- a/jsf/plugins/org.eclipse.jst.jsf.common.runtime/src/org/eclipse/jst/jsf/common/runtime/internal/model/component/UIFormInfo.java
+++ b/jsf/plugins/org.eclipse.jst.jsf.common.runtime/src/org/eclipse/jst/jsf/common/runtime/internal/model/component/UIFormInfo.java
@@ -17,6 +17,14 @@
private final boolean _prependId;
private final boolean _submitted;
+ /**
+ * @param id
+ * @param parent
+ * @param componentTypeInfo
+ * @param isRendered
+ * @param prependId
+ * @param submitted
+ */
protected UIFormInfo(final String id, final ComponentInfo parent,
final ComponentTypeInfo componentTypeInfo, final boolean isRendered
, final boolean prependId, final boolean submitted) {
diff --git a/jsf/plugins/org.eclipse.jst.jsf.common.runtime/src/org/eclipse/jst/jsf/common/runtime/internal/model/component/UIInputInfo.java b/jsf/plugins/org.eclipse.jst.jsf.common.runtime/src/org/eclipse/jst/jsf/common/runtime/internal/model/component/UIInputInfo.java
index 80ea8c7..64863fc 100644
--- a/jsf/plugins/org.eclipse.jst.jsf.common.runtime/src/org/eclipse/jst/jsf/common/runtime/internal/model/component/UIInputInfo.java
+++ b/jsf/plugins/org.eclipse.jst.jsf.common.runtime/src/org/eclipse/jst/jsf/common/runtime/internal/model/component/UIInputInfo.java
@@ -7,6 +7,11 @@
import org.eclipse.jst.jsf.common.runtime.internal.model.decorator.ValidatorDecorator;
import org.eclipse.jst.jsf.common.runtime.internal.model.decorator.ValueChangeListenerDecorator;
+/**
+ * A design-time analog of the standard UIInput.
+ * @author cbateman
+ *
+ */
public class UIInputInfo extends UIOutputInfo implements
IEditableValueHolderInfo {
/**
@@ -21,6 +26,13 @@
private final String _valueChangeListener;
private final boolean _localSetValue;
+ /**
+ * @param id
+ * @param parent
+ * @param typeInfo
+ * @param editableValueHolderInfo
+ * @param isRendered
+ */
protected UIInputInfo(final String id, final ComponentInfo parent,
final ComponentTypeInfo typeInfo,
final IEditableValueHolderInfo editableValueHolderInfo,
diff --git a/jsf/plugins/org.eclipse.jst.jsf.common.runtime/src/org/eclipse/jst/jsf/common/runtime/internal/model/component/UIOutputInfo.java b/jsf/plugins/org.eclipse.jst.jsf.common.runtime/src/org/eclipse/jst/jsf/common/runtime/internal/model/component/UIOutputInfo.java
index 4815ffd..dd72bf8 100644
--- a/jsf/plugins/org.eclipse.jst.jsf.common.runtime/src/org/eclipse/jst/jsf/common/runtime/internal/model/component/UIOutputInfo.java
+++ b/jsf/plugins/org.eclipse.jst.jsf.common.runtime/src/org/eclipse/jst/jsf/common/runtime/internal/model/component/UIOutputInfo.java
@@ -5,15 +5,34 @@
import org.eclipse.jst.jsf.common.runtime.internal.model.behavioural.IValueHolderInfo;
import org.eclipse.jst.jsf.common.runtime.internal.model.decorator.ConverterDecorator;
+/**
+ * A design-time analog for the UIOutput
+ *
+ * @author cbateman
+ *
+ */
public class UIOutputInfo extends ComponentInfo implements IValueHolderInfo {
/**
* serializable uid
*/
private static final long serialVersionUID = 9096297578991706150L;
+ /**
+ * the value
+ */
protected final Object _value;
+ /**
+ * the value before any EL evaluation
+ */
protected final Object _localValue;
+ /**
+ * @param id
+ * @param parent
+ * @param typeInfo
+ * @param valueHolderInfo
+ * @param isRendered
+ */
protected UIOutputInfo(final String id, final ComponentInfo parent,
final ComponentTypeInfo typeInfo,
final IValueHolderInfo valueHolderInfo, final boolean isRendered) {
diff --git a/jsf/plugins/org.eclipse.jst.jsf.common.runtime/src/org/eclipse/jst/jsf/common/runtime/internal/model/decorator/ActionListenerDecorator.java b/jsf/plugins/org.eclipse.jst.jsf.common.runtime/src/org/eclipse/jst/jsf/common/runtime/internal/model/decorator/ActionListenerDecorator.java
index c2621f6..f092147 100644
--- a/jsf/plugins/org.eclipse.jst.jsf.common.runtime/src/org/eclipse/jst/jsf/common/runtime/internal/model/decorator/ActionListenerDecorator.java
+++ b/jsf/plugins/org.eclipse.jst.jsf.common.runtime/src/org/eclipse/jst/jsf/common/runtime/internal/model/decorator/ActionListenerDecorator.java
@@ -15,6 +15,9 @@
*/
private static final long serialVersionUID = 3806862878381550874L;
+ /**
+ * @param decorates
+ */
public ActionListenerDecorator(ComponentInfo decorates) {
super(decorates);
}
diff --git a/jsf/plugins/org.eclipse.jst.jsf.common.runtime/src/org/eclipse/jst/jsf/common/runtime/internal/model/decorator/ComponentDecorator.java b/jsf/plugins/org.eclipse.jst.jsf.common.runtime/src/org/eclipse/jst/jsf/common/runtime/internal/model/decorator/ComponentDecorator.java
index 266b207..e37bf12 100644
--- a/jsf/plugins/org.eclipse.jst.jsf.common.runtime/src/org/eclipse/jst/jsf/common/runtime/internal/model/decorator/ComponentDecorator.java
+++ b/jsf/plugins/org.eclipse.jst.jsf.common.runtime/src/org/eclipse/jst/jsf/common/runtime/internal/model/decorator/ComponentDecorator.java
@@ -15,11 +15,17 @@
private final ComponentInfo _decorates;
+ /**
+ * @param decorates
+ */
public ComponentDecorator(final ComponentInfo decorates)
{
_decorates = decorates;
}
+ /**
+ * @return the component that this decorator decorates.
+ */
public final ComponentInfo getDecorates() {
return _decorates;
}
diff --git a/jsf/plugins/org.eclipse.jst.jsf.common.runtime/src/org/eclipse/jst/jsf/common/runtime/internal/model/decorator/ConverterDecorator.java b/jsf/plugins/org.eclipse.jst.jsf.common.runtime/src/org/eclipse/jst/jsf/common/runtime/internal/model/decorator/ConverterDecorator.java
index 3ee1d14..25046ba 100644
--- a/jsf/plugins/org.eclipse.jst.jsf.common.runtime/src/org/eclipse/jst/jsf/common/runtime/internal/model/decorator/ConverterDecorator.java
+++ b/jsf/plugins/org.eclipse.jst.jsf.common.runtime/src/org/eclipse/jst/jsf/common/runtime/internal/model/decorator/ConverterDecorator.java
@@ -2,17 +2,37 @@
import org.eclipse.jst.jsf.common.runtime.internal.model.component.ComponentInfo;
+/**
+ * A converter decorator.
+ *
+ * @author cbateman
+ *
+ */
public class ConverterDecorator extends ComponentDecorator {
+ private final ConverterTypeInfo _typeInfo;
+
/**
* serializable id
*/
private static final long serialVersionUID = 3838224353030247227L;
- public ConverterDecorator(final ComponentInfo decorates)
+ /**
+ * @param decorates
+ * @param typeInfo
+ */
+ public ConverterDecorator(final ComponentInfo decorates, final ConverterTypeInfo typeInfo)
{
super(decorates);
+ _typeInfo = typeInfo;
}
+ /**
+ * @return the converter's type info.
+ */
+ public final ConverterTypeInfo getTypeInfo()
+ {
+ return _typeInfo;
+ }
}
diff --git a/jsf/plugins/org.eclipse.jst.jsf.common.runtime/src/org/eclipse/jst/jsf/common/runtime/internal/model/decorator/ConverterTypeInfo.java b/jsf/plugins/org.eclipse.jst.jsf.common.runtime/src/org/eclipse/jst/jsf/common/runtime/internal/model/decorator/ConverterTypeInfo.java
index 4d6135d..1c87308 100644
--- a/jsf/plugins/org.eclipse.jst.jsf.common.runtime/src/org/eclipse/jst/jsf/common/runtime/internal/model/decorator/ConverterTypeInfo.java
+++ b/jsf/plugins/org.eclipse.jst.jsf.common.runtime/src/org/eclipse/jst/jsf/common/runtime/internal/model/decorator/ConverterTypeInfo.java
@@ -24,7 +24,7 @@
*
* @param className
* @param converterId
- * @throws #{@link IllegalArgumentException} if both className and
+ * @throws java.lang.IllegalArgumentException if both className and
* converterId are null.
*
*/
@@ -40,6 +40,10 @@
_converterId = converterId;
}
+ /**
+ * Use when the converter's information unknown such as occurs when
+ * using the f:converter tag.
+ */
public static final ConverterTypeInfo UNKNOWN =
new ConverterTypeInfo((Object)null);
@@ -62,6 +66,9 @@
}
+ /**
+ * @return the converter's id.
+ */
public final String getConverterId()
{
return _converterId;
diff --git a/jsf/plugins/org.eclipse.jst.jsf.common.runtime/src/org/eclipse/jst/jsf/common/runtime/internal/model/decorator/Decorator.java b/jsf/plugins/org.eclipse.jst.jsf.common.runtime/src/org/eclipse/jst/jsf/common/runtime/internal/model/decorator/Decorator.java
index 57750c8..043c660 100644
--- a/jsf/plugins/org.eclipse.jst.jsf.common.runtime/src/org/eclipse/jst/jsf/common/runtime/internal/model/decorator/Decorator.java
+++ b/jsf/plugins/org.eclipse.jst.jsf.common.runtime/src/org/eclipse/jst/jsf/common/runtime/internal/model/decorator/Decorator.java
@@ -4,10 +4,16 @@
import org.eclipse.jst.jsf.common.runtime.internal.model.ViewObject;
+/**
+ * The abstract super-class of all view object decorators.
+ *
+ * @author cbateman
+ *
+ */
public abstract class Decorator extends ViewObject implements Serializable {
/**
- *
+ * serializable id
*/
private static final long serialVersionUID = -3138829736243154022L;
diff --git a/jsf/plugins/org.eclipse.jst.jsf.common.runtime/src/org/eclipse/jst/jsf/common/runtime/internal/model/decorator/FacetDecorator.java b/jsf/plugins/org.eclipse.jst.jsf.common.runtime/src/org/eclipse/jst/jsf/common/runtime/internal/model/decorator/FacetDecorator.java
index f05f73a..ba73e66 100644
--- a/jsf/plugins/org.eclipse.jst.jsf.common.runtime/src/org/eclipse/jst/jsf/common/runtime/internal/model/decorator/FacetDecorator.java
+++ b/jsf/plugins/org.eclipse.jst.jsf.common.runtime/src/org/eclipse/jst/jsf/common/runtime/internal/model/decorator/FacetDecorator.java
@@ -2,6 +2,12 @@
import org.eclipse.jst.jsf.common.runtime.internal.model.component.ComponentInfo;
+/**
+ * Component decorator for facets.
+ *
+ * @author cbateman
+ *
+ */
public class FacetDecorator extends ComponentDecorator
{
/**
@@ -11,11 +17,18 @@
private final String _name;
+ /**
+ * @param name
+ * @param component
+ */
public FacetDecorator(final String name, final ComponentInfo component) {
super(component);
_name = name;
}
+ /**
+ * @return the name of the facet.
+ */
public final String getName() {
return _name;
}
diff --git a/jsf/plugins/org.eclipse.jst.jsf.common.runtime/src/org/eclipse/jst/jsf/common/runtime/internal/model/decorator/ValidatorDecorator.java b/jsf/plugins/org.eclipse.jst.jsf.common.runtime/src/org/eclipse/jst/jsf/common/runtime/internal/model/decorator/ValidatorDecorator.java
index cd09105..cc4f692 100644
--- a/jsf/plugins/org.eclipse.jst.jsf.common.runtime/src/org/eclipse/jst/jsf/common/runtime/internal/model/decorator/ValidatorDecorator.java
+++ b/jsf/plugins/org.eclipse.jst.jsf.common.runtime/src/org/eclipse/jst/jsf/common/runtime/internal/model/decorator/ValidatorDecorator.java
@@ -2,14 +2,34 @@
import org.eclipse.jst.jsf.common.runtime.internal.model.component.ComponentInfo;
+/**
+ * Validator decorator.
+ *
+ * @author cbateman
+ *
+ */
public class ValidatorDecorator extends ComponentDecorator {
/**
*
*/
private static final long serialVersionUID = -2898015711621314782L;
+ private final ValidatorTypeInfo _typeInfo;
- public ValidatorDecorator(final ComponentInfo decorates) {
+ /**
+ * @param decorates
+ * @param typeInfo
+ */
+ public ValidatorDecorator(final ComponentInfo decorates, final ValidatorTypeInfo typeInfo) {
super(decorates);
+ _typeInfo = typeInfo;
+ }
+
+ /**
+ * @return the validator's type info
+ */
+ public final ValidatorTypeInfo getTypeInfo()
+ {
+ return _typeInfo;
}
}
diff --git a/jsf/plugins/org.eclipse.jst.jsf.common.runtime/src/org/eclipse/jst/jsf/common/runtime/internal/model/decorator/ValidatorTypeInfo.java b/jsf/plugins/org.eclipse.jst.jsf.common.runtime/src/org/eclipse/jst/jsf/common/runtime/internal/model/decorator/ValidatorTypeInfo.java
index 9ee4836..c120f90 100644
--- a/jsf/plugins/org.eclipse.jst.jsf.common.runtime/src/org/eclipse/jst/jsf/common/runtime/internal/model/decorator/ValidatorTypeInfo.java
+++ b/jsf/plugins/org.eclipse.jst.jsf.common.runtime/src/org/eclipse/jst/jsf/common/runtime/internal/model/decorator/ValidatorTypeInfo.java
@@ -3,6 +3,11 @@
import org.eclipse.jst.jsf.common.runtime.internal.model.types.IClassTypeInfo;
import org.eclipse.jst.jsf.common.runtime.internal.model.types.TypeInfo;
+/**
+ * Type information about validator decorator.
+ * @author cbateman
+ *
+ */
public class ValidatorTypeInfo extends TypeInfo implements IClassTypeInfo
{
/**
@@ -18,7 +23,7 @@
*
* @param validatorClass
* @param validatorId
- * @throws #{@link IllegalArgumentException} if both className and
+ * @throws java.lang.IllegalArgumentException if both className and
* converterId are null.
*
*/
@@ -34,6 +39,9 @@
_validatorId = validatorId;
}
+ /**
+ * Use when a validator's type info information is unknown.
+ */
public static final ValidatorTypeInfo UNKNOWN =
new ValidatorTypeInfo((Object)null);
@@ -50,6 +58,9 @@
_className = _validatorId = null;
}
+ /**
+ * @return the validator id (may be null if unknown).
+ */
public final String getValidatorId()
{
return _validatorId;
diff --git a/jsf/plugins/org.eclipse.jst.jsf.common.runtime/src/org/eclipse/jst/jsf/common/runtime/internal/model/decorator/ValueChangeListenerDecorator.java b/jsf/plugins/org.eclipse.jst.jsf.common.runtime/src/org/eclipse/jst/jsf/common/runtime/internal/model/decorator/ValueChangeListenerDecorator.java
index 2e9d411..af28605 100644
--- a/jsf/plugins/org.eclipse.jst.jsf.common.runtime/src/org/eclipse/jst/jsf/common/runtime/internal/model/decorator/ValueChangeListenerDecorator.java
+++ b/jsf/plugins/org.eclipse.jst.jsf.common.runtime/src/org/eclipse/jst/jsf/common/runtime/internal/model/decorator/ValueChangeListenerDecorator.java
@@ -3,6 +3,12 @@
import org.eclipse.jst.jsf.common.runtime.internal.model.component.ComponentInfo;
import org.eclipse.jst.jsf.common.runtime.internal.model.event.IValueChangeListenerInfo;
+/**
+ * ValueChangeListener component decorator.
+ *
+ * @author cbateman
+ *
+ */
public class ValueChangeListenerDecorator extends ComponentDecorator implements
IValueChangeListenerInfo
{
@@ -11,6 +17,9 @@
*/
private static final long serialVersionUID = 9045831927898936727L;
+ /**
+ * @param decorates
+ */
public ValueChangeListenerDecorator(ComponentInfo decorates) {
super(decorates);
}
diff --git a/jsf/plugins/org.eclipse.jst.jsf.common.runtime/src/org/eclipse/jst/jsf/common/runtime/internal/model/event/IActionListenerInfo.java b/jsf/plugins/org.eclipse.jst.jsf.common.runtime/src/org/eclipse/jst/jsf/common/runtime/internal/model/event/IActionListenerInfo.java
index 78cebdb..a1ae4bb 100644
--- a/jsf/plugins/org.eclipse.jst.jsf.common.runtime/src/org/eclipse/jst/jsf/common/runtime/internal/model/event/IActionListenerInfo.java
+++ b/jsf/plugins/org.eclipse.jst.jsf.common.runtime/src/org/eclipse/jst/jsf/common/runtime/internal/model/event/IActionListenerInfo.java
@@ -7,5 +7,5 @@
*/
public interface IActionListenerInfo extends IFacesListenerInfo
{
-
+ // TODO:
}
diff --git a/jsf/plugins/org.eclipse.jst.jsf.common.runtime/src/org/eclipse/jst/jsf/common/runtime/internal/model/event/IValueChangeListenerInfo.java b/jsf/plugins/org.eclipse.jst.jsf.common.runtime/src/org/eclipse/jst/jsf/common/runtime/internal/model/event/IValueChangeListenerInfo.java
index edefda0..155a4f1 100644
--- a/jsf/plugins/org.eclipse.jst.jsf.common.runtime/src/org/eclipse/jst/jsf/common/runtime/internal/model/event/IValueChangeListenerInfo.java
+++ b/jsf/plugins/org.eclipse.jst.jsf.common.runtime/src/org/eclipse/jst/jsf/common/runtime/internal/model/event/IValueChangeListenerInfo.java
@@ -7,5 +7,5 @@
*
*/
public interface IValueChangeListenerInfo extends IFacesListenerInfo {
-
+ // TODO:
}
diff --git a/jsf/plugins/org.eclipse.jst.jsf.common.runtime/src/org/eclipse/jst/jsf/common/runtime/internal/model/types/IClassTypeInfo.java b/jsf/plugins/org.eclipse.jst.jsf.common.runtime/src/org/eclipse/jst/jsf/common/runtime/internal/model/types/IClassTypeInfo.java
index c533a6f..32aa42b 100644
--- a/jsf/plugins/org.eclipse.jst.jsf.common.runtime/src/org/eclipse/jst/jsf/common/runtime/internal/model/types/IClassTypeInfo.java
+++ b/jsf/plugins/org.eclipse.jst.jsf.common.runtime/src/org/eclipse/jst/jsf/common/runtime/internal/model/types/IClassTypeInfo.java
@@ -1,5 +1,10 @@
package org.eclipse.jst.jsf.common.runtime.internal.model.types;
+/**
+ * A type info that has an associate Java class.
+ * @author cbateman
+ *
+ */
public interface IClassTypeInfo
{
/**
diff --git a/jsf/plugins/org.eclipse.jst.jsf.common.runtime/src/org/eclipse/jst/jsf/common/runtime/internal/model/types/TypeInfo.java b/jsf/plugins/org.eclipse.jst.jsf.common.runtime/src/org/eclipse/jst/jsf/common/runtime/internal/model/types/TypeInfo.java
index 6369215..1d3ea33 100644
--- a/jsf/plugins/org.eclipse.jst.jsf.common.runtime/src/org/eclipse/jst/jsf/common/runtime/internal/model/types/TypeInfo.java
+++ b/jsf/plugins/org.eclipse.jst.jsf.common.runtime/src/org/eclipse/jst/jsf/common/runtime/internal/model/types/TypeInfo.java
@@ -2,6 +2,12 @@
import java.io.Serializable;
+/**
+ * Abstract super-class of all view object type information objects.
+ *
+ * @author cbateman
+ *
+ */
public abstract class TypeInfo implements Serializable
{
/**
diff --git a/jsf/plugins/org.eclipse.jst.jsf.common.runtime/src/org/eclipse/jst/jsf/common/runtime/internal/view/model/common/IComponentTagElement.java b/jsf/plugins/org.eclipse.jst.jsf.common.runtime/src/org/eclipse/jst/jsf/common/runtime/internal/view/model/common/IComponentTagElement.java
index cc40997..7eb5509 100644
--- a/jsf/plugins/org.eclipse.jst.jsf.common.runtime/src/org/eclipse/jst/jsf/common/runtime/internal/view/model/common/IComponentTagElement.java
+++ b/jsf/plugins/org.eclipse.jst.jsf.common.runtime/src/org/eclipse/jst/jsf/common/runtime/internal/view/model/common/IComponentTagElement.java
@@ -10,5 +10,8 @@
*/
public interface IComponentTagElement extends IJSFTagElement
{
+ /**
+ * @return the comopnent's type info.
+ */
ComponentTypeInfo getComponent();
}
diff --git a/jsf/plugins/org.eclipse.jst.jsf.common.runtime/src/org/eclipse/jst/jsf/common/runtime/internal/view/model/common/IConverterTagElement.java b/jsf/plugins/org.eclipse.jst.jsf.common.runtime/src/org/eclipse/jst/jsf/common/runtime/internal/view/model/common/IConverterTagElement.java
index 91a459c..a26a7bd 100644
--- a/jsf/plugins/org.eclipse.jst.jsf.common.runtime/src/org/eclipse/jst/jsf/common/runtime/internal/view/model/common/IConverterTagElement.java
+++ b/jsf/plugins/org.eclipse.jst.jsf.common.runtime/src/org/eclipse/jst/jsf/common/runtime/internal/view/model/common/IConverterTagElement.java
@@ -2,6 +2,13 @@
import org.eclipse.jst.jsf.common.runtime.internal.model.decorator.ConverterTypeInfo;
+/**
+ * A tag element that causes the construction registration of a converter on
+ * a parent object.
+ *
+ * @author cbateman
+ *
+ */
public interface IConverterTagElement extends IJSFTagElement
{
/**
diff --git a/jsf/plugins/org.eclipse.jst.jsf.common.runtime/src/org/eclipse/jst/jsf/common/runtime/internal/view/model/common/IHandlerTagElement.java b/jsf/plugins/org.eclipse.jst.jsf.common.runtime/src/org/eclipse/jst/jsf/common/runtime/internal/view/model/common/IHandlerTagElement.java
index 57dbbb2..4b21316 100644
--- a/jsf/plugins/org.eclipse.jst.jsf.common.runtime/src/org/eclipse/jst/jsf/common/runtime/internal/view/model/common/IHandlerTagElement.java
+++ b/jsf/plugins/org.eclipse.jst.jsf.common.runtime/src/org/eclipse/jst/jsf/common/runtime/internal/view/model/common/IHandlerTagElement.java
@@ -4,8 +4,20 @@
import org.eclipse.jst.jsf.common.runtime.internal.model.types.TypeInfo;
+/**
+ * Generic tag handler that has effect when processed by the JSF ViewHandler.
+ *
+ * @author cbateman
+ *
+ */
public interface IHandlerTagElement extends IJSFTagElement
{
+ /**
+ * Enumerates known types of built-in tag handlers.
+ *
+ * @author cbateman
+ *
+ */
static class TagHandlerType extends TypeInfo implements Serializable
{
/**
diff --git a/jsf/plugins/org.eclipse.jst.jsf.common.runtime/src/org/eclipse/jst/jsf/common/runtime/internal/view/model/common/IJSFTagElement.java b/jsf/plugins/org.eclipse.jst.jsf.common.runtime/src/org/eclipse/jst/jsf/common/runtime/internal/view/model/common/IJSFTagElement.java
index 22b054c..5263b91 100644
--- a/jsf/plugins/org.eclipse.jst.jsf.common.runtime/src/org/eclipse/jst/jsf/common/runtime/internal/view/model/common/IJSFTagElement.java
+++ b/jsf/plugins/org.eclipse.jst.jsf.common.runtime/src/org/eclipse/jst/jsf/common/runtime/internal/view/model/common/IJSFTagElement.java
@@ -10,6 +10,12 @@
*/
public interface IJSFTagElement extends ITagElement
{
+ /**
+ * An enumeration of different kinds of tags.
+ *
+ * @author cbateman
+ *
+ */
static class TagType implements Serializable
{
/**
diff --git a/jsf/plugins/org.eclipse.jst.jsf.common.runtime/src/org/eclipse/jst/jsf/common/runtime/internal/view/model/common/ITagElement.java b/jsf/plugins/org.eclipse.jst.jsf.common.runtime/src/org/eclipse/jst/jsf/common/runtime/internal/view/model/common/ITagElement.java
index 71952cd..4c2e653 100644
--- a/jsf/plugins/org.eclipse.jst.jsf.common.runtime/src/org/eclipse/jst/jsf/common/runtime/internal/view/model/common/ITagElement.java
+++ b/jsf/plugins/org.eclipse.jst.jsf.common.runtime/src/org/eclipse/jst/jsf/common/runtime/internal/view/model/common/ITagElement.java
@@ -1,5 +1,11 @@
package org.eclipse.jst.jsf.common.runtime.internal.view.model.common;
+/**
+ * Super-interface of all JSF tag elements.
+ *
+ * @author cbateman
+ *
+ */
public interface ITagElement {
/**
diff --git a/jsf/plugins/org.eclipse.jst.jsf.common.runtime/src/org/eclipse/jst/jsf/common/runtime/internal/view/model/common/IValidatorTagElement.java b/jsf/plugins/org.eclipse.jst.jsf.common.runtime/src/org/eclipse/jst/jsf/common/runtime/internal/view/model/common/IValidatorTagElement.java
index 5a3c4e1..370ab46 100644
--- a/jsf/plugins/org.eclipse.jst.jsf.common.runtime/src/org/eclipse/jst/jsf/common/runtime/internal/view/model/common/IValidatorTagElement.java
+++ b/jsf/plugins/org.eclipse.jst.jsf.common.runtime/src/org/eclipse/jst/jsf/common/runtime/internal/view/model/common/IValidatorTagElement.java
@@ -10,5 +10,8 @@
*/
public interface IValidatorTagElement extends IJSFTagElement
{
+ /**
+ * @return the type info about the validator.
+ */
ValidatorTypeInfo getValidator();
}
