Package org.opendaylight.yangtools.yang.model.export

Class YangTextSnippet

java.lang.Object

org.opendaylight.yangtools.yang.model.export.YangTextSnippet

All Implemented Interfaces:

Iterable<@NonNull String>, Immutable

@NonNullByDefault({PARAMETER,RETURN_TYPE})
public final class YangTextSnippet
extends Object
implements Immutable, Iterable<@NonNull String>

A YANG text snippet generated from a DeclaredStatement. Generated stream() or iterator() are guaranteed to not contain null nor empty strings. Furthermore, newlines are always emitted at the end on the generated string -- which can be checked with isEolString(String) utility method.

This allows individual strings to be escaped as needed and external indentation can be accounted for by inserting outer document indentation after the string which matched isEolString(String) is emitted to the stream.

Author:

Robert Varga

Method Summary

Modifier and Type	Method	Description
static boolean	isEolString(String str)	Check if an emitted string contains End-Of-Line character.
Iterator<@NonNull String>	iterator()
Spliterator<@NonNull String>	spliterator()
Stream<@NonNull String>	stream()
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach

Method Details

iterator

public Iterator<@NonNull String> iterator()

Specified by:

iterator in interface Iterable<@NonNull String>

spliterator

public Spliterator<@NonNull String> spliterator()

Specified by:

spliterator in interface Iterable<@NonNull String>

stream

public Stream<@NonNull String> stream()

isEolString

public static boolean isEolString(String str)

Check if an emitted string contains End-Of-Line character.

Parameters:

str - String to be checked

Returns:

True if the string contains end of line.

Throws:

NullPointerException - if str is null

toString

public String toString()

Overrides:

toString in class Object