public class RsBuilder extends Object
RsRoot
class hierarchies. The concrete RsRoot is either a
Urlset
or a Sitemapindex
.Constructor and Description |
---|
RsBuilder(ResourceSyncContext rsContext)
Constructor.
|
Modifier and Type | Method and Description |
---|---|
Optional<RsRoot> |
build()
Build a class hierarchy from the input previously given with one of
set -methods. |
Optional<QName> |
getQName()
Get an optional of the QName of the latest unmarshalled document.
|
Optional<Sitemapindex> |
getSitemapindex()
Get an optional Sitemapindex of the latest unmarshalled document.
|
Optional<Urlset> |
getUrlset()
Get an optional Urlset of the latest unmarshalled document.
|
RsBuilder |
setFile(File file) |
RsBuilder |
setInputSource(InputSource inputSource) |
RsBuilder |
setInputStream(InputStream inputStream) |
RsBuilder |
setNode(Node node) |
RsBuilder |
setReader(Reader reader) |
RsBuilder |
setSource(Source source) |
RsBuilder |
setUrl(URL url) |
RsBuilder |
setXmlEventReader(XMLEventReader xmlEventReader) |
RsBuilder |
setXmlStreamReader(XMLStreamReader xmlStreamReader) |
String |
toXml(RsRoot rsRoot,
boolean formattedOutput)
Marshal a class hierarchy to its xml-representation.
|
public RsBuilder(ResourceSyncContext rsContext)
rsContext
- ResourceSyncContext can be reused over multiple instances of RsBuilder.public Optional<RsRoot> build() throws JAXBException
set
-methods.
Example usage:
RsBuilder rsBuilder = new RsBuilder(new ResourceSyncContext()); Optional<RsRoot> maybeRoot = rsBuilder.setInputStream(inStream).build();
We can test what concrete class was unmarshalled by obtaining the QName:
Optional<QName> maybeQName = rsBuilder.getQName();
Or directly test one of two possibilities:
Optional<Sitemapindex> maybeSitemapindex = rsBuilder.getSitemapindex(); Optional<Urlset> maybeUrlset = rsBuilder.getUrlset();
JAXBException
- for invalid inputpublic Optional<QName> getQName()
null
,
Sitemapindex.QNAME
or Urlset.QNAME
.public Optional<Urlset> getUrlset()
null
, or Urlset
.public Optional<Sitemapindex> getSitemapindex()
null
,
or Sitemapindex
.public RsBuilder setInputSource(InputSource inputSource)
public RsBuilder setInputStream(InputStream inputStream)
public RsBuilder setXmlEventReader(XMLEventReader xmlEventReader)
public RsBuilder setXmlStreamReader(XMLStreamReader xmlStreamReader)
public String toXml(RsRoot rsRoot, boolean formattedOutput) throws JAXBException
rsRoot
- the root class of the class hierarchy to marshalformattedOutput
- format the output as pretty xmlJAXBException
- for invalid inputCopyright © 2017. All rights reserved.