Module org.opendaylight.yangtools.yang.parser.api

Package org.opendaylight.yangtools.yang.parser.api

Class YangParserConfiguration.Builder

java.lang.Object

org.opendaylight.yangtools.yang.parser.api.YangParserConfiguration.Builder

All Implemented Interfaces:

Mutable, MutationBehaviour<Mutable>

Enclosing class:

YangParserConfiguration

public static final class YangParserConfiguration.Builder
extends Object
implements Mutable

Method Summary

Modifier and Type	Method	Description
YangParserConfiguration	build()	Return a YangParserConfiguration initialized with contents of this builder.
YangParserConfiguration.Builder	importResolutionMode(ImportResolutionMode newImportResolutionMode)
YangParserConfiguration.Builder	retainDeclarationReferences(boolean newRetainDeclarationReferences)	Retain DeclarationReference to source location in the final parser product.
YangParserConfiguration.Builder	warnForUnkeyedLists(boolean newWarnForUnkeyedLists)	Issue a warning when a list statement without a key statement is found in the config true part of the schema tree.

Methods inherited from class java.lang.Object

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

Method Detail

build

public YangParserConfiguration build()

Return a YangParserConfiguration initialized with contents of this builder.

Returns:

A YangParserConfiguration

importResolutionMode

@Beta
public YangParserConfiguration.Builder importResolutionMode(ImportResolutionMode newImportResolutionMode)

retainDeclarationReferences

public YangParserConfiguration.Builder retainDeclarationReferences(boolean newRetainDeclarationReferences)

Retain DeclarationReference to source location in the final parser product. This option results in quite significant memory overhead for storage of DeclaredStatement, but makes DeclaredStatement.declarationReference() available, which is useful in certain scenarios, for example YANG editors.

This option is disabled by default.

Parameters:

newRetainDeclarationReferences - true if declaration references should be retained

Returns:

This builder

warnForUnkeyedLists

public YangParserConfiguration.Builder warnForUnkeyedLists(boolean newWarnForUnkeyedLists)

Issue a warning when a list statement without a key statement is found in the config true part of the schema tree. Such statements run contrary to RFC7950, but are readily supported by OpenDaylight infrastructure.

This option is enabled by default.

Parameters:

newWarnForUnkeyedLists - true if non-compliant list statements should be reported

Returns:

This builder