Package org.opendaylight.yangtools.yang.model.repo.api

Class YinDomSchemaSource

java.lang.Object

org.opendaylight.yangtools.yang.model.repo.api.YinDomSchemaSource

All Implemented Interfaces:

Identifiable<SourceIdentifier>, Immutable, SchemaSourceRepresentation, YinSchemaSourceRepresentation, YinXmlSchemaSource

public abstract class YinDomSchemaSource
extends Object
implements YinXmlSchemaSource

Utility YinXmlSchemaSource exposing a W3C DOMSource representation of YIN model.

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 YinDomSchemaSource	create(@NonNull SourceIdentifier identifier, @NonNull DOMSource source, @Nullable String symbolicName)	Create a new YinDomSchemaSource using an identifier and a source.
abstract DOMSource	getSource()	Return an XML Source of the YIN document.
final Class<YinDomSchemaSource>	getType()	Return the concrete representation type.
static @NonNull YinDomSchemaSource	lazyTransform(YinXmlSchemaSource xmlSchemaSource)	Create a YinDomSchemaSource from a YinXmlSchemaSource.
final String	toString()
static @NonNull YinDomSchemaSource	transform(YinXmlSchemaSource xmlSchemaSource)	Create a YinDomSchemaSource from a YinXmlSchemaSource.

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.repo.api.SchemaSourceRepresentation

getIdentifier, getSymbolicName

Method Details

create

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

Create a new YinDomSchemaSource using an identifier and a source.

Parameters:

identifier - Schema source identifier

source - W3C DOM source

symbolicName - Source symbolic name

Returns:

A new YinDomSchemaSource instance.

lazyTransform

public static @NonNull YinDomSchemaSource lazyTransform(YinXmlSchemaSource xmlSchemaSource)

Create a YinDomSchemaSource from a YinXmlSchemaSource. 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 YinDomSchemaSource instance

transform

public static @NonNull YinDomSchemaSource transform(YinXmlSchemaSource xmlSchemaSource)
                                             throws TransformerException

Create a YinDomSchemaSource from a YinXmlSchemaSource. 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 YinDomSchemaSource instance

Throws:

TransformerException - when the provided source fails to transform

getSource

public abstract DOMSource getSource()

Description copied from interface: YinXmlSchemaSource

Return an XML Source of the YIN document.

Specified by:

getSource in interface YinXmlSchemaSource

Returns:

An XML Source instance.

getType

public final Class<YinDomSchemaSource> getType()

Description copied from interface: SchemaSourceRepresentation

Return the concrete representation type.

Specified by:

getType in interface SchemaSourceRepresentation

Specified by:

getType in interface YinSchemaSourceRepresentation

Specified by:

getType in interface YinXmlSchemaSource

Returns:

The type of representation.

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.