JAXB OSGI 4.0.9 · org.glassfish.jaxb.runtime.v2.runtime.Transducer

Method Summary

Modifier and Type	Method and Description
public void	declareNamespace(ValueT never be null. o, XMLSerializer may be null if `!{@link #useNamespace()}`. w) Declares the namespace URIs used in the given value to `w`.
public QName	Returns: return non-null from this method allows transducers to specify the type it wants to marshal to. Most of the time this method returns null, in which case the implicitly associated type will be used. getTypeName(ValueT instance) Transducers implicitly work against a single XML type, but sometimes (most notably `XMLGregorianCalendar`, an instance may choose different XML types.
public ValueT	parse(CharSequence never be null. lexical) Converts the lexical representation to a value object.
public CharSequence	Returns: always non-null valid lexical representation. print(ValueT never be null. o) Converts the given value to its lexical representation.
public boolean	useNamespace() If true, this doesn't declare any namespace, and therefore `declareNamespace(Object, XMLSerializer)` is no-op.
public void	writeLeafElement(XMLSerializer w, Name tagName, ValueT o, String fieldName) Sends the result of the `print(Object)` operation to one of the `XMLSerializer#leafElement(Name, String, String)` method.
public void	writeText(XMLSerializer w, ValueT o, String fieldName) Sends the result of the `print(Object)` operation to one of the `XMLSerializer#text(String, String)` method, but with the best representation of the value, not necessarily String.

Method Detail

declareNamespace back to summary

declareNamespace	back to summary
public void declareNamespace(ValueT o, XMLSerializer w) throws AccessorException Declares the namespace URIs used in the given value to `w`. Parameters o:ValueT never be null. w:XMLSerializer may be null if `!{@link #useNamespace()}`.

public void declareNamespace(ValueT o, XMLSerializer w) throws AccessorException

Declares the namespace URIs used in the given value to w.

Parameters

o:ValueT: never be null.
w:XMLSerializer: may be null if !{@link #useNamespace()}.

getTypeName back to summary

getTypeName	back to summary
public QName getTypeName(ValueT instance) Transducers implicitly work against a single XML type, but sometimes (most notably `XMLGregorianCalendar`, an instance may choose different XML types. Returns:QName return non-null from this method allows transducers to specify the type it wants to marshal to. Most of the time this method returns null, in which case the implicitly associated type will be used.

public QName getTypeName(ValueT instance)

Transducers implicitly work against a single XML type, but sometimes (most notably XMLGregorianCalendar, an instance may choose different XML types.

Returns:QName: return non-null from this method allows transducers to specify the type it wants to marshal to. Most of the time this method returns null, in which case the implicitly associated type will be used.

parse back to summary

parse	back to summary
public ValueT parse(CharSequence lexical) throws AccessorException, SAXException Converts the lexical representation to a value object. Parameters lexical:CharSequence never be null. Exceptions AccessorException: if the transducer is used to parse an user bean that uses `XmlValue`, then this exception may occur when it tries to set the leaf value to the bean. SAXException: if the lexical form is incorrect, the error should be reported and SAXException may thrown (or it can return null to recover.)

public ValueT parse(CharSequence lexical) throws AccessorException, SAXException

Converts the lexical representation to a value object.

Parameters

lexical:CharSequence: never be null.

Exceptions

AccessorException:: if the transducer is used to parse an user bean that uses XmlValue, then this exception may occur when it tries to set the leaf value to the bean.
SAXException:: if the lexical form is incorrect, the error should be reported and SAXException may thrown (or it can return null to recover.)

print	back to summary
public CharSequence print(ValueT o) throws AccessorException Converts the given value to its lexical representation. Parameters o:ValueT never be null. Returns:CharSequence always non-null valid lexical representation. Annotations @NotNull

back to summary

public CharSequence print(ValueT o) throws AccessorException

Converts the given value to its lexical representation.

Parameters

o:ValueT: never be null.

Returns:CharSequence

always non-null valid lexical representation.

Annotations

@NotNull

useNamespace	back to summary
public boolean useNamespace() If true, this doesn't declare any namespace, and therefore `declareNamespace(Object, XMLSerializer)` is no-op. It also means that the `parse(CharSequence)` method won't use the context parameter.

writeLeafElement	back to summary
public void writeLeafElement(XMLSerializer w, Name tagName, ValueT o, String fieldName) throws IOException, SAXException, XMLStreamException, AccessorException Sends the result of the `print(Object)` operation to one of the `XMLSerializer#leafElement(Name, String, String)` method. but with the best representation of the value, not necessarily String.

writeText	back to summary
public void writeText(XMLSerializer w, ValueT o, String fieldName) throws IOException, SAXException, XMLStreamException, AccessorException Sends the result of the `print(Object)` operation to one of the `XMLSerializer#text(String, String)` method, but with the best representation of the value, not necessarily String.

public Interface Transducer<ValueT>

Method Summary

Method Detail