org.meeuw.jaxbdocumentation

Class DocumentationAdder

java.lang.Object

org.meeuw.jaxbdocumentation.DocumentationAdder

All Implemented Interfaces:

Supplier<Transformer>

public class DocumentationAdder
extends Object
implements Supplier<Transformer>

Supplies a Transformer that addes xs:documentation tags to an existing XSD. The contents of the documentation tags is determined by introspecting while looking for @XmlDocumentation tags.

Since:

0.1

Author:

Michiel Meeuwissen

Constructor Summary

Constructors

Constructor and Description
DocumentationAdder(Class<?>... classes)

Method Summary

Modifier and Type	Method and Description
protected Map<String,String>	createDocumentations(Class<?>... classes)
Transformer	get()
boolean	isUseCache()
Map<String,Source>	schemaSources() Returns the associated XSD schema's as a map of Source's.
void	setUseCache(boolean useCache)
void	transform(Source source, Result out)
Map<String,Source>	transformedSources()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DocumentationAdder

public DocumentationAdder(Class<?>... classes)

Method Detail

isUseCache

public boolean isUseCache()

setUseCache

public void setUseCache(boolean useCache)

transform

public void transform(Source source,
                      Result out)
               throws TransformerException

Throws:

TransformerException

schemaSources

public Map<String,Source> schemaSources()
                                 throws JAXBException,
                                        IOException,
                                        SAXException

Returns the associated XSD schema's as a map of Source's. The key is the namespace.

Throws:

JAXBException

IOException

SAXException

transformedSources

public Map<String,Source> transformedSources()
                                      throws JAXBException,
                                             IOException,
                                             SAXException,
                                             TransformerException

Throws:

JAXBException

IOException

SAXException

TransformerException

get

public Transformer get()

Specified by:

get in interface Supplier<Transformer>

createDocumentations

protected Map<String,String> createDocumentations(Class<?>... classes)
                                           throws IOException,
                                                  ParserConfigurationException,
                                                  SAXException

Throws:

IOException

ParserConfigurationException

SAXException