Chalk (com.github.tomas-langer:chalk 1.0.2 API)

java.lang.Object
- com.github.tomaslanger.chalk.Chalk

```
public class Chalk
extends Object
```
Chalk allows you to color output going to console. To start, use on(String) and then chain modification. Obviously one background and one foreground color may be used (such as red() and bgRed(), in addition one or more modifiers may be used (bold(), underline(), inverse()). System.out.println("This message is " + Chalk.on("IMPORTANT").red().underline()); User: tomas.langer Date: 3.12.2015 Time: 12:23

Author:

Tomas Langer (tomas.langer@gmail.com)

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Chalk`	`apply(Ansi.AnsiCode modifier)` Either use one of the explicit methods (`red()`, `bold()`, `bgGreen()` etc.), or explicitly invoke this apply method.
`Chalk`	`bgBlack()`
`Chalk`	`bgBlue()`
`Chalk`	`bgCyan()`
`Chalk`	`bgGreen()`
`Chalk`	`bgMagenta()`
`Chalk`	`bgRed()`
`Chalk`	`bgWhite()`
`Chalk`	`bgYellow()`
`Chalk`	`black()`
`Chalk`	`blue()`
`Chalk`	`bold()`
`Chalk`	`cyan()`
`boolean`	`equals(Object o)`
`Chalk`	`gray()` Careful with gray - not supported on windows!!! Will be black...
`Chalk`	`green()`
`int`	`hashCode()`
`Chalk`	`inverse()`
`static boolean`	`isColorEnabled()`
`static boolean`	`isCommandEnabled()`
`Chalk`	`magenta()`
`static Chalk`	`on(String text)`
`Chalk`	`red()`
`static void`	`setColorEnabled(boolean colorEnabled)`
`String`	`toString()`
`Chalk`	`underline()` WIll be highlighted in windows, not underlined
`Chalk`	`white()`
`Chalk`	`yellow()`

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

Method Detail

on
```
public static Chalk on(String text)
```

setColorEnabled

public static void setColorEnabled(boolean colorEnabled)

apply
```
public Chalk apply(Ansi.AnsiCode modifier)
```
Either use one of the explicit methods (red(), bold(), bgGreen() etc.), or explicitly invoke this apply method.

Parameters:

modifier - Modifier - either one of the enumerations in Ansi or a custom modifier (not recommended).

Returns:

Chalk instance to chain commands.

toString
```
public String toString()
```
Overrides:

toString in class Object

black
```
public Chalk black()
```

red
```
public Chalk red()
```

green
```
public Chalk green()
```

yellow
```
public Chalk yellow()
```

blue
```
public Chalk blue()
```

magenta
```
public Chalk magenta()
```

cyan
```
public Chalk cyan()
```

white
```
public Chalk white()
```

gray
```
public Chalk gray()
```
Careful with gray - not supported on windows!!! Will be black...

bold
```
public Chalk bold()
```

inverse
```
public Chalk inverse()
```

underline
```
public Chalk underline()
```
WIll be highlighted in windows, not underlined

bgBlack
```
public Chalk bgBlack()
```

bgRed
```
public Chalk bgRed()
```

bgGreen
```
public Chalk bgGreen()
```

bgYellow
```
public Chalk bgYellow()
```

bgBlue
```
public Chalk bgBlue()
```

bgMagenta
```
public Chalk bgMagenta()
```

bgCyan
```
public Chalk bgCyan()
```

bgWhite
```
public Chalk bgWhite()
```

equals
```
public boolean equals(Object o)
```
Overrides:

equals in class Object

hashCode
```
public int hashCode()
```
Overrides:

hashCode in class Object

isColorEnabled

public static boolean isColorEnabled()

isCommandEnabled

public static boolean isCommandEnabled()

Class Chalk

Method Summary

Methods inherited from class java.lang.Object

Method Detail

on

setColorEnabled

apply

toString

black

red

green

yellow

blue

magenta

cyan

white

gray

bold

inverse

underline

bgBlack

bgRed

bgGreen

bgYellow

bgBlue

bgMagenta

bgCyan

bgWhite

equals

hashCode

isColorEnabled

isCommandEnabled