org.millscript.millscript.datatypes
Class XmlComment

java.lang.Object
  org.millscript.millscript.datatypes.XmlComment

All Implemented Interfaces:

Fragment, Renderable

public final class XmlComment
extends java.lang.Object
implements Fragment, Renderable

An XmlComment is a lightweight object that plays the role of a comment in a XML document.

Constructor Summary

XmlComment(java.lang.String t)
Constructs a new XML comment object, with the specified string contents.

Method Summary

java.lang.String	getText() Returns the string contents of this XML comment.
void	render(Renderer r) This method is called to render the implementing object to the specified renderer.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

XmlComment

public XmlComment(java.lang.String t)

Constructs a new XML comment object, with the specified string contents.

Parameters:

t - the string contents of the XML comment

Method Detail

render

public void render(Renderer r)
            throws java.io.IOException

Description copied from interface: Renderable

This method is called to render the implementing object to the specified renderer.

If the implementing object is not a core part of MillScript you may need to query what type of renderer it is, so you can further customise your rendering as appropriate.

Specified by:

render in interface Renderable

Parameters:

r - the renderer to render this object with

Throws:

java.io.IOException - thrown if an IO problem occurs

See Also:

Renderable.render(Renderer)

getText

public java.lang.String getText()

Returns the string contents of this XML comment.

Returns:

a String containing the contents of this XML comment

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

See Also:

Object.toString()