//==============================================================================
// XmlCommentI.java
//------------------------------------------------------------------------------

package tribble.xml;


// System imports

import java.lang.Exception;
import java.lang.String;


// Local imports

// (None)


/*******************************************************************************
* XML comment.
*
* <p>
* Contains the textual contents of an XML comment.
*
* <!------------------------------------------------------------------------ -->
* <p>
* <b> Example </b>
*
* <p>
* The following XML document:
* <pre>
*    &lt;!-- Generated: 2003-05-13 21:36 Z --&gt;
*    &lt;item
*      Count="20" SKU="HG-52814(J)-F" Unit-Cost="149.95"&gt;
*      &lt;!--
*      ! Table: 'INV03'
*      ! Query: SKU='HG-52814(J)-F'
*      !--&gt;
*      Oak business desk with &lt;![CDATA[cherry &amp; chrome]]&gt; finish
*    &lt;/item&gt; </pre>
*
* <p>
* contains two comments:
* <pre>
*    <i>comment</i> " Generated: 2003-05-13 21:36 Z "
*    <i>comment</i> "\n! Table: 'INV03'\n! Query: SKU='HG-52814(J)-F'\n" </pre>
*
* <!------------------------------------------------------------------------ -->
* @version	$Revision: 1.1 $ $Date: 2003/05/14 02:42:35 $
* @since	2003-05-13
* @author
*	David R. Tribble
*	(<a href="mailto:david@tribble.com">david@tribble.com</a>).
*	<br>
*	Copyright ©2003 by David R. Tribble, all rights reserved.
*	<br>
*	Permission is granted to freely use and distribute this source code
*	provided that the original copyright and authorship notices remain
*	intact.
*/

public interface XmlCommentI
    extends XmlItemI
{
// Identification

    /** Revision information. */
    static final String		REV =
        "@(#)tribble/xml/XmlCommentI.java $Revision: 1.1 $ $Date: 2003/05/14 02:42:35 $\n";


// - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
// Public constants

    // (None)


// - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
// Public methods

    /***************************************************************************
    * Retrieve the textual content of this XML comment.
    *
    * @return
    * Text contents of this XML comment, which can be empty (<tt>""</tt>).
    *
    * @since	1.1, 2003-05-13
    */

    public String getText();
        /*const*/
}

// End XmlCommentI.java