[Ejtools-cvs] CVS: libraries/xmlweb/src/main/net/sourceforge/ejtools/xml XmlComponent.java,1.2,1.3 X
Brought to you by:
letiemble
From: Laurent E. <let...@us...> - 2002-05-05 20:22:42
|
Update of /cvsroot/ejtools/libraries/xmlweb/src/main/net/sourceforge/ejtools/xml In directory usw-pr-cvs1:/tmp/cvs-serv10783/xmlweb/src/main/net/sourceforge/ejtools/xml Modified Files: XmlComponent.java XmlContainer.java XmlEditor.java XmlIconable.java XmlLink.java XmlPrintable.java XmlText.java XmlTreeNode.java Log Message: Add some JavaDocs Index: XmlComponent.java =================================================================== RCS file: /cvsroot/ejtools/libraries/xmlweb/src/main/net/sourceforge/ejtools/xml/XmlComponent.java,v retrieving revision 1.2 retrieving revision 1.3 diff -C2 -d -r1.2 -r1.3 *** XmlComponent.java 25 Apr 2002 20:15:25 -0000 1.2 --- XmlComponent.java 5 May 2002 20:22:39 -0000 1.3 *************** *** 8,27 **** import java.util.Vector; - import org.w3c.dom.Document; - import org.w3c.dom.Element; /** ! * Description of the Class * ! * @author letiembl ! * @created 26 février 2002 */ public class XmlComponent extends Vector implements XmlPrintable { ! /** Description of the Field */ protected String name = ""; ! /** Constructor for the XmlComponent object */ public XmlComponent() { --- 8,27 ---- import java.util.Vector; /** ! * Description of the Class * ! * @author letiembl ! * @created 26 février 2002 ! * @version $Revision$ ! * @todo JavaDoc to complete */ public class XmlComponent extends Vector implements XmlPrintable { ! /** Description of the Field */ protected String name = ""; ! /** Constructor for the XmlComponent object */ public XmlComponent() { *************** *** 31,37 **** /** ! * Constructor for the XmlText object * ! * @param name Description of Parameter */ public XmlComponent(String name) --- 31,37 ---- /** ! * Constructor for the XmlText object * ! * @param name Description of Parameter */ public XmlComponent(String name) *************** *** 42,69 **** /** ! * Description of the Method * ! * @param document Description of Parameter ! * @return Description of the Returned Value ! * @exception Exception Description of Exception */ ! public String toXml() { ! String result = ""; ! ! result= result+ "<"+this.name+"/>\n"; ! ! return result; } /** ! * Description of the Method * ! * @return Description of the Returned Value */ ! public String toString() { ! return "Xml Component"; } } --- 42,67 ---- /** ! * Description of the Method * ! * @return Description of the Returned Value */ ! public String toString() { ! return "Xml Component"; } /** ! * Description of the Method * ! * @return Description of the Returned Value */ ! public String toXml() { ! String result = ""; ! ! result = result + "<" + this.name + "/>\n"; ! ! return result; } } Index: XmlContainer.java =================================================================== RCS file: /cvsroot/ejtools/libraries/xmlweb/src/main/net/sourceforge/ejtools/xml/XmlContainer.java,v retrieving revision 1.2 retrieving revision 1.3 diff -C2 -d -r1.2 -r1.3 *** XmlContainer.java 25 Apr 2002 20:15:25 -0000 1.2 --- XmlContainer.java 5 May 2002 20:22:39 -0000 1.3 *************** *** 7,22 **** package net.sourceforge.ejtools.xml; - import org.w3c.dom.Document; - import org.w3c.dom.Element; - /** ! * Description of the Class * ! * @author letiembl ! * @created 26 février 2002 */ public class XmlContainer extends XmlComponent { ! /** Constructor for the XmlComponent object */ public XmlContainer() { --- 7,21 ---- package net.sourceforge.ejtools.xml; /** ! * Description of the Class * ! * @author letiembl ! * @created 26 février 2002 ! * @version $Revision$ ! * @todo JavaDoc to complete */ public class XmlContainer extends XmlComponent { ! /** Constructor for the XmlComponent object */ public XmlContainer() { *************** *** 26,32 **** /** ! * Constructor for the XmlText object * ! * @param name Description of Parameter */ public XmlContainer(String name) --- 25,31 ---- /** ! * Constructor for the XmlText object * ! * @param name Description of Parameter */ public XmlContainer(String name) *************** *** 37,45 **** /** ! * Description of the Method * ! * @param document Description of Parameter ! * @return Description of the Returned Value ! * @exception Exception Description of Exception */ public String toXml() --- 36,53 ---- /** ! * Description of the Method * ! * @return Description of the Returned Value ! */ ! public String toString() ! { ! return "Xml Container"; ! } ! ! ! /** ! * Description of the Method ! * ! * @return Description of the Returned Value */ public String toXml() *************** *** 47,51 **** String result = ""; ! result= result+ "<"+this.name+">\n"; // Append the children --- 55,59 ---- String result = ""; ! result = result + "<" + this.name + ">\n"; // Append the children *************** *** 56,73 **** } ! result= result+ "</"+this.name+">\n"; return result; - } - - - /** - * Description of the Method - * - * @return Description of the Returned Value - */ - public String toString() - { - return "Xml Container"; } } --- 64,70 ---- } ! result = result + "</" + this.name + ">\n"; return result; } } Index: XmlEditor.java =================================================================== RCS file: /cvsroot/ejtools/libraries/xmlweb/src/main/net/sourceforge/ejtools/xml/XmlEditor.java,v retrieving revision 1.2 retrieving revision 1.3 diff -C2 -d -r1.2 -r1.3 *** XmlEditor.java 25 Apr 2002 20:15:25 -0000 1.2 --- XmlEditor.java 5 May 2002 20:22:39 -0000 1.3 *************** *** 7,26 **** package net.sourceforge.ejtools.xml; - import org.w3c.dom.Document; - import org.w3c.dom.Element; - /** ! * Description of the Class * ! * @author letiembl ! * @created 26 février 2002 */ public class XmlEditor extends XmlText { ! /** Description of the Field */ protected String type = ""; ! /** Constructor for the XmlText object */ public XmlEditor() { --- 7,25 ---- package net.sourceforge.ejtools.xml; /** ! * Description of the Class * ! * @author letiembl ! * @created 26 février 2002 ! * @version $Revision$ ! * @todo JavaDoc to complete */ public class XmlEditor extends XmlText { ! /** Description of the Field */ protected String type = ""; ! /** Constructor for the XmlText object */ public XmlEditor() { *************** *** 30,58 **** /** ! * Setter for the target attribute * ! * @param type The new value */ ! public void setType(String type) { ! this.type = type; } /** ! * Getter for the target attribute * ! * @return The value of target attribute */ ! public String getType() { ! return type; } /** ! * Description of the Method * ! * @return Description of the Returned Value */ public String toString() --- 29,57 ---- /** ! * Getter for the target attribute * ! * @return The value of target attribute */ ! public String getType() { ! return type; } /** ! * Setter for the target attribute * ! * @param type The new value */ ! public void setType(String type) { ! this.type = type; } /** ! * Description of the Method * ! * @return Description of the Returned Value */ public String toString() *************** *** 63,71 **** /** ! * Description of the Method * ! * @param document Description of Parameter ! * @return Description of the Returned Value ! * @exception Exception Description of Exception */ public String toXml() --- 62,68 ---- /** ! * Description of the Method * ! * @return Description of the Returned Value */ public String toXml() *************** *** 73,79 **** String result = ""; ! result= result+ "<"+this.name+" type=\""+this.type+"\">"; ! result= result + this.text; ! result= result+ "</"+this.name+">\n"; return result; --- 70,76 ---- String result = ""; ! result = result + "<" + this.name + " type=\"" + this.type + "\">"; ! result = result + this.text; ! result = result + "</" + this.name + ">\n"; return result; Index: XmlIconable.java =================================================================== RCS file: /cvsroot/ejtools/libraries/xmlweb/src/main/net/sourceforge/ejtools/xml/XmlIconable.java,v retrieving revision 1.1 retrieving revision 1.2 diff -C2 -d -r1.1 -r1.2 *** XmlIconable.java 20 Apr 2002 11:42:51 -0000 1.1 --- XmlIconable.java 5 May 2002 20:22:39 -0000 1.2 *************** *** 8,19 **** /** ! * Description of the Class * ! * @author letiembl ! * @created 26 février 2002 */ public interface XmlIconable { ! public String getSmallIcon(); ! public String getBigIcon(); } --- 8,33 ---- /** ! * Description of the Class * ! * @author letiembl ! * @created 26 février 2002 ! * @version $Revision$ ! * @todo JavaDoc to complete */ public interface XmlIconable { ! /** ! * Gets the smallIcon attribute of the XmlIconable object ! * ! * @return The smallIcon value ! */ ! public String getSmallIcon(); ! ! ! /** ! * Gets the bigIcon attribute of the XmlIconable object ! * ! * @return The bigIcon value ! */ ! public String getBigIcon(); } Index: XmlLink.java =================================================================== RCS file: /cvsroot/ejtools/libraries/xmlweb/src/main/net/sourceforge/ejtools/xml/XmlLink.java,v retrieving revision 1.2 retrieving revision 1.3 diff -C2 -d -r1.2 -r1.3 *** XmlLink.java 25 Apr 2002 20:15:25 -0000 1.2 --- XmlLink.java 5 May 2002 20:22:39 -0000 1.3 *************** *** 7,26 **** package net.sourceforge.ejtools.xml; - import org.w3c.dom.Document; - import org.w3c.dom.Element; - /** ! * Description of the Class * ! * @author letiembl ! * @created 26 février 2002 */ public class XmlLink extends XmlText { ! /** Description of the Field */ protected String target = ""; ! /** Constructor for the XmlText object */ public XmlLink() { --- 7,25 ---- package net.sourceforge.ejtools.xml; /** ! * Description of the Class * ! * @author letiembl ! * @created 26 février 2002 ! * @version $Revision$ ! * @todo JavaDoc to complete */ public class XmlLink extends XmlText { ! /** Description of the Field */ protected String target = ""; ! /** Constructor for the XmlText object */ public XmlLink() { *************** *** 30,58 **** /** ! * Setter for the target attribute * ! * @param target The new value for target attribute */ ! public void setTarget(String target) { ! this.target = target; } /** ! * Getter for the target attribute * ! * @return The value of target attribute */ ! public String getTarget() { ! return target; } /** ! * Description of the Method * ! * @return Description of the Returned Value */ public String toString() --- 29,57 ---- /** ! * Getter for the target attribute * ! * @return The value of target attribute */ ! public String getTarget() { ! return target; } /** ! * Setter for the target attribute * ! * @param target The new value for target attribute */ ! public void setTarget(String target) { ! this.target = target; } /** ! * Description of the Method * ! * @return Description of the Returned Value */ public String toString() *************** *** 63,71 **** /** ! * Description of the Method * ! * @param document Description of Parameter ! * @return Description of the Returned Value ! * @exception Exception Description of Exception */ public String toXml() --- 62,68 ---- /** ! * Description of the Method * ! * @return Description of the Returned Value */ public String toXml() *************** *** 73,79 **** String result = ""; ! result= result+ "<"+this.name+" target=\""+this.target +"\">"; ! result= result + this.text; ! result= result+ "</"+this.name+">\n"; return result; --- 70,76 ---- String result = ""; ! result = result + "<" + this.name + " target=\"" + this.target + "\">"; ! result = result + this.text; ! result = result + "</" + this.name + ">\n"; return result; Index: XmlPrintable.java =================================================================== RCS file: /cvsroot/ejtools/libraries/xmlweb/src/main/net/sourceforge/ejtools/xml/XmlPrintable.java,v retrieving revision 1.2 retrieving revision 1.3 diff -C2 -d -r1.2 -r1.3 *** XmlPrintable.java 25 Apr 2002 20:15:25 -0000 1.2 --- XmlPrintable.java 5 May 2002 20:22:39 -0000 1.3 *************** *** 7,27 **** package net.sourceforge.ejtools.xml; - import org.w3c.dom.Document; - import org.w3c.dom.Element; - /** ! * Description of the Class * ! * @author letiembl ! * @created 26 février 2002 */ public interface XmlPrintable { /** ! * Description of the Method * ! * @param document Description of Parameter ! * @return Description of the Returned Value ! * @exception Exception Description of Exception */ public String toXml(); --- 7,24 ---- package net.sourceforge.ejtools.xml; /** ! * Description of the Class * ! * @author letiembl ! * @created 26 février 2002 ! * @version $Revision$ ! * @todo JavaDoc to complete */ public interface XmlPrintable { /** ! * Description of the Method * ! * @return Description of the Returned Value */ public String toXml(); Index: XmlText.java =================================================================== RCS file: /cvsroot/ejtools/libraries/xmlweb/src/main/net/sourceforge/ejtools/xml/XmlText.java,v retrieving revision 1.2 retrieving revision 1.3 diff -C2 -d -r1.2 -r1.3 *** XmlText.java 25 Apr 2002 20:15:25 -0000 1.2 --- XmlText.java 5 May 2002 20:22:39 -0000 1.3 *************** *** 7,26 **** package net.sourceforge.ejtools.xml; - import org.w3c.dom.Document; - import org.w3c.dom.Element; - /** ! * Description of the Class * ! * @author letiembl ! * @created 26 février 2002 */ public class XmlText extends XmlComponent { ! /** Description of the Field */ protected String text = ""; ! /** Constructor for the XmlText object */ public XmlText() { --- 7,25 ---- package net.sourceforge.ejtools.xml; /** ! * Description of the Class * ! * @author letiembl ! * @created 26 février 2002 ! * @version $Revision$ ! * @todo JavaDoc to complete */ public class XmlText extends XmlComponent { ! /** Description of the Field */ protected String text = ""; ! /** Constructor for the XmlText object */ public XmlText() { *************** *** 30,36 **** /** ! * Constructor for the XmlText object * ! * @param name Description of Parameter */ public XmlText(String name) --- 29,35 ---- /** ! * Constructor for the XmlText object * ! * @param name Description of Parameter */ public XmlText(String name) *************** *** 41,69 **** /** ! * Setter for the text attribute * ! * @param text The new value for text attribute */ ! public void setText(String text) { ! this.text = "" + text; } /** ! * Getter for the text attribute * ! * @return The value of text attribute */ ! public String getText() { ! return text; } /** ! * Description of the Method * ! * @return Description of the Returned Value */ public String toString() --- 40,68 ---- /** ! * Getter for the text attribute * ! * @return The value of text attribute */ ! public String getText() { ! return text; } /** ! * Setter for the text attribute * ! * @param text The new value for text attribute */ ! public void setText(String text) { ! this.text = "" + text; } /** ! * Description of the Method * ! * @return Description of the Returned Value */ public String toString() *************** *** 74,82 **** /** ! * Description of the Method * ! * @param document Description of Parameter ! * @return Description of the Returned Value ! * @exception Exception Description of Exception */ public String toXml() --- 73,79 ---- /** ! * Description of the Method * ! * @return Description of the Returned Value */ public String toXml() *************** *** 84,90 **** String result = ""; ! result= result+ "<"+this.name+">"; ! result= result + this.text; ! result= result+ "</"+this.name+">\n"; return result; --- 81,87 ---- String result = ""; ! result = result + "<" + this.name + ">"; ! result = result + this.text; ! result = result + "</" + this.name + ">\n"; return result; Index: XmlTreeNode.java =================================================================== RCS file: /cvsroot/ejtools/libraries/xmlweb/src/main/net/sourceforge/ejtools/xml/XmlTreeNode.java,v retrieving revision 1.2 retrieving revision 1.3 diff -C2 -d -r1.2 -r1.3 *** XmlTreeNode.java 25 Apr 2002 20:15:25 -0000 1.2 --- XmlTreeNode.java 5 May 2002 20:22:39 -0000 1.3 *************** *** 1,32 **** /* ! * EJTools, the Enterprise Java Tools * ! * Distributable under LGPL license. ! * See terms of license at www.gnu.org. */ package net.sourceforge.ejtools.xml; - import org.w3c.dom.Document; - import org.w3c.dom.Element; - /** ! * Description of the Class * ! * @author letiembl ! * @created 26 février 2002 */ public class XmlTreeNode extends XmlContainer { ! /** Description of the Field */ protected String bigIcon = null; ! /** Description of the Field */ protected XmlPrintable object = null; ! /** Description of the Field */ protected String smallIcon = null; ! /** Description of the Field */ protected Object userObject = null; ! /** Constructor for the XmlNode object */ public XmlTreeNode() { --- 1,31 ---- /* ! * EJTools, the Enterprise Java Tools * ! * Distributable under LGPL license. ! * See terms of license at www.gnu.org. */ package net.sourceforge.ejtools.xml; /** ! * Description of the Class * ! * @author letiembl ! * @created 26 février 2002 ! * @version $Revision$ ! * @todo JavaDoc to complete */ public class XmlTreeNode extends XmlContainer { ! /** Description of the Field */ protected String bigIcon = null; ! /** Description of the Field */ protected XmlPrintable object = null; ! /** Description of the Field */ protected String smallIcon = null; ! /** Description of the Field */ protected Object userObject = null; ! /** Constructor for the XmlNode object */ public XmlTreeNode() { *************** *** 36,42 **** /** ! * Getter for the userObject attribute * ! * @return The value of userObject attribute */ public Object getUserObject() --- 35,41 ---- /** ! * Getter for the userObject attribute * ! * @return The value of userObject attribute */ public Object getUserObject() *************** *** 47,53 **** /** ! * Setter for the userObject attribute * ! * @param userObject The new value for userObject attribute */ public void setUserObject(Object userObject) --- 46,52 ---- /** ! * Setter for the userObject attribute * ! * @param userObject The new value for userObject attribute */ public void setUserObject(Object userObject) *************** *** 79,85 **** /** ! * Description of the Method * ! * @return Description of the Returned Value */ public String toString() --- 78,84 ---- /** ! * Description of the Method * ! * @return Description of the Returned Value */ public String toString() *************** *** 90,96 **** /** ! * Description of the Method * ! * @return Description of the Return Value */ public String toXml() --- 89,95 ---- /** ! * Description of the Method * ! * @return Description of the Return Value */ public String toXml() |