PrettyTree (yangtools-docs 8.0.3 API)

java.lang.Object
- org.opendaylight.yangtools.concepts.PrettyTree

All Implemented Interfaces:

Supplier<String>

Direct Known Subclasses:

NormalizedNodePrettyTree
```
@Beta
public abstract class PrettyTree
extends Object
implements Supplier<String>
```
A capture of a tree-like construct, which can be formatted into a pretty-printed tree. The string can be acquired via get().
This concept is purposefully designed as an abstract class which defers its toString() to get(), as it allows convenient and light-weight use with logging:
```
   
     PrettyTreeAware treeLike;
     LOG.debug("Tree is {}", treeLike.prettyTree());
   
 
```

Constructor Summary

Constructors
Constructor Description

PrettyTree()

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method	Description
`protected static void`	`appendIndent(StringBuilder sb, int depth)`	Append a number of spaces equivalent to specified tree nesting depth into the specified `StringBuilder`.
`abstract void`	`appendTo(StringBuilder sb, int depth)`	Format this object into specified `StringBuilder` starting at specified initial depth.
`@NonNull String`	`get()`
`@NonNull String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - PrettyTree
```
public PrettyTree()
```
- Method Detail
  - get
```
public @NonNull String get()
```
    Specified by:
    
    get in interface Supplier<String>
  - toString
```
public final @NonNull String toString()
```
    Overrides:
    
    toString in class Object
  - appendTo
```
public abstract void appendTo(StringBuilder sb,
                              int depth)
```
    Format this object into specified StringBuilder starting at specified initial depth.
    
    Parameters:
    
    sb - Target StringBuilder
    
    depth - Initial nesting depth
    
    Throws:
    
    NullPointerException - if sb is null
    
    IllegalArgumentException - if depth is negative
  - appendIndent
```
protected static final void appendIndent(StringBuilder sb,
                                         int depth)
```
    Append a number of spaces equivalent to specified tree nesting depth into the specified StringBuilder.
    
    Parameters:
    
    sb - Target StringBuilder
    
    depth - Nesting depth
    
    Throws:
    
    NullPointerException - if sb is null
    
    IllegalArgumentException - if depth is negative