Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS (src)    NEXT CLASS (src) FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

org.jboss.xml.binding
Interface Marshaller

All Known Implementing Classes:
AbstractMarshaller (src)
public interface Marshaller

An interface for marshaller implementations, e.g. DTD and XML schema marshallers.

Nested Class Summary
static class Marshaller.FACTORY (src)
           
 
Field Summary
static java.lang.String ENCODING
           
static java.lang.String PROP_MARSHALLER
          The value should be a fully qualified class name of the Marshaller implementation.
static java.lang.String PROP_OUTPUT_INDENTATION
          Allowed values are true and false.
static java.lang.String PROP_OUTPUT_XML_VERSION
          Allowed values are true and false.
static java.lang.String VERSION
           
 
Method Summary
 void addRootElement(java.lang.String namespaceUri, java.lang.String prefix, java.lang.String name)
           
 java.lang.String getProperty(java.lang.String name)
           
 void mapClassToNamespace(java.lang.Class cls, java.lang.String root, java.lang.String namespaceUri, java.io.Reader schemaReader, ObjectModelProvider (src)  provider)
           
 void mapClassToNamespace(java.lang.Class cls, java.lang.String root, java.lang.String namespaceUri, java.lang.String schemaUrl, ObjectModelProvider (src)  provider)
           
 void mapPublicIdToSystemId(java.lang.String publicId, java.lang.String systemId)
           
 void marshal(java.io.Reader schema, ObjectModelProvider (src)  provider, java.lang.Object document, java.io.Writer writer)
           
 void marshal(java.lang.String schemaUri, ObjectModelProvider (src)  provider, java.lang.Object root, java.io.Writer writer)
           
 void setEncoding(java.lang.String encoding)
           
 void setProperty(java.lang.String name, java.lang.String value)
           
 void setVersion(java.lang.String version)
           
 

Field Detail

PROP_OUTPUT_XML_VERSION

public static final java.lang.String PROP_OUTPUT_XML_VERSION
Allowed values are true and false. If not set, true is assumed. If true, xml version and encoding will be included into the marshalled XML content.

See Also:
Constant Field Values (src)

PROP_MARSHALLER

public static final java.lang.String PROP_MARSHALLER
The value should be a fully qualified class name of the Marshaller implementation. Used by the FACTORY.getInstance().

See Also:
Constant Field Values (src)

PROP_OUTPUT_INDENTATION

public static final java.lang.String PROP_OUTPUT_INDENTATION
Allowed values are true and false. If not set, true is assumed. If true, XML content will be written with indentations, otherwise in one string.

See Also:
Constant Field Values (src)

VERSION

public static final java.lang.String VERSION
See Also:
Constant Field Values (src)

ENCODING

public static final java.lang.String ENCODING
See Also:
Constant Field Values (src)
Method Detail

setVersion

public void setVersion(java.lang.String version)

setEncoding

public void setEncoding(java.lang.String encoding)

mapPublicIdToSystemId

public void mapPublicIdToSystemId(java.lang.String publicId,
                                  java.lang.String systemId)

mapClassToNamespace

public void mapClassToNamespace(java.lang.Class cls,
                                java.lang.String root,
                                java.lang.String namespaceUri,
                                java.io.Reader schemaReader,
                                ObjectModelProvider (src)  provider)

mapClassToNamespace

public void mapClassToNamespace(java.lang.Class cls,
                                java.lang.String root,
                                java.lang.String namespaceUri,
                                java.lang.String schemaUrl,
                                ObjectModelProvider (src)  provider)

addRootElement

public void addRootElement(java.lang.String namespaceUri,
                           java.lang.String prefix,
                           java.lang.String name)

marshal

public void marshal(java.lang.String schemaUri,
                    ObjectModelProvider (src)  provider,
                    java.lang.Object root,
                    java.io.Writer writer)
             throws java.io.IOException,
                    javax.xml.parsers.ParserConfigurationException,
                    org.xml.sax.SAXException
Throws:
java.io.IOException
javax.xml.parsers.ParserConfigurationException
org.xml.sax.SAXException

marshal

public void marshal(java.io.Reader schema,
                    ObjectModelProvider (src)  provider,
                    java.lang.Object document,
                    java.io.Writer writer)
             throws java.io.IOException,
                    org.xml.sax.SAXException,
                    javax.xml.parsers.ParserConfigurationException
Throws:
java.io.IOException
org.xml.sax.SAXException
javax.xml.parsers.ParserConfigurationException

setProperty

public void setProperty(java.lang.String name,
                        java.lang.String value)

getProperty

public java.lang.String getProperty(java.lang.String name)
Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS (src)    NEXT CLASS (src) FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD