public interface LowLevelFastInfosetStreamWriter
This interface provides additional stream-based serialization methods for the case where an application is in specific control of the serialization process and has the knowledge to call the LowLevel methods in the required order.
For example, the application may be able to perform efficient information to indexing mapping and to provide certain information in UTF-8 encoded form.
These methods may be used in conjuction with XMLStreamWriter
as long as an element fragment written using the efficient streaming methods
are self-contained and no sub-fragment is written using methods from
XMLStreamWriter.
The required call sequence is as follows:
CALLSEQUENCE :=startDocumentinitiateLowLevelWriting ELEMENTendDocument| initiateLowLevelWriting ELEMENT // for fragment ELEMENT := writeLowLevelTerminationAndMark NAMESPACES? ELEMENT_NAME ATTRIBUTES? writeLowLevelEndStartElement CONTENTS writeLowLevelEndElement NAMESPACES := writeLowLevelStartNamespaces writeLowLevelNamespace* writeLowLevelEndNamespaces ELEMENT_NAME := writeLowLevelStartElementIndexed | writeLowLevelStartNameLiteral | writeLowLevelStartElement ATTRUBUTES := writeLowLevelStartAttributes (ATTRIBUTE_NAME writeLowLevelAttributeValue)* ATTRIBUTE_NAME := writeLowLevelAttributeIndexed | writeLowLevelStartNameLiteral | writeLowLevelAttribute CONTENTS := (ELEMENT | writeLowLevelText writeLowLevelOctets)*
Some methods defer to the application for the mapping of information to indexes.
| Modifier and Type | Method and Description |
|---|---|
int |
getLocalNameIndex()
Get the current index that was applied to an [local name] of an
Element or Attribute Information Item.
|
int |
getNextAttributeIndex()
Get the next index to apply to an Attribute Information Item.
|
int |
getNextElementIndex()
Get the next index to apply to an Element Information Item.
|
int |
getNextLocalNameIndex()
Get the next index to apply to an [local name] of an Element or Attribute
Information Item.
|
void |
initiateLowLevelWriting()
Initiate low level writing of an element fragment.
|
boolean |
writeLowLevelAttribute(String prefix,
String namespaceURI,
String localName)
Write an attribute.
|
void |
writeLowLevelAttributeIndexed(int index) |
void |
writeLowLevelAttributeValue(String value) |
void |
writeLowLevelEndElement() |
void |
writeLowLevelEndNamespaces() |
void |
writeLowLevelEndStartElement() |
void |
writeLowLevelNamespace(String prefix,
String namespaceName) |
void |
writeLowLevelOctets(byte[] octets,
int length) |
void |
writeLowLevelStartAttributes() |
boolean |
writeLowLevelStartElement(int type,
String prefix,
String localName,
String namespaceURI)
Write the start of an element.
|
void |
writeLowLevelStartElementIndexed(int type,
int index) |
void |
writeLowLevelStartNameLiteral(int type,
String prefix,
byte[] utf8LocalName,
String namespaceURI) |
void |
writeLowLevelStartNameLiteral(int type,
String prefix,
int localNameIndex,
String namespaceURI) |
void |
writeLowLevelStartNamespaces() |
void |
writeLowLevelTerminationAndMark() |
void |
writeLowLevelText(char[] text,
int length) |
void |
writeLowLevelText(String text) |
void initiateLowLevelWriting()
throws javax.xml.stream.XMLStreamException
This method must be invoked before other low level method.
int getNextElementIndex()
This will increment the next obtained index such that:
i = w.getNextElementIndex(); j = w.getNextElementIndex(); i == j + 1;
int getNextAttributeIndex()
i = w.getNextAttributeIndex(); j = w.getNextAttributeIndex(); i == j + 1;
int getLocalNameIndex()
int getNextLocalNameIndex()
i = w.getNextLocalNameIndex(); j = w.getNextLocalNameIndex(); i == j + 1;
void writeLowLevelTerminationAndMark()
throws IOException
IOExceptionvoid writeLowLevelStartElementIndexed(int type,
int index)
throws IOException
IOExceptionboolean writeLowLevelStartElement(int type,
String prefix,
String localName,
String namespaceURI)
throws IOException
IOExceptionvoid writeLowLevelStartNamespaces()
throws IOException
IOExceptionvoid writeLowLevelNamespace(String prefix, String namespaceName) throws IOException
IOExceptionvoid writeLowLevelEndNamespaces()
throws IOException
IOExceptionvoid writeLowLevelStartAttributes()
throws IOException
IOExceptionvoid writeLowLevelAttributeIndexed(int index)
throws IOException
IOExceptionboolean writeLowLevelAttribute(String prefix, String namespaceURI, String localName) throws IOException
IOExceptionvoid writeLowLevelAttributeValue(String value) throws IOException
IOExceptionvoid writeLowLevelStartNameLiteral(int type,
String prefix,
byte[] utf8LocalName,
String namespaceURI)
throws IOException
IOExceptionvoid writeLowLevelStartNameLiteral(int type,
String prefix,
int localNameIndex,
String namespaceURI)
throws IOException
IOExceptionvoid writeLowLevelEndStartElement()
throws IOException
IOExceptionvoid writeLowLevelEndElement()
throws IOException
IOExceptionvoid writeLowLevelText(char[] text,
int length)
throws IOException
IOExceptionvoid writeLowLevelText(String text) throws IOException
IOExceptionvoid writeLowLevelOctets(byte[] octets,
int length)
throws IOException
IOExceptionCopyright © 2012 Oracle Corpration. All Rights Reserved.