edu.umd.cs.findbugs.xml

Class XMLOutputUtil

java.lang.Object

edu.umd.cs.findbugs.xml.XMLOutputUtil

public abstract class XMLOutputUtil
extends java.lang.Object

Utility routines for writing to XMLOutput.

Author:

David Hovemeyer

See Also:

XMLOutput

Constructor Summary

Constructors

Constructor and Description
XMLOutputUtil()

Method Summary

Methods

Modifier and Type	Method and Description
static void	writeCollection(XMLOutput xmlOutput, java.util.Collection<? extends XMLWriteable> collection) Write a Collection of XMLWriteable objects.
static void	writeElementList(XMLOutput xmlOutput, java.lang.String tagName, java.lang.Iterable<java.lang.String> listValues) Write a list of Strings to document as elements with given tag name.
static void	writeElementList(XMLOutput xmlOutput, java.lang.String tagName, java.util.Iterator<java.lang.String> listValueIterator) Write a list of Strings to document as elements with given tag name.
static void	writeFileList(XMLOutput xmlOutput, java.lang.String tagName, java.lang.Iterable<java.io.File> listValues) Write a list of Strings to document as elements with given tag name.
static void	writeFileList(XMLOutput xmlOutput, java.lang.String tagName, java.util.Iterator<java.io.File> listValueIterator) Write a list of Strings to document as elements with given tag name.

Methods inherited from class java.lang.Object

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

Constructor Detail

XMLOutputUtil

public XMLOutputUtil()

Method Detail

writeElementList

public static void writeElementList(XMLOutput xmlOutput,
                    java.lang.String tagName,
                    java.lang.Iterable<java.lang.String> listValues)
                             throws java.io.IOException

Write a list of Strings to document as elements with given tag name.

Parameters:

xmlOutput - the XMLOutput object to write to

tagName - the tag name

listValues - Collection of String values to write

Throws:

java.io.IOException

writeElementList

public static void writeElementList(XMLOutput xmlOutput,
                    java.lang.String tagName,
                    java.util.Iterator<java.lang.String> listValueIterator)
                             throws java.io.IOException

Write a list of Strings to document as elements with given tag name.

Parameters:

xmlOutput - the XMLOutput object to write to

tagName - the tag name

listValueIterator - Iterator over String values to write

Throws:

java.io.IOException

writeFileList

public static void writeFileList(XMLOutput xmlOutput,
                 java.lang.String tagName,
                 java.lang.Iterable<java.io.File> listValues)
                          throws java.io.IOException

Write a list of Strings to document as elements with given tag name.

Parameters:

xmlOutput - the XMLOutput object to write to

tagName - the tag name

listValues - Collection of String values to write

Throws:

java.io.IOException

writeFileList

public static void writeFileList(XMLOutput xmlOutput,
                 java.lang.String tagName,
                 java.util.Iterator<java.io.File> listValueIterator)
                          throws java.io.IOException

Write a list of Strings to document as elements with given tag name.

Parameters:

xmlOutput - the XMLOutput object to write to

tagName - the tag name

listValueIterator - Iterator over String values to write

Throws:

java.io.IOException

writeCollection

public static void writeCollection(XMLOutput xmlOutput,
                   java.util.Collection<? extends XMLWriteable> collection)
                            throws java.io.IOException

Write a Collection of XMLWriteable objects.

Parameters:

xmlOutput - the XMLOutput object to write to

collection - Collection of XMLWriteable objects

Throws:

java.io.IOException