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

Class FileYinTextSource

java.lang.Object

com.google.common.io.ByteSource

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

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

All Implemented Interfaces:

Delegator<Path>, Immutable, SourceRepresentation, YinSourceRepresentation

@NonNullByDefault
public class FileYinTextSource
extends YinTextSource

A AbstractYinTextSource backed by a file.

Constructor Summary

Constructors

Constructor	Description
FileYinTextSource(Path path)
FileYinTextSource(SourceIdentifier sourceId, Path path)

Method Summary

Modifier and Type	Method	Description
protected MoreObjects.ToStringHelper	addToStringAttributes(MoreObjects.ToStringHelper toStringHelper)	Add subclass-specific attributes to the output YinTextSource.toString() output.
final Path	getDelegate()	Return underlying delegate.
final InputStream	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.YinTextSource

getType, toString

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

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

Methods inherited from class java.lang.Object

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

Constructor Details

FileYinTextSource

public FileYinTextSource(SourceIdentifier sourceId,
 Path path)

FileYinTextSource

public FileYinTextSource(Path path)

Method Details

openStream

public final InputStream openStream()
                             throws IOException

Specified by:

openStream in class ByteSource

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: YinTextSource

Add subclass-specific attributes to the output YinTextSource.toString() output. Since subclasses are prevented from overriding YinTextSource.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 YinTextSource

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.