AnsiOutput (spring-boot 2.1.0.RELEASE)

java.lang.Object
- org.springframework.boot.ansi.AnsiOutput

```
public abstract class AnsiOutput
extends Object
```
Generates ANSI encoded output, automatically attempting to detect if the terminal supports ANSI.

Author:

Phillip Webb

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class AnsiOutput.Enabled
Possible values to pass to setEnabled(org.springframework.boot.ansi.AnsiOutput.Enabled).

Constructor Summary

Constructors
Constructor and Description

AnsiOutput()

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static String`	`encode(AnsiElement element)` Encode a single `AnsiElement` if output is enabled.
`static void`	`setConsoleAvailable(Boolean consoleAvailable)` Sets if the System.console() is known to be available.
`static void`	`setEnabled(AnsiOutput.Enabled enabled)` Sets if ANSI output is enabled.
`static String`	`toString(Object... elements)` Create a new ANSI string from the specified elements.

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

- Constructor Detail
  - AnsiOutput
```
public AnsiOutput()
```
- Method Detail
  - setEnabled
```
public static void setEnabled(AnsiOutput.Enabled enabled)
```
    Sets if ANSI output is enabled.
    
    Parameters:
    
    enabled - if ANSI is enabled, disabled or detected
  - setConsoleAvailable
```
public static void setConsoleAvailable(Boolean consoleAvailable)
```
    Sets if the System.console() is known to be available.
    
    Parameters:
    
    consoleAvailable - if the console is known to be available or null to use standard detection logic.
  - encode
```
public static String encode(AnsiElement element)
```
    Encode a single AnsiElement if output is enabled.
    
    Parameters:
    
    element - the element to encode
    
    Returns:
    
    the encoded element or an empty string
  - toString
```
public static String toString(Object... elements)
```
    Create a new ANSI string from the specified elements. Any AnsiElements will be encoded as required.
    
    Parameters:
    
    elements - the elements to encode
    
    Returns:
    
    a string of the encoded elements

Copyright © 2018 Pivotal Software, Inc.. All rights reserved.