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

Class URLYangTextSource

java.lang.Object

com.google.common.io.CharSource

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

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

All Implemented Interfaces:

Delegator<URL>, Immutable, SourceRepresentation, YangSourceRepresentation

@NonNullByDefault
public class URLYangTextSource
extends YangTextSource

A YangTextSource backed by a URL.

Constructor Summary

Constructors

Constructor	Description
URLYangTextSource(URL url)	Utility constructor.
URLYangTextSource(SourceIdentifier sourceId, URL url, Charset charset)

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 URL	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

URLYangTextSource

public URLYangTextSource(SourceIdentifier sourceId,
 URL url,
 Charset charset)

URLYangTextSource

public URLYangTextSource(URL url)

Utility constructor. The SourceIdentifier is derived from URL.getPath() and the character set is assumed to be UTF-8.

Parameters:

url - backing URL

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 URL getDelegate()

Description copied from interface: Delegator

Return underlying delegate.

Specified by:

getDelegate in interface Delegator<T>

Returns:

underlying delegate.