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

Class YinTextSchemaSource

java.lang.Object

com.google.common.io.ByteSource

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

All Implemented Interfaces:

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

@Beta
public abstract class YinTextSchemaSource
extends ByteSource
implements YinSchemaSourceRepresentation

YIN text schema source representation. Exposes an RFC6020 or RFC7950 XML representation as an InputStream.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	YinTextSchemaSource(SourceIdentifier identifier)

Method Summary

Modifier and Type	Method	Description
protected abstract MoreObjects.ToStringHelper	addToStringAttributes(@NonNull MoreObjects.ToStringHelper toStringHelper)	Add subclass-specific attributes to the output toString() output.
static @NonNull YinTextSchemaSource	delegateForByteSource(SourceIdentifier identifier, ByteSource delegate)	Create a new YinTextSchemaSource with a specific source identifier and backed by ByteSource, which provides the actual InputStreams.
static @NonNull YinTextSchemaSource	forPath(Path path)
static @NonNull YinTextSchemaSource	forResource(Class<?> clazz, String resourceName)
SourceIdentifier	getIdentifier()	Return this objects Identifier.
Class<? extends YinTextSchemaSource>	getType()	Return the concrete representation type.
static @NonNull SourceIdentifier	identifierFromFilename(String name)
String	toString()

Methods inherited from class com.google.common.io.ByteSource

asCharSource, concat, concat, concat, contentEquals, copyTo, copyTo, empty, hash, isEmpty, openBufferedStream, openStream, read, read, size, sizeIfKnown, slice, wrap

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

getSymbolicName

Constructor Detail

YinTextSchemaSource

protected YinTextSchemaSource(SourceIdentifier identifier)

Method Detail

identifierFromFilename

public static @NonNull SourceIdentifier identifierFromFilename(String name)

getIdentifier

public final SourceIdentifier getIdentifier()

Description copied from interface: Identifiable

Return this objects Identifier.

Specified by:

getIdentifier in interface Identifiable<SourceIdentifier>

Specified by:

getIdentifier in interface SchemaSourceRepresentation

Returns:

Object's identifier, must not be null.

getType

public Class<? extends YinTextSchemaSource> getType()

Description copied from interface: SchemaSourceRepresentation

Return the concrete representation type.

Specified by:

getType in interface SchemaSourceRepresentation

Specified by:

getType in interface YinSchemaSourceRepresentation

Returns:

The type of representation.

toString

public final String toString()

Overrides:

toString in class Object

addToStringAttributes

protected abstract MoreObjects.ToStringHelper addToStringAttributes(@NonNull 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.

delegateForByteSource

public static @NonNull YinTextSchemaSource delegateForByteSource(SourceIdentifier identifier,
                                                                 ByteSource delegate)

Create a new YinTextSchemaSource with a specific source identifier and backed by ByteSource, which provides the actual InputStreams.

Parameters:

identifier - SourceIdentifier of the resulting schema source

delegate - Backing ByteSource instance

Returns:

A new YinTextSchemaSource

forPath

public static @NonNull YinTextSchemaSource forPath(Path path)

forResource

public static @NonNull YinTextSchemaSource forResource(Class<?> clazz,
                                                       String resourceName)