Module org.opendaylight.yangtools.yang.model.spi

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

Class FileYangTextSource

java.lang.Object

com.google.common.io.CharSource

org.opendaylight.yangtools.yang.model.api.source.YangTextSource

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

All Implemented Interfaces:

Delegator<Path>, Immutable, SourceRepresentation, YangSourceRepresentation

@NonNullByDefault
public class FileYangTextSource
extends YangTextSource

A YangTextSource backed by a file.

Constructor Summary

Constructors

Constructor	Description
FileYangTextSource(Path path)	Utility constructor.
FileYangTextSource(SourceIdentifier sourceId, Path path, Charset charset)	Default constructor.

Method Summary

Modifier and Type	Method	Description
protected com.google.common.base.MoreObjects.ToStringHelper	addToStringAttributes(com.google.common.base.MoreObjects.ToStringHelper toStringHelper)
final Path	getDelegate()
final Reader	openStream()
final SourceIdentifier	sourceId()
final @NonNull String	symbolicName()

Methods inherited from class org.opendaylight.yangtools.yang.model.api.source.YangTextSource

getType, toString

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

asByteSource, concat, concat, concat, copyTo, copyTo, empty, forEachLine, isEmpty, length, lengthIfKnown, lines, openBufferedStream, read, readFirstLine, readLines, readLines, wrap

Methods inherited from class java.lang.Object

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

Constructor Details

FileYangTextSource

public FileYangTextSource(SourceIdentifier sourceId,
 Path path,
 Charset charset)

Default constructor.

Parameters:

path - Backing path

sourceId - source identifier

charset - expected stream character set

Throws:

NullPointerException - if any argument is null

IllegalArgumentException - if the supplied path is not a regular file

FileYangTextSource

public FileYangTextSource(Path path)

Utility constructor. Derives the SourceIdentifier from Path and assumes UTF-8 encoding.

Parameters:

path - backing path

Throws:

NullPointerException - if path is null

Method Details

openStream

public final Reader openStream()
                        throws IOException

Specified by:

openStream in class com.google.common.io.CharSource

Throws:

IOException

symbolicName

public final @NonNull String symbolicName()

addToStringAttributes

protected com.google.common.base.MoreObjects.ToStringHelper addToStringAttributes(com.google.common.base.MoreObjects.ToStringHelper toStringHelper)

Overrides:

addToStringAttributes in class YangTextSource

sourceId

public final SourceIdentifier sourceId()

Specified by:

sourceId in interface SourceRepresentation

getDelegate

public final Path getDelegate()

Specified by:

getDelegate in interface Delegator<T>