org.springframework.xml.transform
Class TraxUtils

java.lang.Object
  extended by org.springframework.xml.transform.TraxUtils

public abstract class TraxUtils
extends java.lang.Object

Convenient utility methods for dealing with TrAX.

Since:
1.5.0
Author:
Arjen Poutsma

Nested Class Summary
static interface TraxUtils.ResultCallback
          Callback interface invoked on each sort of Result.
static interface TraxUtils.SourceCallback
          Callback interface invoked on each sort of Source.
 
Constructor Summary
TraxUtils()
           
 
Method Summary
static javax.xml.transform.Source createStaxSource(javax.xml.stream.XMLEventReader eventReader)
          Deprecated. In favor of StaxUtils.createStaxSource(XMLEventReader)
static javax.xml.transform.Source createStaxSource(javax.xml.stream.XMLStreamReader streamReader)
          Deprecated. In favor of StaxUtils.createStaxSource(XMLStreamReader)
static void doWithResult(javax.xml.transform.Result result, TraxUtils.ResultCallback callback)
          Performs the given callback operation on a Result.
static void doWithSource(javax.xml.transform.Source source, TraxUtils.SourceCallback callback)
          Performs the given callback operation on a Source.
static org.w3c.dom.Document getDocument(javax.xml.transform.dom.DOMSource source)
          Returns the Document of the given DOMSource.
static javax.xml.stream.XMLEventReader getXMLEventReader(javax.xml.transform.Source source)
          Deprecated. In favor of StaxUtils.getXMLEventReader(Source)
static javax.xml.stream.XMLEventWriter getXMLEventWriter(javax.xml.transform.Result result)
          Deprecated. In favor of StaxUtils.getXMLEventWriter(Result)
static javax.xml.stream.XMLStreamReader getXMLStreamReader(javax.xml.transform.Source source)
          Deprecated. In favor of StaxUtils.getXMLStreamReader(Source)
static javax.xml.stream.XMLStreamWriter getXMLStreamWriter(javax.xml.transform.Result result)
          Deprecated. In favor of StaxUtils.getXMLStreamWriter(Result)
static boolean isStaxResult(javax.xml.transform.Result result)
          Deprecated. In favor of StaxUtils.isStaxResult(Result)
static boolean isStaxSource(javax.xml.transform.Source source)
          Deprecated. In favor of StaxUtils.isStaxSource(Source)
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

TraxUtils

public TraxUtils()
Method Detail

isStaxSource

@Deprecated
public static boolean isStaxSource(javax.xml.transform.Source source)
Deprecated. In favor of StaxUtils.isStaxSource(Source)

Indicates whether the given Source is a StAX Source.

Returns:
true if source is a Spring-WS StaxSource or JAXP 1.4 StAXSource; false otherwise.

isStaxResult

@Deprecated
public static boolean isStaxResult(javax.xml.transform.Result result)
Deprecated. In favor of StaxUtils.isStaxResult(Result)

Indicates whether the given Result is a StAX Result.

Returns:
true if result is a Spring-WS StaxResult or JAXP 1.4 StAXResult; false otherwise.

getXMLStreamReader

@Deprecated
public static javax.xml.stream.XMLStreamReader getXMLStreamReader(javax.xml.transform.Source source)
Deprecated. In favor of StaxUtils.getXMLStreamReader(Source)

Returns the XMLStreamReader for the given StAX Source.

Parameters:
source - a Spring-WS StaxSource or StAXSource
Returns:
the XMLStreamReader
Throws:
java.lang.IllegalArgumentException - if source is neither a Spring-WS StaxSource or StAXSource

getXMLEventReader

@Deprecated
public static javax.xml.stream.XMLEventReader getXMLEventReader(javax.xml.transform.Source source)
Deprecated. In favor of StaxUtils.getXMLEventReader(Source)

Returns the XMLEventReader for the given StAX Source.

Parameters:
source - a Spring-WS StaxSource or StAXSource
Returns:
the XMLEventReader
Throws:
java.lang.IllegalArgumentException - if source is neither a Spring-WS StaxSource or StAXSource

getXMLStreamWriter

@Deprecated
public static javax.xml.stream.XMLStreamWriter getXMLStreamWriter(javax.xml.transform.Result result)
Deprecated. In favor of StaxUtils.getXMLStreamWriter(Result)

Returns the XMLStreamWriter for the given StAX Result.

Parameters:
result - a Spring-WS StaxResult or StAXResult
Returns:
the XMLStreamReader
Throws:
java.lang.IllegalArgumentException - if source is neither a Spring-WS StaxResult or StAXResult

getXMLEventWriter

@Deprecated
public static javax.xml.stream.XMLEventWriter getXMLEventWriter(javax.xml.transform.Result result)
Deprecated. In favor of StaxUtils.getXMLEventWriter(Result)

Returns the XMLEventWriter for the given StAX Result.

Parameters:
result - a Spring-WS StaxResult or StAXResult
Returns:
the XMLStreamReader
Throws:
java.lang.IllegalArgumentException - if source is neither a Spring-WS StaxResult or StAXResult

createStaxSource

@Deprecated
public static javax.xml.transform.Source createStaxSource(javax.xml.stream.XMLStreamReader streamReader)
Deprecated. In favor of StaxUtils.createStaxSource(XMLStreamReader)

Creates a StAX Source for the given XMLStreamReader. Returns a StAXSource under JAXP 1.4 or higher, or a StaxSource otherwise.

Parameters:
streamReader - the StAX stream reader
Returns:
a source wrapping streamReader

createStaxSource

@Deprecated
public static javax.xml.transform.Source createStaxSource(javax.xml.stream.XMLEventReader eventReader)
                                                   throws javax.xml.stream.XMLStreamException
Deprecated. In favor of StaxUtils.createStaxSource(XMLEventReader)

Creates a StAX Source for the given XMLEventReader. Returns a StAXSource under JAXP 1.4 or higher, or a StaxSource otherwise.

Parameters:
eventReader - the StAX event reader
Returns:
a source wrapping eventReader
Throws:
javax.xml.stream.XMLStreamException - in case of StAX errors

getDocument

public static org.w3c.dom.Document getDocument(javax.xml.transform.dom.DOMSource source)
Returns the Document of the given DOMSource.

Parameters:
source - the DOM source
Returns:
the document

doWithSource

public static void doWithSource(javax.xml.transform.Source source,
                                TraxUtils.SourceCallback callback)
                         throws java.lang.Exception
Performs the given callback operation on a Source. Supports both the JAXP 1.4 StAXSource and the Spring 3.0 StaxSource.

Parameters:
source - source to look at
callback - the callback to invoke for each kind of source
Throws:
java.lang.Exception

doWithResult

public static void doWithResult(javax.xml.transform.Result result,
                                TraxUtils.ResultCallback callback)
                         throws java.lang.Exception
Performs the given callback operation on a Result. Supports both the JAXP 1.4 StAXResult and the Spring 3.0 StaxSource.

Parameters:
result - result to look at
callback - the callback to invoke for each kind of result
Throws:
java.lang.Exception


Copyright © 2011. All Rights Reserved.