Class TXW


  • public abstract class TXW
    extends Object
    Entry point to TXW.
    Author:
    Kohsuke Kawaguchi
    • Method Detail

      • create

        public static <T extends TypedXmlWriter> T create​(Class<T> rootElement,
                                                          XmlSerializer out)
        Creates a new TypedXmlWriter to write a new instance of a document.
        Type Parameters:
        T - an instance of TypedXmlWriter
        Parameters:
        rootElement - The TypedXmlWriter interface that declares the content model of the root element. This interface must have XmlElement annotation on it to designate the tag name of the root element.
        out - The target of the writing.
        Returns:
        always return non-null TypedXmlWriter that can be used to write the contents of the root element.
      • create

        public static <T extends TypedXmlWriter> T create​(QName tagName,
                                                          Class<T> rootElement,
                                                          XmlSerializer out)
        Creates a new TypedXmlWriter to write a new instance of a document.

        Similar to the other method, but this version allows the caller to set the tag name at the run-time.

        Type Parameters:
        T - an instance of TypedXmlWriter
        Parameters:
        tagName - The tag name of the root document.
        rootElement - The TypedXmlWriter interface that declares the content model of the root element. This interface must have XmlElement annotation on it to designate the tag name of the root element.
        out - The target of the writing.
        Returns:
        always return non-null TypedXmlWriter that can be used to write the contents of the root element.
        See Also:
        create(Class,XmlSerializer)