Package org.opendaylight.yangtools.yang.model.spi.source

Class YinDomSource

java.lang.Object

org.opendaylight.yangtools.yang.model.spi.source.YinDomSource

All Implemented Interfaces:

Immutable, SourceRepresentation, YinSourceRepresentation, YinXmlSource

public abstract sealed class YinDomSource
extends Object
implements YinXmlSource

Utility YinXmlSource exposing a W3C DOMSource representation of YIN model.

Constructor Summary

Constructors

Constructor	Description
YinDomSource()

Method Summary

Modifier and Type	Method	Description
protected abstract MoreObjects.ToStringHelper	addToStringAttributes(MoreObjects.ToStringHelper toStringHelper)	Add subclass-specific attributes to the output toString() output.
static @NonNull YinDomSource	create(@NonNull SourceIdentifier identifier, @NonNull DOMSource source, @Nullable String symbolicName)	Create a new YinDomSource using an identifier and a source.
abstract DOMSource	getSource()	Return an XML Source of the YIN document.
final Class<YinDomSource>	getType()	Return the concrete representation type.
static @NonNull YinDomSource	lazyTransform(YinXmlSource xmlSchemaSource)	Create a YinDomSource from a YinXmlSource.
final String	toString()
static @NonNull YinDomSource	transform(YinXmlSource xmlSchemaSource)	Create a YinDomSource from a YinXmlSource.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opendaylight.yangtools.yang.model.api.source.SourceRepresentation

sourceId, symbolicName

Constructor Details

YinDomSource

public YinDomSource()

Method Details

create

public static @NonNull YinDomSource create(@NonNull SourceIdentifier identifier,
 @NonNull DOMSource source,
 @Nullable String symbolicName)

Create a new YinDomSource using an identifier and a source.

Parameters:

identifier - Schema source identifier

source - W3C DOM source

symbolicName - Source symbolic name

Returns:

A new YinDomSource instance.

lazyTransform

public static @NonNull YinDomSource lazyTransform(YinXmlSource xmlSchemaSource)

Create a YinDomSource from a YinXmlSource. If the argument is already a YinDomSchemaSource, this method returns the same instance. The source will be translated on first access, at which point an IllegalStateException may be raised.

Parameters:

xmlSchemaSource - Backing schema source

Returns:

A YinDomSource instance

transform

public static @NonNull YinDomSource transform(YinXmlSource xmlSchemaSource)
                                       throws TransformerException

Create a YinDomSource from a YinXmlSource. If the argument is already a YinDomSchemaSource, this method returns the same instance. The source will be translated immediately.

Parameters:

xmlSchemaSource - Backing schema source

Returns:

A YinDomSource instance

Throws:

TransformerException - when the provided source fails to transform

getType

public final Class<YinDomSource> getType()

Description copied from interface: SourceRepresentation

Return the concrete representation type.

Specified by:

getType in interface SourceRepresentation

Specified by:

getType in interface YinSourceRepresentation

Specified by:

getType in interface YinXmlSource

Returns:

The type of representation.

getSource

public abstract DOMSource getSource()

Description copied from interface: YinXmlSource

Return an XML Source of the YIN document.

Specified by:

getSource in interface YinXmlSource

Returns:

An XML Source instance.

toString

public final String toString()

Overrides:

toString in class Object

addToStringAttributes

protected abstract MoreObjects.ToStringHelper addToStringAttributes(MoreObjects.ToStringHelper toStringHelper)

Add subclass-specific attributes to the output toString() output. Since subclasses are prevented from overriding toString() for consistency reasons, they can add their specific attributes to the resulting string by attaching attributes to the supplied MoreObjects.ToStringHelper.

Parameters:

toStringHelper - ToStringHelper onto the attributes can be added

Returns:

ToStringHelper supplied as input argument.