Top Description Methods
org.eclipse.persistence.internal.oxm

public Interface CharacterEscapeHandler

Known Direct Subinterfaces
org.eclipse.persistence.oxm.CharacterEscapeHandler
Known Direct Implementers
org.eclipse.persistence.internal.oxm.record.CharacterEscapeHandlerWrapper
Imports
java.io.IOException, .Writer

Provide an interface to allow for custom character escaping behaviour.

Method Summary

Modifier and TypeMethod and Description
public void
escape(char[]
Array of characters to be escaped
buffer
,
int
The starting position
start
,
int
The number of characters being escaped
length
,
boolean
A value of 'true' indicates this is an attribute value
isAttributeValue
,
Writer
The resulting escaped characters will be written to this Writer
out
)

Perform character escaping and write the result to the output.

Method Detail

escapeback to summary
public void escape(char[] buffer, int start, int length, boolean isAttributeValue, Writer out) throws IOException

Perform character escaping and write the result to the output.

Note: This feature is not supported when marshalling to the following targets:

  • javax.xml.stream.XMLStreamWriter
  • javax.xml.stream.XMLEventWriter
  • org.xml.sax.ContentHandler
  • org.w3c.dom.Node
Parameters
buffer:char[]

Array of characters to be escaped

start:int

The starting position

length:int

The number of characters being escaped

isAttributeValue:boolean

A value of 'true' indicates this is an attribute value

out:Writer

The resulting escaped characters will be written to this Writer

Exceptions
IOException:
In an error condition, IOException can be thrown to stop the marshalling process