XML (IBM Streams Java Operator API)

Skip navigation links

Prev Class
Next Class

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

```
public interface XML
```
SPL xml attribute. An SPL xml attribute contains an XML document. XML maintains the document as a representation of its byte stream which is encoded according to the document itself.
The default value for an xml attribute is the empty string which is not a valid XML document. Most methods on this interface will throw IllegalStateException if isDefaultValue() is true.

XML is immutable.

Instances of XML implement java.io.Serializable.

Since:

InfoSphere® Streams Version 3.0

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`java.io.InputStream`	`getInputStream()` Get the byte stream for this document with character encoding specified by the XML declaration
`javax.xml.transform.stream.StreamSource`	`getStreamSource()` Get a `StreamSource` for this document.
`boolean`	`isDefaultValue()` Is this value the default value for an SPL `xml` attribute.

- Method Detail
  - isDefaultValue
```
boolean isDefaultValue()
```
    Is this value the default value for an SPL xml attribute. The default is an empty string.
    
    Returns:
    
    True if the value is the default value, false otherwise.
  - getStreamSource
```
javax.xml.transform.stream.StreamSource getStreamSource()
```
    Get a StreamSource for this document.
    
    Returns:
    
    A StreamSource for this document.
    
    Throws:
    
    java.lang.IllegalStateException - Thrown if isDefaultValue() is true.
  - getInputStream
```
java.io.InputStream getInputStream()
```
    Get the byte stream for this document with character encoding specified by the XML declaration
    
    Returns:
    
    Byte stream for this document.
    
    Throws:
    
    java.lang.IllegalStateException - Thrown if isDefaultValue() is true.