org.opendaylight.yangtools.yang.parser.rfc6020.repo

Class YangStatementStreamSource

java.lang.Object

org.opendaylight.yangtools.yang.parser.rfc6020.repo.YangStatementStreamSource

All Implemented Interfaces:

Identifiable<SourceIdentifier>, StatementStreamSource

@Beta
public final class YangStatementStreamSource
extends Object
implements Identifiable<SourceIdentifier>, StatementStreamSource

This class represents implementation of StatementStreamSource in order to emit YANG statements using supplied StatementWriter.

Author:

Robert Varga

Method Summary

Modifier and Type	Method and Description
static YangStatementStreamSource	create(YangTextSchemaSource source)
SourceIdentifier	getIdentifier() Return this objects Identifier
org.antlr.v4.runtime.ParserRuleContext	getYangAST()
static YangStatementParser.StatementContext	parseYangSource(InputStream stream) Deprecated. Provided for migration purposes only. Do not use.
void	writeFull(StatementWriter writer, QNameToStatementDefinition stmtDef, PrefixToModule prefixes) Emits every statements present in this statement source to supplied writer.
void	writeFull(StatementWriter writer, QNameToStatementDefinition stmtDef, PrefixToModule prefixes, YangVersion yangVersion) Emits every statements present in this statement source to supplied writer based on specified yang version.
void	writeLinkage(StatementWriter writer, QNameToStatementDefinition stmtDef, PrefixToModule preLinkagePrefixes) Emits only linkage-related statements to supplied writer.
void	writeLinkage(StatementWriter writer, QNameToStatementDefinition stmtDef, PrefixToModule preLinkagePrefixes, YangVersion yangVersion) Emits only linkage-related statements to supplied writer based on specified yang version.
void	writeLinkageAndStatementDefinitions(StatementWriter writer, QNameToStatementDefinition stmtDef, PrefixToModule prefixes) Emits only linkage and language extension statements to supplied writer.
void	writeLinkageAndStatementDefinitions(StatementWriter writer, QNameToStatementDefinition stmtDef, PrefixToModule prefixes, YangVersion yangVersion) Emits only linkage and language extension statements to supplied writer based on specified yang version.
void	writePreLinkage(StatementWriter writer, QNameToStatementDefinition stmtDef) Emits only pre-linkage-related statements to supplied writer.

Methods inherited from class java.lang.Object

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

Method Detail

create

public static YangStatementStreamSource create(YangTextSchemaSource source)
                                        throws IOException,
                                               YangSyntaxErrorException

Throws:

IOException

YangSyntaxErrorException

writePreLinkage

public void writePreLinkage(StatementWriter writer,
                            QNameToStatementDefinition stmtDef)

Description copied from interface: StatementStreamSource

Emits only pre-linkage-related statements to supplied writer.

Specified by:

writePreLinkage in interface StatementStreamSource

Parameters:

writer - StatementWriter which should be used to emit statements.

stmtDef - Map of available statement definitions. Only these statements may be written to statement writer, source MUST ignore and MUST NOT emit any other statements.

writeLinkage

public void writeLinkage(StatementWriter writer,
                         QNameToStatementDefinition stmtDef,
                         PrefixToModule preLinkagePrefixes)

Description copied from interface: StatementStreamSource

Emits only linkage-related statements to supplied writer.

Specified by:

writeLinkage in interface StatementStreamSource

Parameters:

writer - StatementWriter which should be used to emit statements.

stmtDef - Map of available statement definitions. Only these statements may be written to statement writer, source MUST ignore and MUST NOT emit any other statements.

preLinkagePrefixes - Pre-linkage map of source-specific prefixes to namespaces

writeLinkage

public void writeLinkage(StatementWriter writer,
                         QNameToStatementDefinition stmtDef,
                         PrefixToModule preLinkagePrefixes,
                         YangVersion yangVersion)

Description copied from interface: StatementStreamSource

Emits only linkage-related statements to supplied writer based on specified yang version. Default implementation does not make any differences between versions.

Specified by:

writeLinkage in interface StatementStreamSource

Parameters:

writer - StatementWriter which should be used to emit statements.

stmtDef - Map of available statement definitions. Only these statements may be written to statement writer, source MUST ignore and MUST NOT emit any other statements.

preLinkagePrefixes - Pre-linkage map of source-specific prefixes to namespaces

yangVersion - yang version.

writeLinkageAndStatementDefinitions

public void writeLinkageAndStatementDefinitions(StatementWriter writer,
                                                QNameToStatementDefinition stmtDef,
                                                PrefixToModule prefixes)

Description copied from interface: StatementStreamSource

Emits only linkage and language extension statements to supplied writer.

Specified by:

writeLinkageAndStatementDefinitions in interface StatementStreamSource

Parameters:

writer - StatementWriter which should be used to emit statements.

stmtDef - Map of available statement definitions. Only these statements may be written to statement writer, source MUST ignore and MUST NOT emit any other statements.

prefixes - Map of source-specific prefixes to namespaces

writeLinkageAndStatementDefinitions

public void writeLinkageAndStatementDefinitions(StatementWriter writer,
                                                QNameToStatementDefinition stmtDef,
                                                PrefixToModule prefixes,
                                                YangVersion yangVersion)

Description copied from interface: StatementStreamSource

Emits only linkage and language extension statements to supplied writer based on specified yang version. Default implementation does not make any differences between versions.

Specified by:

writeLinkageAndStatementDefinitions in interface StatementStreamSource

Parameters:

writer - StatementWriter which should be used to emit statements.

stmtDef - Map of available statement definitions. Only these statements may be written to statement writer, source MUST ignore and MUST NOT emit any other statements.

prefixes - Map of source-specific prefixes to namespaces

yangVersion - yang version.

writeFull

public void writeFull(StatementWriter writer,
                      QNameToStatementDefinition stmtDef,
                      PrefixToModule prefixes)

Description copied from interface: StatementStreamSource

Emits every statements present in this statement source to supplied writer.

Specified by:

writeFull in interface StatementStreamSource

Parameters:

writer - StatementWriter which should be used to emit statements.

stmtDef - Map of available statement definitions.

prefixes - Map of source-specific prefixes to namespaces

writeFull

public void writeFull(StatementWriter writer,
                      QNameToStatementDefinition stmtDef,
                      PrefixToModule prefixes,
                      YangVersion yangVersion)

Description copied from interface: StatementStreamSource

Emits every statements present in this statement source to supplied writer based on specified yang version. Default implementation does not make any differences between versions.

Specified by:

writeFull in interface StatementStreamSource

Parameters:

writer - StatementWriter which should be used to emit statements.

stmtDef - Map of available statement definitions.

prefixes - Map of source-specific prefixes to namespaces

yangVersion - yang version.

getIdentifier

public SourceIdentifier getIdentifier()

Description copied from interface: Identifiable

Return this objects Identifier

Specified by:

getIdentifier in interface Identifiable<SourceIdentifier>

Returns:

Object's identifier, must not be null.

getYangAST

public org.antlr.v4.runtime.ParserRuleContext getYangAST()

parseYangSource

@Deprecated
public static YangStatementParser.StatementContext parseYangSource(InputStream stream)
                                                                        throws IOException,
                                                                               YangSyntaxErrorException

Deprecated. Provided for migration purposes only. Do not use.

Throws:

IOException

YangSyntaxErrorException