org.opendaylight.yangtools.yang.model.export

Class DeclaredStatementFormatter

java.lang.Object

org.opendaylight.yangtools.yang.model.export.DeclaredStatementFormatter

All Implemented Interfaces:

Immutable, MutationBehaviour<Immutable>

@Beta
 @ThreadSafe
 @NonNullByDefault
public final class DeclaredStatementFormatter
extends Object
implements Immutable

Utility class for formatting DeclaredStatements.

Author:

Robert Varga

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DeclaredStatementFormatter.Builder Builder class for instantiation of a customized DeclaredStatementFormatter.

Method Summary

Modifier and Type	Method and Description
static DeclaredStatementFormatter.Builder	builder() Create a new DeclaredStatementFormatter.Builder, which can be used to create customized DeclaredStatementFormatter instances.
static DeclaredStatementFormatter	defaultInstance() Return the default DeclaredStatementFormatter instance.
YangTextSnippet	toYangTextSnippet(ModuleEffectiveStatement module, DeclaredStatement<?> statement) Format specified statement into a YangTextSnippet.

Methods inherited from class java.lang.Object

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

Method Detail

toYangTextSnippet

public YangTextSnippet toYangTextSnippet(ModuleEffectiveStatement module,
                                         DeclaredStatement<?> statement)

Format specified statement into a YangTextSnippet.

Parameters:

module - parent module

statement - statement to format

Returns:

A YangTextSnippet

Throws:

NullPointerException - if any of the arguments is null

defaultInstance

public static DeclaredStatementFormatter defaultInstance()

Return the default DeclaredStatementFormatter instance. The instance suppresses statements with default values and does not ignore any statements.

Returns:

Default-configured instance.

builder

public static DeclaredStatementFormatter.Builder builder()

Create a new DeclaredStatementFormatter.Builder, which can be used to create customized DeclaredStatementFormatter instances.

Returns:

A new Builder.