Package org.opendaylight.yangtools.binding.lib

Class ResourceYangModuleInfo

java.lang.Object

org.opendaylight.yangtools.binding.lib.ResourceYangModuleInfo

All Implemented Interfaces:

YangModuleInfo, Immutable

@Beta
@NonNullByDefault
public abstract class ResourceYangModuleInfo
extends Object
implements YangModuleInfo

Base utility class for providing YANG module info backed by class resources.

Author:

Robert Varga

Constructor Summary

Constructors

Constructor	Description
ResourceYangModuleInfo()

Method Summary

Modifier and Type	Method	Description
protected MoreObjects.ToStringHelper	addToStringHelperAttributes(MoreObjects.ToStringHelper helper)
final InputStream	openYangTextStream()	Return an open stream containing YANG text for this module.
protected abstract String	resourceName()
final String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opendaylight.yangtools.binding.meta.YangModuleInfo

getImportedModules, getName, getYangTextByteSource, getYangTextCharSource

Constructor Details

ResourceYangModuleInfo

public ResourceYangModuleInfo()

Method Details

openYangTextStream

public final InputStream openYangTextStream()
                                     throws IOException

Description copied from interface: YangModuleInfo

Return an open stream containing YANG text for this module. The stream is required to be UTF-8 encoded.

Specified by:

openYangTextStream in interface YangModuleInfo

Returns:

An open stream.

Throws:

IOException - If the stream cannot be opened.

toString

public final String toString()

Description copied from interface: Immutable

Any two invocations of this method are guaranteed to return a non-null String.equals(Object) value.

Specified by:

toString in interface Immutable

Overrides:

toString in class Object

addToStringHelperAttributes

protected MoreObjects.ToStringHelper addToStringHelperAttributes(MoreObjects.ToStringHelper helper)

resourceName

protected abstract String resourceName()