1  // HTMLParser Library $Name: v1_6_20060319 $ - A java-based parser for HTML
  2  // http://sourceforge.org/projects/htmlparser
  3  // Copyright (C) 2004 Derrick Oswald
  4  //
  5  // Revision Control Information
  6  //
  7  // $Source: /cvsroot/htmlparser/htmlparser/src/org/htmlparser/Remark.java,v $
  8  // $Author: derrickoswald $
  9  // $Date: 2005/11/15 02:09:10 $
 10  // $Revision: 1.4 $
 11  //
 12  // This library is free software; you can redistribute it and/or
 13  // modify it under the terms of the GNU Lesser General Public
 14  // License as published by the Free Software Foundation; either
 15  // version 2.1 of the License, or (at your option) any later version.
 16  //
 17  // This library is distributed in the hope that it will be useful,
 18  // but WITHOUT ANY WARRANTY; without even the implied warranty of
 19  // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 20  // Lesser General Public License for more details.
 21  //
 22  // You should have received a copy of the GNU Lesser General Public
 23  // License along with this library; if not, write to the Free Software
 24  // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
 25  //
 26  
 27  package org.htmlparser;
 28  
 29  /**
 30   * This interface represents a comment in the HTML document.
 31   */
 32  public interface Remark
 33      extends
 34          Node
 35  {
 36      /**
 37       * Returns the text contents of the comment tag.
 38       * @return The contents of the text inside the comment delimiters.
 39       * @see #setText
 40       */
 41      String getText();
 42  
 43      /**
 44       * Sets the string contents of the node.
 45       * If the text has the remark delimiters (<!-- -->),
 46       * these are stripped off.
 47       * @param text The new text for the node.
 48       * @see #getText
 49       */
 50      void setText (String text);
 51  
 52      //
 53      // Node interface
 54      //
 55  
 56  //    public void accept (NodeVisitor visitor)
 57  //    {
 58  //    }
 59  //
 60  //    public void collectInto (NodeList collectionList, NodeFilter filter)
 61  //    {
 62  //    }
 63  //
 64  //    public NodeList getChildren ()
 65  //    {
 66  //    }
 67  //
 68  //    public int getEndPosition ()
 69  //    {
 70  //    }
 71  //
 72  //    public Node getParent ()
 73  //    {
 74  //    }
 75  //
 76  //    public int getStartPosition ()
 77  //    {
 78  //    }
 79  //
 80  //    public void setChildren (NodeList children)
 81  //    {
 82  //    }
 83  //
 84  //    public void setEndPosition (int position)
 85  //    {
 86  //    }
 87  //
 88  //    public void setParent (Node node)
 89  //    {
 90  //    }
 91  //
 92  //    public void setStartPosition (int position)
 93  //    {
 94  //    }
 95  //
 96  //    public String toHtml ()
 97  //    {
 98  //    }
 99  //
100  //    public String toPlainTextString ()
101  //    {
102  //    }
103  }