LogStream (Graal OpenJDK Project Documentation)

java.lang.Object
- com.oracle.graal.debug.LogStream

```
public class LogStream
extends Object
```
A utility for printing compiler debug and informational output to an output stream. A LogStream instance maintains an internal buffer that is flushed to the underlying output stream every time one of the println methods is invoked, or a newline character ( '\n') is written. All of the print and println methods return the {code LogStream} instance on which they were invoked. This allows chaining of these calls to mitigate use of String concatenation by the caller. A LogStream maintains a current indentation level. Each line of output written to this stream has n spaces prefixed to it where n is the value that would be returned by indentationLevel() when the first character of a new line is written. A LogStream maintains a current position for the current line being written. This position can be advanced to a specified position by filling this stream with a given character.

Field Summary

Fields
Modifier and Type	Field and Description
`private char`	`indentation`
`private boolean`	`indentationDisabled`
`private int`	`indentationLevel`
`static String`	`LINE_SEPARATOR` The system dependent line separator.
`private StringBuilder`	`lineBuffer`
`private PrintStream`	`ps` The output stream to which this log stream writes.
`static LogStream`	`SINK` Null output stream that simply swallows any output sent to it.
`private static PrintStream`	`SINK_PS`

Constructor Summary

Constructors
Modifier	Constructor and Description
`private`	`LogStream()`
	`LogStream(LogStream log)` Creates a new log stream that shares the same output stream as a given `LogStream`.
	`LogStream(OutputStream os)` Creates a new log stream.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`adjustIndentation(int delta)` Adjusts the current indentation level of this log stream.
`void`	`disableIndentation()`
`void`	`enableIndentation()`
`LogStream`	`fillTo(int position, char filler)` Advances this stream's position to a given position by repeatedly appending a given character as necessary.
`void`	`flush()` Flushes the stream.
`private LogStream`	`flushLine(boolean withNewline)`
`private void`	`indent()` Prepends `indentation` to the current output line until its write position is equal to the current indentationLevel() level.
`char`	`indentation()` Gets the current indentation character of this log stream.
`int`	`indentationLevel()` Gets the current indentation level for this log stream.
`PrintStream`	`out()`
`int`	`position()` Gets the current column position of this log stream.
`LogStream`	`print(boolean b)` Writes a boolean value to this stream as `"true"` or `"false"`.
`LogStream`	`print(char c)` Writes a character value to this stream.
`LogStream`	`print(double d)` Writes a double value to this stream.
`LogStream`	`print(float f)` Writes a float value to this stream.
`LogStream`	`print(int i)` Prints an int value.
`LogStream`	`print(long l)` Writes a long value to this stream.
`LogStream`	`print(String s)` Writes a `String` value to this stream.
`LogStream`	`printf(String format, Object... args)` Writes a formatted string to this stream.
`LogStream`	`println()` Writes a line separator to this stream.
`LogStream`	`println(boolean b)` Writes a boolean value to this stream followed by a line separator.
`LogStream`	`println(char c)` Writes a character value to this stream followed by a line separator.
`LogStream`	`println(double d)` Writes a double value to this stream followed by a line separator.
`LogStream`	`println(float f)` Writes a float value to this stream followed by a line separator .
`LogStream`	`println(int i)` Writes an int value to this stream followed by a line separator.
`LogStream`	`println(long l)` Writes a long value to this stream followed by a line separator.
`LogStream`	`println(String s)` Writes a `String` value to this stream followed by a line separator.
`void`	`setIndentation(char c)` Sets the character used for indentation.

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

- Field Detail
  - SINK
```
public static final LogStream SINK
```
    Null output stream that simply swallows any output sent to it.
  - SINK_PS
```
private static final PrintStream SINK_PS
```
  - ps
```
private final PrintStream ps
```
    The output stream to which this log stream writes.
  - lineBuffer
```
private final StringBuilder lineBuffer
```
  - indentationLevel
```
private int indentationLevel
```
  - indentation
```
private char indentation
```
  - indentationDisabled
```
private boolean indentationDisabled
```
  - LINE_SEPARATOR
```
public static final String LINE_SEPARATOR
```
    The system dependent line separator.
- Constructor Detail
  - LogStream
```
private LogStream()
```
  - LogStream
```
public LogStream(OutputStream os)
```
    Creates a new log stream.
    
    Parameters:
    
    os - the underlying output stream to which prints are sent
  - LogStream
```
public LogStream(LogStream log)
```
    Creates a new log stream that shares the same output stream as a given LogStream.
    
    Parameters:
    
    log - a LogStream whose output stream is shared with this one
- Method Detail
  - out
```
public final PrintStream out()
```
  - indent
```
private void indent()
```
    Prepends indentation to the current output line until its write position is equal to the current indentationLevel() level.
  - flushLine
```
private LogStream flushLine(boolean withNewline)
```
  - flush
```
public void flush()
```
    Flushes the stream. This is done by terminating the current line if it is not at position 0 and then flushing the underlying output stream.
  - position
```
public int position()
```
    Gets the current column position of this log stream.
    
    Returns:
    
    the current column position of this log stream
  - indentationLevel
```
public int indentationLevel()
```
    Gets the current indentation level for this log stream.
    
    Returns:
    
    the current indentation level for this log stream.
  - adjustIndentation
```
public void adjustIndentation(int delta)
```
    Adjusts the current indentation level of this log stream.
    
    Parameters:
    
    delta -
  - indentation
```
public char indentation()
```
    Gets the current indentation character of this log stream.
  - disableIndentation
```
public void disableIndentation()
```
  - enableIndentation
```
public void enableIndentation()
```
  - setIndentation
```
public void setIndentation(char c)
```
    Sets the character used for indentation.
  - fillTo
```
public LogStream fillTo(int position,
                        char filler)
```
    Advances this stream's position to a given position by repeatedly appending a given character as necessary.
    
    Parameters:
    
    position - the position to which this stream's position will be advanced
    
    filler - the character used to pad the stream
  - print
```
public LogStream print(boolean b)
```
    Writes a boolean value to this stream as "true" or "false".
    
    Parameters:
    
    b - the value to be printed
    
    Returns:
    
    this LogStream instance
  - println
```
public LogStream println(boolean b)
```
    Writes a boolean value to this stream followed by a line separator.
    
    Parameters:
    
    b - the value to be printed
    
    Returns:
    
    this LogStream instance
  - print
```
public LogStream print(char c)
```
    Writes a character value to this stream.
    
    Parameters:
    
    c - the value to be printed
    
    Returns:
    
    this LogStream instance
  - println
```
public LogStream println(char c)
```
    Writes a character value to this stream followed by a line separator.
    
    Parameters:
    
    c - the value to be printed
    
    Returns:
    
    this LogStream instance
  - print
```
public LogStream print(int i)
```
    Prints an int value.
    
    Parameters:
    
    i - the value to be printed
    
    Returns:
    
    this LogStream instance
  - println
```
public LogStream println(int i)
```
    Writes an int value to this stream followed by a line separator.
    
    Parameters:
    
    i - the value to be printed
    
    Returns:
    
    this LogStream instance
  - print
```
public LogStream print(float f)
```
    Writes a float value to this stream.
    
    Parameters:
    
    f - the value to be printed
    
    Returns:
    
    this LogStream instance
  - println
```
public LogStream println(float f)
```
    Writes a float value to this stream followed by a line separator .
    
    Parameters:
    
    f - the value to be printed
    
    Returns:
    
    this LogStream instance
  - print
```
public LogStream print(long l)
```
    Writes a long value to this stream.
    
    Parameters:
    
    l - the value to be printed
    
    Returns:
    
    this LogStream instance
  - println
```
public LogStream println(long l)
```
    Writes a long value to this stream followed by a line separator.
    
    Parameters:
    
    l - the value to be printed
    
    Returns:
    
    this LogStream instance
  - print
```
public LogStream print(double d)
```
    Writes a double value to this stream.
    
    Parameters:
    
    d - the value to be printed
    
    Returns:
    
    this LogStream instance
  - println
```
public LogStream println(double d)
```
    Writes a double value to this stream followed by a line separator.
    
    Parameters:
    
    d - the value to be printed
    
    Returns:
    
    this LogStream instance
  - print
```
public LogStream print(String s)
```
    Writes a String value to this stream. This method ensures that the position of this stream is updated correctly with respect to any line separators present in s.
    
    Parameters:
    
    s - the value to be printed
    
    Returns:
    
    this LogStream instance
  - println
```
public LogStream println(String s)
```
    Writes a String value to this stream followed by a line separator.
    
    Parameters:
    
    s - the value to be printed
    
    Returns:
    
    this LogStream instance
  - printf
```
public LogStream printf(String format,
                        Object... args)
```
    Writes a formatted string to this stream.
    
    Parameters:
    
    format - a format string as described in String.format(String, Object...)
    
    args - the arguments to be formatted
    
    Returns:
    
    this LogStream instance
  - println
```
public LogStream println()
```
    Writes a line separator to this stream.
    
    Returns:
    
    this LogStream instance

Class LogStream

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SINK

SINK_PS

ps

lineBuffer

indentationLevel

indentation

indentationDisabled

LINE_SEPARATOR

Constructor Detail

LogStream

LogStream

LogStream

Method Detail

out

indent

flushLine

flush

position

indentationLevel

adjustIndentation

indentation

disableIndentation

enableIndentation

setIndentation

fillTo

print

println

print

println

print

println

print

println

print

println

print

println

print

println

printf

println