ICharacterEscaper (JiBX Java data binding to XML - Version 1.2.6)

Skip navigation links

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

All Known Implementing Classes:

ISO88591Escaper, USASCIIEscaper, UTF8Escaper
```
public interface ICharacterEscaper
```
Escaper for character data to be written to output document. This allows special character encodings to be handled appropriately on output. It's used by the generic output handler class during document marshalling.

Version:

1.0

Author:

Dennis M. Sosnoski

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`void`	`writeAttribute(java.lang.String text, java.io.Writer writer)`	Write attribute value with character entity substitutions.
`void`	`writeCData(java.lang.String text, java.io.Writer writer)`	Write CDATA to document.
`void`	`writeContent(java.lang.String text, java.io.Writer writer)`	Write content value with character entity substitutions.

- Method Detail
  - writeAttribute
```
void writeAttribute(java.lang.String text,
                    java.io.Writer writer)
             throws java.io.IOException
```
    Write attribute value with character entity substitutions. This assumes that attributes use the regular quote ('"') delimitor.
    
    Parameters:
    
    text - attribute value text
    
    writer - sink for output text
    
    Throws:
    
    java.io.IOException - on error writing to document
  - writeContent
```
void writeContent(java.lang.String text,
                  java.io.Writer writer)
           throws java.io.IOException
```
    Write content value with character entity substitutions.
    
    Parameters:
    
    text - content value text
    
    writer - sink for output text
    
    Throws:
    
    java.io.IOException - on error writing to document
  - writeCData
```
void writeCData(java.lang.String text,
                java.io.Writer writer)
         throws java.io.IOException
```
    Write CDATA to document. This writes the beginning and ending sequences for a CDATA section as well as the actual text, verifying that only characters allowed by the encoding are included in the text.
    
    Parameters:
    
    text - content value text
    
    writer - sink for output text
    
    Throws:
    
    java.io.IOException - on error writing to document

Skip navigation links

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

Project Web Site