Class Ignore

  • All Implemented Interfaces:
    HasText, java.io.Serializable

    public class Ignore
    extends Invocation
    implements HasText
    This class is transient for XML parsing. It does not store anything, just goes through the motions to satisfy the API.
    Version:
    $Revision$
    Author:
    Jens-S. Vöckler, Yong Zhao
    See Also:
    StatCall, Serialized Form
    • Constructor Summary

      Constructors 
      Constructor Description
      Ignore()
      Default c'tor.
      Ignore​(java.lang.String value)
      Constructs a piece of data.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void appendValue​(java.lang.String fragment)
      Appends a piece of text to the existing text.
      java.lang.String getValue()
      Accessor
      void setValue​(java.lang.String value)
      Accessor.
      void toString​(java.io.Writer stream)
      Converts the active state into something meant for human consumption.
      void toXML​(java.io.Writer stream, java.lang.String indent, java.lang.String namespace)
      Dump the state of the current element as XML output.
      • Methods inherited from class org.griphyn.vdl.Chimera

        escape, quote, toString, toXML, toXML, writeAttribute
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
    • Constructor Detail

      • Ignore

        public Ignore()
        Default c'tor.
      • Ignore

        public Ignore​(java.lang.String value)
        Constructs a piece of data.
        Parameters:
        value - is the data to remember. The string may be empty, but it must not be null.
        Throws:
        java.lang.NullPointerException - if the argument was null.
    • Method Detail

      • appendValue

        public void appendValue​(java.lang.String fragment)
        Appends a piece of text to the existing text.
        Specified by:
        appendValue in interface HasText
        Parameters:
        fragment - is a piece of text to append to existing text. Appending null is a noop.
      • setValue

        public void setValue​(java.lang.String value)
        Accessor.
        Specified by:
        setValue in interface HasText
        Parameters:
        value - is the new value to set.
        See Also:
        getValue()
      • toString

        public void toString​(java.io.Writer stream)
                      throws java.io.IOException
        Converts the active state into something meant for human consumption. The method will be called when recursively traversing the instance tree.
        Specified by:
        toString in class org.griphyn.vdl.Chimera
        Parameters:
        stream - is a stream opened and ready for writing. This can also be a string stream for efficient output.
        Throws:
        java.io.IOException - if something fishy happens to the stream.
      • toXML

        public void toXML​(java.io.Writer stream,
                          java.lang.String indent,
                          java.lang.String namespace)
                   throws java.io.IOException
        Dump the state of the current element as XML output. This function traverses all sibling classes as necessary, and converts the data into pretty-printed XML output. The stream interface should be able to handle large output efficiently.
        Specified by:
        toXML in class org.griphyn.vdl.Chimera
        Parameters:
        stream - is a stream opened and ready for writing. This can also be a string stream for efficient output.
        indent - is a String of spaces used for pretty printing. The initial amount of spaces should be an empty string. The parameter is used internally for the recursive traversal. If a null value is specified, no indentation nor linefeeds will be generated.
        namespace - is the XML schema namespace prefix. If neither empty nor null, each element will be prefixed with this prefix, and the root element will map the XML namespace.
        Throws:
        java.io.IOException - if something fishy happens to the stream.
        See Also:
        BufferedWriter