[Htmlparser-cvs] htmlparser/src/org/htmlparser Attribute.java,1.7,1.8 Node.java,1.54,1.55 Parser.jav
Brought to you by:
derrickoswald
Menu
▾
▴
[Htmlparser-cvs] htmlparser/src/org/htmlparser Attribute.java,1.7,1.8 Node.java,1.54,1.55 Parser.java,1.109,1.110 PrototypicalNodeFactory.java,1.17,1.18 Remark.java,1.3,1.4 StringNodeFactory.java,1.13,1.14 Tag.java,1.6,1.7 Text.java,1.3,1.4
Update of /cvsroot/htmlparser/htmlparser/src/org/htmlparser In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv23209 Modified Files: Attribute.java Node.java Parser.java PrototypicalNodeFactory.java Remark.java StringNodeFactory.java Tag.java Text.java Log Message: Fix warnings flagged by doccheck. Index: Remark.java =================================================================== RCS file: /cvsroot/htmlparser/htmlparser/src/org/htmlparser/Remark.java,v retrieving revision 1.3 retrieving revision 1.4 diff -C2 -d -r1.3 -r1.4 *** Remark.java 15 May 2005 11:49:03 -0000 1.3 --- Remark.java 15 Nov 2005 02:09:10 -0000 1.4 *************** *** 37,40 **** --- 37,41 ---- * Returns the text contents of the comment tag. * @return The contents of the text inside the comment delimiters. + * @see #setText */ String getText(); *************** *** 45,48 **** --- 46,50 ---- * these are stripped off. * @param text The new text for the node. + * @see #getText */ void setText (String text); Index: Node.java =================================================================== RCS file: /cvsroot/htmlparser/htmlparser/src/org/htmlparser/Node.java,v retrieving revision 1.54 retrieving revision 1.55 diff -C2 -d -r1.54 -r1.55 *** Node.java 26 Oct 2005 22:01:23 -0000 1.54 --- Node.java 15 Nov 2005 02:09:10 -0000 1.55 *************** *** 134,137 **** --- 134,138 ---- * This is the character (not byte) offset of this node in the page. * @return The start position. + * @see #setStartPosition */ int getStartPosition (); *************** *** 140,143 **** --- 141,145 ---- * Sets the starting position of the node. * @param position The new start position. + * @see #getStartPosition */ void setStartPosition (int position); *************** *** 148,151 **** --- 150,154 ---- * node in the page. * @return The end position. + * @see #setEndPosition */ int getEndPosition (); *************** *** 154,157 **** --- 157,161 ---- * Sets the ending position of the node. * @param position The new end position. + * @see #getEndPosition */ void setEndPosition (int position); *************** *** 160,163 **** --- 164,168 ---- * Get the page this node came from. * @return The page that supplied this node. + * @see #setPage */ Page getPage (); *************** *** 166,169 **** --- 171,175 ---- * Set the page this node came from. * @param page The page that supplied this node. + * @see #getPage */ void setPage (Page page); *************** *** 184,187 **** --- 190,194 ---- * @return The parent of this node, if it's been set, <code>null</code> * otherwise. + * @see #setParent */ Node getParent (); *************** *** 190,193 **** --- 197,201 ---- * Sets the parent of this node. * @param node The node that contains this node. + * @see #getParent */ void setParent (Node node); *************** *** 197,200 **** --- 205,209 ---- * @return The list of children contained by this node, if it's been set, * <code>null</code> otherwise. + * @see #setChildren */ NodeList getChildren (); *************** *** 203,206 **** --- 212,216 ---- * Set the children of this node. * @param children The new list of children this node contains. + * @see #getChildren */ void setChildren (NodeList children); *************** *** 238,241 **** --- 248,252 ---- * @return The contents of the string or remark node, and in the case of * a tag, the contents of the tag less the enclosing angle brackets. + * @see #setText */ String getText (); *************** *** 244,247 **** --- 255,259 ---- * Sets the string contents of the node. * @param text The new text for the node. + * @see #getText */ void setText (String text); Index: Tag.java =================================================================== RCS file: /cvsroot/htmlparser/htmlparser/src/org/htmlparser/Tag.java,v retrieving revision 1.6 retrieving revision 1.7 diff -C2 -d -r1.6 -r1.7 *** Tag.java 15 May 2005 11:49:03 -0000 1.6 --- Tag.java 15 Nov 2005 02:09:10 -0000 1.7 *************** *** 42,46 **** * @param name Name of attribute, case insensitive. * @return The value associated with the attribute or null if it does ! * not exist, or is a stand-alone or */ String getAttribute (String name); --- 42,47 ---- * @param name Name of attribute, case insensitive. * @return The value associated with the attribute or null if it does ! * not exist, or is a stand-alone. ! * @see #setAttribute */ String getAttribute (String name); *************** *** 51,54 **** --- 52,57 ---- * @param key The name of the attribute. * @param value The value of the attribute. + * @see #getAttribute + * @see #setAttribute(String,String,char) */ void setAttribute (String key, String value); *************** *** 60,63 **** --- 63,67 ---- * @param quote The quote character to be used around value. * If zero, it is an unquoted value. + * @see #getAttribute */ void setAttribute (String key, String value, char quote); *************** *** 74,77 **** --- 78,82 ---- * @return The attribute or null if it does * not exist. + * @see #setAttributeEx */ Attribute getAttributeEx (String name); *************** *** 82,85 **** --- 87,91 ---- * To set the zeroth attribute (the tag name), use setTagName(). * @param attribute The attribute to set. + * @see #getAttributeEx */ void setAttributeEx (Attribute attribute); *************** *** 88,91 **** --- 94,98 ---- * Gets the attributes in the tag. * @return Returns the list of {@link Attribute Attributes} in the tag. + * @see #setAttributesEx */ Vector getAttributesEx (); *************** *** 97,100 **** --- 104,108 ---- * and the second element being the value. * @param attribs The attribute collection to set. + * @see #getAttributesEx */ void setAttributesEx (Vector attribs); *************** *** 112,118 **** * for an attribute (either no equals sign or nothing to the right of the * equals sign). A special entry with a key of ! * SpecialHashtable.TAGNAME ("$<TAGNAME>$") holds the tag name. * The conversion to uppercase is performed with an ENGLISH locale. * @deprecated Use getAttributesEx() instead. */ Hashtable getAttributes (); --- 120,127 ---- * for an attribute (either no equals sign or nothing to the right of the * equals sign). A special entry with a key of ! * SpecialHashtable.TAGNAME ("$<TAGNAME>$") holds the tag name. * The conversion to uppercase is performed with an ENGLISH locale. * @deprecated Use getAttributesEx() instead. + * @see #setAttributes */ Hashtable getAttributes (); *************** *** 120,127 **** /** * Sets the attributes. ! * A special entry with a key of SpecialHashtable.TAGNAME ("$<TAGNAME>$") * sets the tag name. * @param attributes The attribute collection to set. * @deprecated Use setAttributesEx() instead. */ void setAttributes (Hashtable attributes); --- 129,137 ---- /** * Sets the attributes. ! * A special entry with a key of SpecialHashtable.TAGNAME ("$<TAGNAME>$") * sets the tag name. * @param attributes The attribute collection to set. * @deprecated Use setAttributesEx() instead. + * @see #getAttributes */ void setAttributes (Hashtable attributes); *************** *** 137,140 **** --- 147,151 ---- * </em> * @return The tag name. + * @see #setTagName */ String getTagName (); *************** *** 145,148 **** --- 156,160 ---- * zeroth element of the attribute vector). * @param name The tag name. + * @see #getTagName */ void setTagName (String name); *************** *** 213,216 **** --- 225,229 ---- * For a non-composite tag this always returns <code>null</code>. * @return The tag that terminates this composite tag, i.e. </HTML>. + * @see #setEndTag */ Tag getEndTag (); *************** *** 220,223 **** --- 233,237 ---- * For a non-composite tag this is a no-op. * @param tag The tag that closes this composite tag, i.e. </HTML>. + * @see #getEndTag */ void setEndTag (Tag tag); *************** *** 226,229 **** --- 240,244 ---- * Return the scanner associated with this tag. * @return The scanner associated with this tag. + * @see #setThisScanner */ Scanner getThisScanner (); *************** *** 232,235 **** --- 247,251 ---- * Set the scanner associated with this tag. * @param scanner The scanner for this tag. + * @see #getThisScanner */ void setThisScanner (Scanner scanner); Index: Text.java =================================================================== RCS file: /cvsroot/htmlparser/htmlparser/src/org/htmlparser/Text.java,v retrieving revision 1.3 retrieving revision 1.4 diff -C2 -d -r1.3 -r1.4 *** Text.java 15 May 2005 11:49:03 -0000 1.3 --- Text.java 15 Nov 2005 02:09:10 -0000 1.4 *************** *** 37,40 **** --- 37,41 ---- * Accesses the textual contents of the node. * @return The text of the node. + * @see #setText */ String getText (); *************** *** 43,46 **** --- 44,48 ---- * Sets the contents of the node. * @param text The new text for the node. + * @see #getText */ void setText (String text); Index: Parser.java =================================================================== RCS file: /cvsroot/htmlparser/htmlparser/src/org/htmlparser/Parser.java,v retrieving revision 1.109 retrieving revision 1.110 diff -C2 -d -r1.109 -r1.110 *** Parser.java 12 Nov 2005 15:11:45 -0000 1.109 --- Parser.java 15 Nov 2005 02:09:10 -0000 1.110 *************** *** 197,200 **** --- 197,201 ---- * Get the connection manager all Parsers use. * @return The connection manager. + * @see #setConnectionManager */ public static ConnectionManager getConnectionManager () *************** *** 206,209 **** --- 207,211 ---- * Set the connection manager all Parsers use. * @param manager The new connection manager. + * @see #getConnectionManager */ public static void setConnectionManager (ConnectionManager manager) *************** *** 357,360 **** --- 359,363 ---- * lexer. * @see #setLexer + * @see #getConnection */ public void setConnection (URLConnection connection) *************** *** 385,388 **** --- 388,392 ---- * @throws ParserException If the url is invalid or creation of the * underlying Lexer cannot be performed. + * @see #getURL */ public void setURL (String url) *************** *** 400,403 **** --- 404,408 ---- * for example, a file name may be modified to be a URL. * @see Page#getUrl + * @see #setURL */ public String getURL () *************** *** 413,416 **** --- 418,422 ---- * have been seen had the new encoding been in force. * @see org.htmlparser.util.EncodingChangeException + * @see #getEncoding */ public void setEncoding (String encoding) *************** *** 426,429 **** --- 432,436 ---- * tags in the head, so this may change after the head has been parsed. * @return The encoding currently in force. + * @see #setEncoding */ public String getEncoding () *************** *** 440,443 **** --- 447,451 ---- * @param lexer The lexer object to use. * @see #setNodeFactory + * @see #getLexer */ public void setLexer (Lexer lexer) *************** *** 465,470 **** /** ! * Returns the lexer associated with the parser * @return The current lexer. */ public Lexer getLexer () --- 473,479 ---- /** ! * Returns the lexer associated with the parser. * @return The current lexer. + * @see #setLexer */ public Lexer getLexer () *************** *** 476,479 **** --- 485,489 ---- * Get the current node factory. * @return The current lexer's node factory. + * @see #setNodeFactory */ public NodeFactory getNodeFactory () *************** *** 485,488 **** --- 495,499 ---- * Set the current node factory. * @param factory The new node factory for the current lexer. + * @see #getNodeFactory */ public void setNodeFactory (NodeFactory factory) *************** *** 497,500 **** --- 508,512 ---- * @param fb The new feedback object to use. If this is null a * {@link #DEVNULL silent feedback object} is used. + * @see #getFeedback */ public void setFeedback (ParserFeedback fb) *************** *** 509,512 **** --- 521,525 ---- * Returns the current feedback object. * @return The feedback object currently being used. + * @see #setFeedback */ public ParserFeedback getFeedback() *************** *** 760,764 **** /** ! * The main program, which can be executed from the command line * @param args A URL or file name to parse, and an optional tag name to be * used as a filter. --- 773,777 ---- /** ! * The main program, which can be executed from the command line. * @param args A URL or file name to parse, and an optional tag name to be * used as a filter. Index: Attribute.java =================================================================== RCS file: /cvsroot/htmlparser/htmlparser/src/org/htmlparser/Attribute.java,v retrieving revision 1.7 retrieving revision 1.8 diff -C2 -d -r1.7 -r1.8 *** Attribute.java 15 May 2005 11:49:03 -0000 1.7 --- Attribute.java 15 Nov 2005 02:09:10 -0000 1.8 *************** *** 68,72 **** * <p> * <table width="100.0%" align="Center" border="1"> ! * <caption>Valid States for Attributes. * <tr> * <th align="Center">Description</th> --- 68,72 ---- * <p> * <table width="100.0%" align="Center" border="1"> ! * <caption>Valid States for Attributes.</caption> * <tr> * <th align="Center">Description</th> *************** *** 340,343 **** --- 340,344 ---- * @return The name, or <code>null</code> if it's just a whitepace * 'attribute'. + * @see #setName */ public String getName () *************** *** 350,353 **** --- 351,355 ---- * @param buffer The buffer to place the name in. * @see #getName() + * @see #setName */ public void getName (StringBuffer buffer) *************** *** 364,367 **** --- 366,371 ---- * malformed HTML if the assignment string is not <code>null</code>. * @param name The new name. + * @see #getName + * @see #getName(StringBuffer) */ public void setName (String name) *************** *** 375,378 **** --- 379,383 ---- * can include whitespace on either or both sides of an equals sign. * @return The assignment string. + * @see #setAssignment */ public String getAssignment () *************** *** 385,388 **** --- 390,394 ---- * @param buffer The buffer to place the assignment string in. * @see #getAssignment() + * @see #setAssignment */ public void getAssignment (StringBuffer buffer) *************** *** 399,402 **** --- 405,410 ---- * <code>null</code>. * @param assignment The new assignment string. + * @see #getAssignment + * @see #getAssignment(StringBuffer) */ public void setAssignment (String assignment) *************** *** 414,417 **** --- 422,426 ---- * @return The value, or <code>null</code> if it's a stand-alone or * empty attribute, or the text if it's just a whitepace 'attribute'. + * @see #setValue */ public String getValue () *************** *** 424,427 **** --- 433,437 ---- * @param buffer The buffer to place the value in. * @see #getValue() + * @see #setValue */ public void getValue (StringBuffer buffer) *************** *** 439,442 **** --- 449,454 ---- * HTML. * @param value The new value. + * @see #getValue + * @see #getValue(StringBuffer) */ public void setValue (String value) *************** *** 449,452 **** --- 461,465 ---- * @return Either ' or " if the attribute value was quoted, or zero * if there are no quotes around it. + * @see #setQuote */ public char getQuote () *************** *** 459,462 **** --- 472,476 ---- * @param buffer The buffer to place the quote in. * @see #getQuote() + * @see #setQuote */ public void getQuote (StringBuffer buffer) *************** *** 472,475 **** --- 486,491 ---- * whitespace). * @param quote The new quote value. + * @see #getQuote + * @see #getQuote(StringBuffer) */ public void setQuote (char quote) *************** *** 484,487 **** --- 500,504 ---- * @return The value, or <code>null</code> if it's a stand-alone attribute, * or the text if it's just a whitepace 'attribute'. + * @see #setRawValue */ public String getRawValue () *************** *** 517,520 **** --- 534,538 ---- * @param buffer The string buffer to append the attribute value to. * @see #getRawValue() + * @see #setRawValue */ public void getRawValue (StringBuffer buffer) *************** *** 535,538 **** --- 553,558 ---- * double quotes within the string to character references. * @param value The new value. + * @see #getRawValue + * @see #getRawValue(StringBuffer) */ public void setRawValue (String value) Index: StringNodeFactory.java =================================================================== RCS file: /cvsroot/htmlparser/htmlparser/src/org/htmlparser/StringNodeFactory.java,v retrieving revision 1.13 retrieving revision 1.14 diff -C2 -d -r1.13 -r1.14 *** StringNodeFactory.java 10 Apr 2005 23:20:42 -0000 1.13 --- StringNodeFactory.java 15 Nov 2005 02:09:10 -0000 1.14 *************** *** 70,74 **** { /** ! * Flag to tell the parser to decode strings returned by StringNode's toPlainTextString. * Decoding occurs via the method, org.htmlparser.util.Translate.decode() */ --- 70,74 ---- { /** ! * Flag to toggle decoding of strings. * Decoding occurs via the method, org.htmlparser.util.Translate.decode() */ *************** *** 77,91 **** /** ! * Flag to tell the parser to remove escape characters, like \n and \t, returned by StringNode's toPlainTextString. ! * Escape character removal occurs via the method, org.htmlparser.util.ParserUtils.removeEscapeCharacters() */ protected boolean mRemoveEscapes; /** ! * Flag to tell the parser to convert non breaking space (from \u00a0 to a space " "). * If true, this will happen inside StringNode's toPlainTextString. */ protected boolean mConvertNonBreakingSpaces; ! public StringNodeFactory () { --- 77,95 ---- /** ! * Flag to toggle removal of escape characters, like \n and \t. ! * Escape character removal occurs via the method, ! * org.htmlparser.util.ParserUtils.removeEscapeCharacters() */ protected boolean mRemoveEscapes; /** ! * Flag to toggle converting non breaking spaces (from \u00a0 to space " "). * If true, this will happen inside StringNode's toPlainTextString. */ protected boolean mConvertNonBreakingSpaces; ! ! /** ! * Create the default string node factory. ! */ public StringNodeFactory () { *************** *** 104,107 **** --- 108,112 ---- * @param start The beginning position of the string. * @param end The ending positiong of the string. + * @return The text node for the page and range given. */ public Text createStringNode (Page page, int start, int end) *************** *** 122,126 **** /** * Set the decoding state. ! * @param decode If <code>true</code>, string nodes decode text using {@link org.htmlparser.util.Translate#decode}. */ public void setDecode (boolean decode) --- 127,133 ---- /** * Set the decoding state. ! * @param decode If <code>true</code>, string nodes decode text using ! * {@link org.htmlparser.util.Translate#decode}. ! * @see #getDecode */ public void setDecode (boolean decode) *************** *** 132,135 **** --- 139,143 ---- * Get the decoding state. * @return <code>true</code> if string nodes decode text. + * @see #setDecode */ public boolean getDecode () *************** *** 140,144 **** /** * Set the escape removing state. ! * @param remove If <code>true</code>, string nodes remove escape characters. */ public void setRemoveEscapes (boolean remove) --- 148,154 ---- /** * Set the escape removing state. ! * @param remove If <code>true</code>, string nodes remove escape ! * characters. ! * @see #getRemoveEscapes */ public void setRemoveEscapes (boolean remove) *************** *** 150,153 **** --- 160,164 ---- * Get the escape removing state. * @return The removing state. + * @see #setRemoveEscapes */ public boolean getRemoveEscapes () *************** *** 158,162 **** /** * Set the non-breaking space replacing state. ! * @param convert If <code>true</code>, string nodes replace ;nbsp; characters with spaces. */ public void setConvertNonBreakingSpaces (boolean convert) --- 169,175 ---- /** * Set the non-breaking space replacing state. ! * @param convert If <code>true</code>, string nodes replace ;nbsp; ! * characters with spaces. ! * @see #getConvertNonBreakingSpaces */ public void setConvertNonBreakingSpaces (boolean convert) *************** *** 168,171 **** --- 181,185 ---- * Get the non-breaking space replacing state. * @return The replacing state. + * @see #setConvertNonBreakingSpaces */ public boolean getConvertNonBreakingSpaces () Index: PrototypicalNodeFactory.java =================================================================== RCS file: /cvsroot/htmlparser/htmlparser/src/org/htmlparser/PrototypicalNodeFactory.java,v retrieving revision 1.17 retrieving revision 1.18 diff -C2 -d -r1.17 -r1.18 *** PrototypicalNodeFactory.java 12 Nov 2005 14:19:51 -0000 1.17 --- PrototypicalNodeFactory.java 15 Nov 2005 02:09:10 -0000 1.18 *************** *** 77,81 **** * This factory uses the prototype pattern to generate new nodes. * These are cloned as needed to form new {@link Text}, {@link Remark} and ! * {@link Tag} nodes.</p> * <p>Text and remark nodes are generated from prototypes accessed * via the {@link #setTextPrototype(Text) textPrototype} and --- 77,81 ---- * This factory uses the prototype pattern to generate new nodes. * These are cloned as needed to form new {@link Text}, {@link Remark} and ! * {@link Tag} nodes. * <p>Text and remark nodes are generated from prototypes accessed * via the {@link #setTextPrototype(Text) textPrototype} and *************** *** 341,344 **** --- 341,345 ---- * Get the object that is cloned to generate text nodes. * @return The prototype for {@link Text} nodes. + * @see #setTextPrototype */ public Text getTextPrototype () *************** *** 352,355 **** --- 353,357 ---- * If <code>null</code> the prototype is set to the default * ({@link TextNode}). + * @see #getTextPrototype */ public void setTextPrototype (Text text) *************** *** 364,367 **** --- 366,370 ---- * Get the object that is cloned to generate remark nodes. * @return The prototype for {@link Remark} nodes. + * @see #setRemarkPrototype */ public Remark getRemarkPrototype () *************** *** 375,378 **** --- 378,382 ---- * If <code>null</code> the prototype is set to the default * ({@link RemarkNode}). + * @see #getRemarkPrototype */ public void setRemarkPrototype (Remark remark) *************** *** 389,392 **** --- 393,397 ---- * specific tag is found in the list of registered tags. * @return The prototype for {@link Tag} nodes. + * @see #setTagPrototype */ public Tag getTagPrototype () *************** *** 402,405 **** --- 407,411 ---- * If <code>null</code> the prototype is set to the default * ({@link TagNode}). + * @see #getTagPrototype */ public void setTagPrototype (Tag tag) |
