### Eclipse Workspace Patch 1.0 #P org.eclipse.jst.pagedesigner Index: .settings/org.eclipse.jdt.core.prefs =================================================================== RCS file: /cvsroot/webtools/org.eclipse.jsf/components/jsf/plugins/org.eclipse.jst.pagedesigner/.settings/org.eclipse.jdt.core.prefs,v retrieving revision 1.4 diff -u -r1.4 org.eclipse.jdt.core.prefs --- .settings/org.eclipse.jdt.core.prefs 9 Jan 2008 19:40:29 -0000 1.4 +++ .settings/org.eclipse.jdt.core.prefs 4 Nov 2008 23:13:52 -0000 @@ -1,4 +1,4 @@ -#Fri Dec 14 11:18:54 PST 2007 +#Tue Nov 04 14:19:07 PST 2008 eclipse.preferences.version=1 org.eclipse.jdt.core.compiler.codegen.inlineJsrBytecode=enabled org.eclipse.jdt.core.compiler.codegen.targetPlatform=1.5 @@ -28,17 +28,18 @@ org.eclipse.jdt.core.compiler.problem.incompleteEnumSwitch=warning org.eclipse.jdt.core.compiler.problem.indirectStaticAccess=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.invalidJavadocTags=disabled +org.eclipse.jdt.core.compiler.problem.invalidJavadocTagsDeprecatedRef=enabled +org.eclipse.jdt.core.compiler.problem.invalidJavadocTagsNotVisibleRef=enabled +org.eclipse.jdt.core.compiler.problem.invalidJavadocTagsVisibility=private 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.missingJavadocComments=error 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.missingJavadocTagDescription=return_tag +org.eclipse.jdt.core.compiler.problem.missingJavadocTags=error org.eclipse.jdt.core.compiler.problem.missingJavadocTagsOverriding=disabled org.eclipse.jdt.core.compiler.problem.missingJavadocTagsVisibility=protected org.eclipse.jdt.core.compiler.problem.missingOverrideAnnotation=ignore Index: src/org/eclipse/jst/pagedesigner/itemcreation/customizer/CustomizationDataImpl.java =================================================================== RCS file: /cvsroot/webtools/org.eclipse.jsf/components/jsf/plugins/org.eclipse.jst.pagedesigner/src/org/eclipse/jst/pagedesigner/itemcreation/customizer/CustomizationDataImpl.java,v retrieving revision 1.1 diff -u -r1.1 CustomizationDataImpl.java --- src/org/eclipse/jst/pagedesigner/itemcreation/customizer/CustomizationDataImpl.java 4 Nov 2008 01:15:42 -0000 1.1 +++ src/org/eclipse/jst/pagedesigner/itemcreation/customizer/CustomizationDataImpl.java 4 Nov 2008 23:13:52 -0000 @@ -15,14 +15,21 @@ * */ -public class CustomizationDataImpl implements ICustomizationData, IAdaptable +public class CustomizationDataImpl implements IWritableCustomizationData, IAdaptable { private TagIdentifier tagIdentifier; private AttributeData _attrs; private ChildrenData childrenData; private ParentData parentData; + - + /** + * Constructor. + * + * @param target + * Tag identifier for the tag whose customization data this is + * + */ public CustomizationDataImpl(final TagIdentifier target) { tagIdentifier = target; @@ -32,6 +39,9 @@ } + /* (non-Javadoc) + * @see org.eclipse.core.runtime.IAdaptable#getAdapter(java.lang.Class) + */ public Object getAdapter(Class adapter) { if (ICustomizationData.class.equals(adapter)) @@ -48,12 +58,8 @@ //------------------------------------------------------------ - /* - * (non-Javadoc) - * - * @see - * org.eclipse.jst.pagedesigner.itemcreation.customizer.ICustomizationData - * #getTagIdentifier() + /* (non-Javadoc) + * @see org.eclipse.jst.pagedesigner.itemcreation.customizer.ICustomizationData#getTagIdentifier() */ public TagIdentifier getTagIdentifier() { @@ -61,6 +67,9 @@ } + /* (non-Javadoc) + * @see org.eclipse.jst.pagedesigner.itemcreation.customizer.IWritableCustomizationData#setTagIdentifier(org.eclipse.jst.jsf.common.dom.TagIdentifier) + */ public void setTagIdentifier(TagIdentifier tagId) { this.tagIdentifier = tagId; @@ -72,12 +81,8 @@ //------------------------------------------------------------ - /* - * (non-Javadoc) - * - * @see - * org.eclipse.jst.pagedesigner.itemcreation.customizer.ICustomizationData - * #getAttributeData() + /* (non-Javadoc) + * @see org.eclipse.jst.pagedesigner.itemcreation.customizer.ICustomizationData#getAttributeData() */ public final AttributeData getAttributeData() { @@ -85,12 +90,18 @@ } + /* (non-Javadoc) + * @see org.eclipse.jst.pagedesigner.itemcreation.customizer.IWritableCustomizationData#setAttributes(org.eclipse.jst.pagedesigner.itemcreation.customizer.AttributeData) + */ public void setAttributes(AttributeData attrs) { _attrs = attrs; } + /* (non-Javadoc) + * @see org.eclipse.jst.pagedesigner.itemcreation.customizer.IWritableCustomizationData#addAttribute(java.lang.String, java.lang.String) + */ public void addAttribute(String attributeName, String attributeValue) { getAttributeData().addAttribute(attributeName, attributeValue); @@ -102,12 +113,8 @@ //------------------------------------------------------------ - /* - * (non-Javadoc) - * - * @see - * org.eclipse.jst.pagedesigner.itemcreation.customizer.ICustomizationData - * #getChildrenData() + /* (non-Javadoc) + * @see org.eclipse.jst.pagedesigner.itemcreation.customizer.ICustomizationData#getChildrenData() */ public final ChildrenData getChildrenData() { @@ -115,12 +122,18 @@ } + /* (non-Javadoc) + * @see org.eclipse.jst.pagedesigner.itemcreation.customizer.IWritableCustomizationData#setChildrenData(org.eclipse.jst.pagedesigner.itemcreation.customizer.ChildrenData) + */ public void setChildrenData(ChildrenData data) { childrenData = data; } + /* (non-Javadoc) + * @see org.eclipse.jst.pagedesigner.itemcreation.customizer.IWritableCustomizationData#addChildrenData(org.eclipse.jst.pagedesigner.itemcreation.customizer.ICustomizationData) + */ public void addChildrenData (ICustomizationData childrenData) { getChildrenData().add(childrenData); @@ -132,12 +145,8 @@ //------------------------------------------------------------ - /* - * (non-Javadoc) - * - * @see - * org.eclipse.jst.pagedesigner.itemcreation.customizer.ICustomizationData - * #getParentData() + /* (non-Javadoc) + * @see org.eclipse.jst.pagedesigner.itemcreation.customizer.ICustomizationData#getParentData() */ public final ParentData getParentData() { @@ -145,19 +154,17 @@ } + /* (non-Javadoc) + * @see org.eclipse.jst.pagedesigner.itemcreation.customizer.IWritableCustomizationData#setParentData(org.eclipse.jst.pagedesigner.itemcreation.customizer.ParentData) + */ public void setParentData(ParentData parentData) { this.parentData = parentData; } - /** - * Attaches a parent to a tag (The customization data for a parent is added - * to the tag's customization data). The oldest parent (outermost container - * tag) should be attached (added) first. - * - * @param parentData - * Parent customization data + /* (non-Javadoc) + * @see org.eclipse.jst.pagedesigner.itemcreation.customizer.IWritableCustomizationData#addParentData(org.eclipse.jst.pagedesigner.itemcreation.customizer.ICustomizationData) */ public void addParentData (ICustomizationData parentData) { Index: src/org/eclipse/jst/pagedesigner/itemcreation/customizer/ChildrenData.java =================================================================== RCS file: /cvsroot/webtools/org.eclipse.jsf/components/jsf/plugins/org.eclipse.jst.pagedesigner/src/org/eclipse/jst/pagedesigner/itemcreation/customizer/ChildrenData.java,v retrieving revision 1.1 diff -u -r1.1 ChildrenData.java --- src/org/eclipse/jst/pagedesigner/itemcreation/customizer/ChildrenData.java 4 Nov 2008 01:15:42 -0000 1.1 +++ src/org/eclipse/jst/pagedesigner/itemcreation/customizer/ChildrenData.java 4 Nov 2008 23:13:52 -0000 @@ -16,12 +16,24 @@ private List childList; + /** + * Default constructor + * + */ public ChildrenData() { this.childList = new ArrayList(); } + /** + * Constructor to initialize a ChildrenData object with a list of + * customization data for the child tags + * + * @param childList + * List of customization data objects for child tags + * + */ public ChildrenData(List childList) { this.childList = childList; Index: src/org/eclipse/jst/pagedesigner/itemcreation/customizer/ParentData.java =================================================================== RCS file: /cvsroot/webtools/org.eclipse.jsf/components/jsf/plugins/org.eclipse.jst.pagedesigner/src/org/eclipse/jst/pagedesigner/itemcreation/customizer/ParentData.java,v retrieving revision 1.1 diff -u -r1.1 ParentData.java --- src/org/eclipse/jst/pagedesigner/itemcreation/customizer/ParentData.java 4 Nov 2008 01:15:42 -0000 1.1 +++ src/org/eclipse/jst/pagedesigner/itemcreation/customizer/ParentData.java 4 Nov 2008 23:13:52 -0000 @@ -4,34 +4,60 @@ import java.util.List; /** - * Class to represent parent tag customization data for a tag + * Class to represent parent tag customization data for a tag. This information + * is stored as a List of ICustomizationData objects, where each + * ICustomizationData object belongs to one parent tag. (The outermost parent tag + * (oldest ancestor) should be added first to this list) * * @author Debajit Adhikary * */ public class ParentData { - private List parentList; + /** + * List of ICustomizationData objects to store parent tag information. The + * outermost parent tag should be added first. + */ + private List parentList; + /** + * Default constructor + * + */ public ParentData () { parentList = new ArrayList(); } + /** + * @param parentData + * Customization data to add for the parent tag + * + */ public void add (ICustomizationData parentData) { this.parentList.add(parentData); } + /** + * Returns the Parent customization data as a list of customization objects. + * + * @return The parent customization data + * + */ public List getParentCustomizationData () { return parentList; } + /** + * @param parentList List of ICustomizationData to set it to + * + */ public void setParentCustomizationData (List parentList) { this.parentList = parentList; Index: src/org/eclipse/jst/pagedesigner/itemcreation/command/UserCustomizedContainerCreationCommand.java =================================================================== RCS file: /cvsroot/webtools/org.eclipse.jsf/components/jsf/plugins/org.eclipse.jst.pagedesigner/src/org/eclipse/jst/pagedesigner/itemcreation/command/UserCustomizedContainerCreationCommand.java,v retrieving revision 1.1 diff -u -r1.1 UserCustomizedContainerCreationCommand.java --- src/org/eclipse/jst/pagedesigner/itemcreation/command/UserCustomizedContainerCreationCommand.java 4 Nov 2008 01:15:44 -0000 1.1 +++ src/org/eclipse/jst/pagedesigner/itemcreation/command/UserCustomizedContainerCreationCommand.java 4 Nov 2008 23:13:52 -0000 @@ -4,11 +4,38 @@ import org.eclipse.jst.jsf.common.dom.TagIdentifier; import org.eclipse.jst.pagedesigner.dom.IDOMPosition; +/** + * Tag container creation command for tags dropped on to the WPE by the user + * + * @see TagContainerCreationCommand + * + * @author Debajit Adhikary + * + */ public class UserCustomizedContainerCreationCommand extends TagContainerCreationCommand { + /** + * Customization data for tag dropped + * + * @see ICustomizationData + * @see IAdaptable + */ private final IAdaptable _data; + + /** + * @param domPosition + * Position in the DOM where the tag is to be inserted + * @param containerTag + * Container tag + * @param tagBeingCreated + * The tag which was dropped + * @param data + * Customization data for the tag dropped + * + * @see TagContainerCreationCommand#TagContainerCreationCommand(IDOMPosition, TagIdentifier, TagIdentifier) + */ public UserCustomizedContainerCreationCommand(IDOMPosition domPosition, TagIdentifier containerTag, TagIdentifier tagBeingCreated, IAdaptable data) { @@ -16,6 +43,10 @@ _data = data; } + + /* (non-Javadoc) + * @see org.eclipse.jst.pagedesigner.itemcreation.command.TagContainerCreationCommand#getContainerCustomizationData() + */ @Override protected IAdaptable getContainerCustomizationData() { Index: src/org/eclipse/jst/pagedesigner/itemcreation/command/ElementCustomizationCommand.java =================================================================== RCS file: /cvsroot/webtools/org.eclipse.jsf/components/jsf/plugins/org.eclipse.jst.pagedesigner/src/org/eclipse/jst/pagedesigner/itemcreation/command/ElementCustomizationCommand.java,v retrieving revision 1.4 diff -u -r1.4 ElementCustomizationCommand.java --- src/org/eclipse/jst/pagedesigner/itemcreation/command/ElementCustomizationCommand.java 2 May 2008 19:50:47 -0000 1.4 +++ src/org/eclipse/jst/pagedesigner/itemcreation/command/ElementCustomizationCommand.java 4 Nov 2008 23:13:52 -0000 @@ -66,6 +66,10 @@ _creationData = creationData; } + + /* (non-Javadoc) + * @see org.eclipse.jst.pagedesigner.itemcreation.internal.AbstractCreationCommand#execute() + */ @Override public void execute() { @@ -73,6 +77,10 @@ applyAttributeCustomization(); } + + /* (non-Javadoc) + * @see org.eclipse.jst.pagedesigner.itemcreation.internal.AbstractCreationCommand#prepare() + */ @Override protected boolean prepare() { @@ -159,12 +167,20 @@ } } + + /* (non-Javadoc) + * @see org.eclipse.jst.pagedesigner.itemcreation.internal.AbstractCreationCommand#chain(org.eclipse.emf.common.command.Command) + */ @Override public final Command chain(final Command command) { return super.chain(command); } + + /* (non-Javadoc) + * @see org.eclipse.jst.pagedesigner.itemcreation.internal.AbstractCreationCommand#getResult() + */ @Override public final Collection getResult() {