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 MoreObjects.ToStringHelper	addToStringAttributes(MoreObjects.ToStringHelper toStringHelper)	Add subclass-specific attributes to the output YangTextSource.toString() output.
final Path	getDelegate()	Return underlying delegate.
final Reader	openStream()
final SourceIdentifier	sourceId()	The SourceIdentifier of this source.
final @NonNull String	symbolicName()	Return the symbolic name, if available.

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 CharSource

Throws:

IOException

symbolicName

public final @NonNull String symbolicName()

Description copied from interface: SourceRepresentation

Return the symbolic name, if available. This name has no semantic meaning beyond being useful for debugging by humans.

Returns:

Symbolic name, if available

addToStringAttributes

protected MoreObjects.ToStringHelper addToStringAttributes(MoreObjects.ToStringHelper toStringHelper)

Description copied from class: YangTextSource

Add subclass-specific attributes to the output YangTextSource.toString() output. Since subclasses are prevented from overriding YangTextSource.toString() for consistency reasons, they can add their specific attributes to the resulting string by attaching attributes to the supplied MoreObjects.ToStringHelper.

Overrides:

addToStringAttributes in class YangTextSource

Parameters:

toStringHelper - ToStringHelper onto the attributes can be added

Returns:

ToStringHelper supplied as input argument.

sourceId

public final SourceIdentifier sourceId()

Description copied from interface: SourceRepresentation

The SourceIdentifier of this source.

Specified by:

sourceId in interface SourceRepresentation

Returns:

SourceIdentifier of this source

getDelegate

public final Path getDelegate()

Description copied from interface: Delegator

Return underlying delegate.

Specified by:

getDelegate in interface Delegator<T>

Returns:

underlying delegate.