org.opendaylight.yangtools.yang.model.export

Class YinXMLEventReaderFactory

java.lang.Object

org.opendaylight.yangtools.yang.model.export.YinXMLEventReaderFactory

@Beta
 @ThreadSafe
public final class YinXMLEventReaderFactory
extends Object

Factory for creating XMLEventReader instances reporting events equivalent to reading a YIN document defining a specified ModuleEffectiveStatement.

Method Summary

Modifier and Type	Method and Description
XMLEventReader	createXMLEventReader(ModuleEffectiveStatement module) Create a new XMLEventReader iterating of the YIN document equivalent of an effective module.
XMLEventReader	createXMLEventReader(ModuleEffectiveStatement module, SubmoduleEffectiveStatement submodule) Create a new XMLEventReader iterating of the YIN document equivalent of an effective submodule.
static YinXMLEventReaderFactory	defaultInstance() Get the system-wide default instance, backed by system-wide default XMLEventFactory.
static YinXMLEventReaderFactory	ofEventFactory(XMLEventFactory factory)

Methods inherited from class java.lang.Object

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

Method Detail

defaultInstance

public static YinXMLEventReaderFactory defaultInstance()

Get the system-wide default instance, backed by system-wide default XMLEventFactory.

Returns:

Default instance.

ofEventFactory

public static YinXMLEventReaderFactory ofEventFactory(XMLEventFactory factory)

createXMLEventReader

public XMLEventReader createXMLEventReader(ModuleEffectiveStatement module)

Create a new XMLEventReader iterating of the YIN document equivalent of an effective module.

Parameters:

module - Effective module

Returns:

A new XMLEventReader.

Throws:

NullPointerException - if module is null

IllegalArgumentException - if the specified module does not expose declared model

createXMLEventReader

public XMLEventReader createXMLEventReader(ModuleEffectiveStatement module,
                                           SubmoduleEffectiveStatement submodule)

Create a new XMLEventReader iterating of the YIN document equivalent of an effective submodule.

Parameters:

module - Effective module

submodule - Effective submodule

Returns:

A new XMLEventReader.

Throws:

NullPointerException - if any argument is null

IllegalArgumentException - if the specified submodule does not expose declared model