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

Class YangTextSchemaSource

java.lang.Object

com.google.common.io.ByteSource

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

All Implemented Interfaces:

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

@Beta
public abstract class YangTextSchemaSource
extends ByteSource
implements YangSchemaSourceRepresentation

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

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	YangTextSchemaSource(SourceIdentifier identifier)

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 YangTextSchemaSource	delegateForByteSource(String fileName, ByteSource delegate)	Create a new YangTextSchemaSource with SourceIdentifier derived from a supplied filename and backed by ByteSource, which provides the actual InputStreams.
static @NonNull YangTextSchemaSource	delegateForByteSource(SourceIdentifier identifier, ByteSource delegate)	Create a new YangTextSchemaSource with a specific source identifier and backed by ByteSource, which provides the actual InputStreams.
static @NonNull YangTextSchemaSource	forFile(File file)	Create a new YangTextSchemaSource backed by a File with SourceIdentifier derived from the file name.
static @NonNull YangTextSchemaSource	forFile(File file, SourceIdentifier identifier)	Create a new YangTextSchemaSource backed by a File and specified SourceIdentifier.
static @NonNull YangTextSchemaSource	forResource(Class<?> clazz, String resourceName)	Create a new YangTextSchemaSource backed by a resource by a resource available on the ClassLoader which loaded the specified class.
static @NonNull YangTextSchemaSource	forResource(String resourceName)	Create a new YangTextSchemaSource backed by a resource available in the ClassLoader where this class resides.
static @NonNull YangTextSchemaSource	forURL(URL url, SourceIdentifier identifier)	Create a new YangTextSchemaSource backed by a URL.
SourceIdentifier	getIdentifier()	Return this objects Identifier.
Class<? extends YangTextSchemaSource>	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

YangTextSchemaSource

protected YangTextSchemaSource(SourceIdentifier identifier)

Method Detail

identifierFromFilename

public static @NonNull SourceIdentifier identifierFromFilename(String name)

delegateForByteSource

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

Create a new YangTextSchemaSource 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 YangTextSchemaSource

delegateForByteSource

public static @NonNull YangTextSchemaSource delegateForByteSource(String fileName,
                                                                  ByteSource delegate)

Create a new YangTextSchemaSource with SourceIdentifier derived from a supplied filename and backed by ByteSource, which provides the actual InputStreams.

Parameters:

fileName - File name

delegate - Backing ByteSource instance

Returns:

A new YangTextSchemaSource

Throws:

IllegalArgumentException - if the file name has invalid format

forFile

public static @NonNull YangTextSchemaSource forFile(File file)

Create a new YangTextSchemaSource backed by a File with SourceIdentifier derived from the file name.

Parameters:

file - Backing File

Returns:

A new YangTextSchemaSource

Throws:

IllegalArgumentException - if the file name has invalid format or if the supplied File is not a file

NullPointerException - if file is null

forFile

public static @NonNull YangTextSchemaSource forFile(File file,
                                                    SourceIdentifier identifier)

Create a new YangTextSchemaSource backed by a File and specified SourceIdentifier.

Parameters:

file - Backing File

identifier - source identifier

Returns:

A new YangTextSchemaSource

Throws:

IllegalArgumentException - if the file name has invalid format or if the supplied File is not a file

NullPointerException - if any argument is null

forResource

public static @NonNull YangTextSchemaSource forResource(String resourceName)

Create a new YangTextSchemaSource backed by a resource available in the ClassLoader where this class resides.

Parameters:

resourceName - Resource name

Returns:

A new instance.

Throws:

IllegalArgumentException - if the resource does not exist or if the name has invalid format

forResource

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

Create a new YangTextSchemaSource backed by a resource by a resource available on the ClassLoader which loaded the specified class.

Parameters:

clazz - Class reference

resourceName - Resource name

Returns:

A new instance.

Throws:

IllegalArgumentException - if the resource does not exist or if the name has invalid format

forURL

public static @NonNull YangTextSchemaSource forURL(URL url,
                                                   SourceIdentifier identifier)

Create a new YangTextSchemaSource backed by a URL.

Parameters:

url - Backing URL

identifier - Source identifier

Returns:

A new instance.

Throws:

NullPointerException - if any argument is null

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 YangTextSchemaSource> getType()

Description copied from interface: SchemaSourceRepresentation

Return the concrete representation type.

Specified by:

getType in interface SchemaSourceRepresentation

Specified by:

getType in interface YangSchemaSourceRepresentation

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.