Output (openCypher Grammar Developer Tools 1.0.0-M15 API)

All Superinterfaces:

Appendable, AutoCloseable, Closeable

All Known Subinterfaces:

Output.Readable
```
public interface Output
extends Appendable, Closeable
```
Unifies the different classes that can handle text output and formatting, such as PrintStream, PrintWriter, and StringBuilder.
The methods in this interface are defined to return the Output instance itself (this), in order to allow chaining method calls in a "fluent" style.

Nested Class Summary

Nested Classes
Modifier and Type Interface and Description

static interface Output.Readable
An extension of Output that signals that what was written can be read back.

Nested Classes
Modifier and Type	Interface and Description
`static interface`	`Output.Readable` An extension of `Output` that signals that what was written can be read back.

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`default Output`	`and(Output output)` Fluent API for multiplexing multiple `Output` instances.
`default Output`	`append(boolean x)` Append a boolean value.
`Output`	`append(char x)`
`default Output`	`append(char[] str)` Append an array of characters.
`default Output`	`append(char[] str, int offset, int len)` Append a range from an array of characters.
`default Output`	`append(CharSequence str)`
`default Output`	`append(CharSequence str, int start, int end)`
`default Output`	`append(double x)` Append a double-precision floating-point number.
`default Output`	`append(float x)` Append a floating-point number.
`default Output`	`append(int x)` Append an integer.
`default Output`	`append(long x)` Append a long integer.
`default Output`	`append(String str)` Append a string.
`default <T> Output`	`append(T value, BiConsumer<T,Output> writer)` Append an arbitrary object, formatted by a supplied method for writing the object.
`default Output`	`appendCodePoint(int codePoint)` Appends the string representation of the `codePoint` argument to this sequence.
`default void`	`close()`
`static int`	`codePointAt(CharSequence str, int index)` Get the Unicode code point of the specified character sequence at the specified index.
`default Output`	`escape(CharSequence str, IntFunction<String> replacement)` Escape the code points of the given character sequence according to the given replacement function.
`default Output`	`escape(CharSequence str, int start, int end, IntFunction<String> replacement)` Escape the code points of the given character sequence according to the given replacement function.
`default void`	`flush()` Flushes the underlying output.
`default Output`	`format(Locale l, String format, Object... args)` Appends a formatted string to this output stream using the specified format string and arguments.
`default Output`	`format(String format, Object... args)` Appends a formatted string to this output stream using the specified format string and arguments.
`static void`	`getChars(CharSequence source, int begin, int end, char[] target, int off)` Copies characters from the source `CharSequence` into the destination character array.
`static Output`	`lineNumbers(Output output)` Wrap an `Output` in another instance that prepends a line number to every line written.
`static String`	`lines(String... lines)` Join several strings as lines into one string with a line separator in between.
`static Output`	`multiplex(Output... output)` Combine multiple `Output` instances to one instance that writes to all combined instances.
`static Output.Readable`	`nowhere()` Get an `Output` instance that writes nowhere.
`static Output`	`output(CharBuffer buffer)` Adapt a `CharBuffer` to the Output interface.
`static Output`	`output(OutputStream stream)` Adapt an `OutputStream` to the Output interface.
`static Output`	`output(Path path)` Create an `Output` that writes to the specified file.
`static Output.Readable`	`output(StringBuffer buffer)` Adapt a `StringBuffer` to the Output interface.
`static Output.Readable`	`output(StringBuilder builder)` Adapt a `StringBuilder` to the Output interface.
`static Output`	`output(Writer writer)` Adapt a `Writer` to the Output interface.
`default Output`	`printLines(String text, String separator)` Append a specified string, with a given separator inserted between each line in the string.
`default Output`	`println()` Append a line separator.
`default Output`	`println(boolean x)` Append a boolean value and a line separator.
`default Output`	`println(char x)` Append the specified character and a line separator.
`default Output`	`println(char[] str)` Append an array of characters and a line separator.
`default Output`	`println(double x)` Append a double-precision floating-point number and a line separator.
`default Output`	`println(float x)` Append a floating-point number and a line separator.
`default Output`	`println(int x)` Append an integer and a line separator.
`default Output`	`println(long x)` Append a long integer and a line separator.
`default Output`	`println(String str)` Append a string and a line separator.
`static Output`	`stdErr()` Get an `Output` instance that writes to `the standard error output stream`.
`static Output`	`stdOut()` Get an `Output` instance that writes to `the standard output stream`.
`static <T> String`	`string(T value, BiConsumer<T,Output> writer)` Convenience method for converting an object to a `String` through the means of a method that knows how to write such an object to an `Output`.
`static Output.Readable`	`stringBuilder()` Create a new `Output` that writes to a new string builder.
`static Output`	`stringBuilder(int size)` Create a new `Output` that writes to a new string builder of given capacity.
`default Writer`	`writer()` Return a `Writer` that writes to this `Output`.

- Method Detail
  - output
```
static Output output(OutputStream stream)
```
    Adapt an OutputStream to the Output interface.
    
    Parameters:
    
    stream - the OutputStream to adapt.
    
    Returns:
    
    an Output instance that writes to the supplied OutputStream.
  - output
```
static Output output(Writer writer)
```
    Adapt a Writer to the Output interface.
    
    Parameters:
    
    writer - the Writer to adapt.
    
    Returns:
    
    an Output instance that writes to the supplied Writer.
  - output
```
static Output.Readable output(StringBuilder builder)
```
    Adapt a StringBuilder to the Output interface.
    
    Parameters:
    
    builder - the StringBuilder to adapt.
    
    Returns:
    
    a readable Output instance that writes to the supplied StringBuilder.
  - output
```
static Output.Readable output(StringBuffer buffer)
```
    Adapt a StringBuffer to the Output interface.
    
    Parameters:
    
    buffer - the StringBuffer to adapt.
    
    Returns:
    
    a readable Output instance that writes to the supplied StringBuffer.
  - output
```
static Output output(CharBuffer buffer)
```
    Adapt a CharBuffer to the Output interface.
    
    Parameters:
    
    buffer - the CharBuffer to adapt.
    
    Returns:
    
    an Output instance that writes to the supplied CharBuffer.
  - output
```
static Output output(Path path)
```
    Create an Output that writes to the specified file.
    
    Parameters:
    
    path - the file to write to.
    
    Returns:
    
    an Output instance that writes to the specified file.
  - stringBuilder
```
static Output.Readable stringBuilder()
```
    Create a new Output that writes to a new string builder. The returned object can be used to retrieve the constructed string.
    
    Returns:
    
    a new readable Output instance.
  - stringBuilder
```
static Output stringBuilder(int size)
```
    Create a new Output that writes to a new string builder of given capacity. The returned object can be used to retrieve the constructed string.
    
    Parameters:
    
    size - the initial capacity of the internal string builder.
    
    Returns:
    
    a new readable Output instance.
  - stdOut
```
static Output stdOut()
```
    Get an Output instance that writes to the standard output stream.
    
    Returns:
    
    an Output instance that writes to standard out.
  - stdErr
```
static Output stdErr()
```
    Get an Output instance that writes to the standard error output stream.
    
    Returns:
    
    an Output instance that writes to standard error.
  - nowhere
```
static Output.Readable nowhere()
```
    Get an Output instance that writes nowhere.
    The returned instance is readable in order to be usable in places where a readable output is required, although the result of reading from this instance is always as if nothing was written.
    
    Returns:
    
    an Output instance that writes nowhere.
  - lineNumbers
```
static Output lineNumbers(Output output)
```
    Wrap an Output in another instance that prepends a line number to every line written.
    
    Parameters:
    
    output - the wrapped output, where numbered lines will be written to.
    
    Returns:
    
    an Output instance that prepends lines with line numbers.
  - multiplex
```
static Output multiplex(Output... output)
```
    Combine multiple Output instances to one instance that writes to all combined instances.
    
    Parameters:
    
    output - the output instances to combine and write all output to.
    
    Returns:
    
    an Output instance that writes to all the supplied instances.
  - and
```
default Output and(Output output)
```
    Fluent API for multiplexing multiple Output instances.
    
    Parameters:
    
    output - an Output instance to also write to.
    
    Returns:
    
    an Output instance that writes to both this and the supplied Output instance.
  - string
```
static <T> String string(T value,
                         BiConsumer<T,Output> writer)
```
    Convenience method for converting an object to a String through the means of a method that knows how to write such an object to an Output.
    
    Type Parameters:
    
    T - the type of the object to write.
    
    Parameters:
    
    value - the object to convert to a String.
    
    writer - the method that knows how to write the supplied object to an Output.
    
    Returns:
    
    the resulting String.
    
    See Also:
    
    append(Object, BiConsumer)
  - lines
```
static String lines(String... lines)
```
    Join several strings as lines into one string with a line separator in between.
    
    Parameters:
    
    lines - the lines to join.
    
    Returns:
    
    a string that consists of the supplied lines.
  - escape
```
default Output escape(CharSequence str,
                      IntFunction<String> replacement)
```
    Escape the code points of the given character sequence according to the given replacement function.
    The replacement function can (and is recommended to) be a partial function, only returning replacements for the code points that are to be escaped and returning null for other code points.
    
    Parameters:
    
    str - the character sequence to escape the contents of.
    
    replacement - the replacement function that defines how to escape the code points that need escaping.
    
    Returns:
    
    this Output instance to allow invocation chaining.
  - escape
```
default Output escape(CharSequence str,
                      int start,
                      int end,
                      IntFunction<String> replacement)
```
    Escape the code points of the given character sequence according to the given replacement function.
    The replacement function can (and is recommended to) be a partial function, only returning replacements for the code points that are to be escaped and returning null for other code points.
    
    Parameters:
    
    str - the character sequence to escape the contents of.
    
    start - the position in the given character sequence to start at.
    
    end - the position in the given character sequence to end at.
    
    replacement - the replacement function that defines how to escape the code points that need escaping.
    
    Returns:
    
    this Output instance to allow invocation chaining.
  - append
```
default <T> Output append(T value,
                          BiConsumer<T,Output> writer)
```
    Append an arbitrary object, formatted by a supplied method for writing the object.
    Sample usage of this method:
```
 class Container {
      private Contained one, other;

      public @Override String toString() {
          return Output.stringBuilder().append( this, Container::write ).toString();
      }
      public void write( Output output ) {
          output.append( "Container[one=" ).append( one, Contained::write )
                .append( ", other=" ).append( other, Contained::write ).append( ']' );
      }
 }
 
```
    Type Parameters:
    
    T - the type of the object to write.
    
    Parameters:
    
    value - the object to write.
    
    writer - the method that knows how to write the supplied object to an Output.
    
    Returns:
    
    this Output instance to allow invocation chaining.
  - append
```
Output append(char x)
```
    Specified by:
    
    append in interface Appendable
  - append
```
default Output append(CharSequence str)
```
    Specified by:
    
    append in interface Appendable
  - append
```
default Output append(CharSequence str,
                      int start,
                      int end)
```
    Specified by:
    
    append in interface Appendable
  - append
```
default Output append(boolean x)
```
    Append a boolean value.
    
    Parameters:
    
    x - the boolean to append.
    
    Returns:
    
    this Output instance to allow invocation chaining.
  - append
```
default Output append(int x)
```
    Append an integer.
    
    Parameters:
    
    x - the int to append.
    
    Returns:
    
    this Output instance to allow invocation chaining.
  - append
```
default Output append(long x)
```
    Append a long integer.
    
    Parameters:
    
    x - the long to append.
    
    Returns:
    
    this Output instance to allow invocation chaining.
  - append
```
default Output append(float x)
```
    Append a floating-point number.
    
    Parameters:
    
    x - the float to append.
    
    Returns:
    
    this Output instance to allow invocation chaining.
  - append
```
default Output append(double x)
```
    Append a double-precision floating-point number.
    
    Parameters:
    
    x - the double to append.
    
    Returns:
    
    this Output instance to allow invocation chaining.
  - appendCodePoint
```
default Output appendCodePoint(int codePoint)
```
    Appends the string representation of the codePoint argument to this sequence.
    
    Parameters:
    
    codePoint - a Unicode code point
    
    Returns:
    
    this Output instance to allow invocation chaining.
    
    Throws:
    
    IllegalArgumentException - if the specified codePoint isn't a valid Unicode code point.
    
    See Also:
    
    the corresponding method of StringBuilder
  - append
```
default Output append(String str)
```
    Append a string.
    
    Parameters:
    
    str - the String to append.
    
    Returns:
    
    this Output instance to allow invocation chaining.
  - append
```
default Output append(char[] str)
```
    Append an array of characters.
    
    Parameters:
    
    str - the char[] to append.
    
    Returns:
    
    this Output instance to allow invocation chaining.
  - append
```
default Output append(char[] str,
                      int offset,
                      int len)
```
    Append a range from an array of characters.
    
    Parameters:
    
    str - the char[] to append.
    
    offset - the position in the supplied array to start from.
    
    len - the number of characters from the supplied array to append.
    
    Returns:
    
    this Output instance to allow invocation chaining.
  - printLines
```
default Output printLines(String text,
                          String separator)
```
    Append a specified string, with a given separator inserted between each line in the string.
    
    Parameters:
    
    text - the String to append.
    
    separator - the String to insert between each line of the string.
    
    Returns:
    
    this Output instance to allow invocation chaining.
  - println
```
default Output println()
```
    Append a line separator.
    
    Returns:
    
    this Output instance to allow invocation chaining.
    
    See Also:
    
    System.lineSeparator()
  - println
```
default Output println(boolean x)
```
    Append a boolean value and a line separator.
    
    Parameters:
    
    x - the boolean to append.
    
    Returns:
    
    this Output instance to allow invocation chaining.
  - println
```
default Output println(char x)
```
    Append the specified character and a line separator.
    
    Parameters:
    
    x - the char to append.
    
    Returns:
    
    this Output instance to allow invocation chaining.
  - println
```
default Output println(int x)
```
    Append an integer and a line separator.
    
    Parameters:
    
    x - the int to append.
    
    Returns:
    
    this Output instance to allow invocation chaining.
  - println
```
default Output println(long x)
```
    Append a long integer and a line separator.
    
    Parameters:
    
    x - the long to append.
    
    Returns:
    
    this Output instance to allow invocation chaining.
  - println
```
default Output println(float x)
```
    Append a floating-point number and a line separator.
    
    Parameters:
    
    x - the float to append.
    
    Returns:
    
    this Output instance to allow invocation chaining.
  - println
```
default Output println(double x)
```
    Append a double-precision floating-point number and a line separator.
    
    Parameters:
    
    x - the double to append.
    
    Returns:
    
    this Output instance to allow invocation chaining.
  - println
```
default Output println(char[] str)
```
    Append an array of characters and a line separator.
    
    Parameters:
    
    str - the char[] to append.
    
    Returns:
    
    this Output instance to allow invocation chaining.
  - println
```
default Output println(String str)
```
    Append a string and a line separator.
    
    Parameters:
    
    str - the String to append.
    
    Returns:
    
    this Output instance to allow invocation chaining.
  - format
```
default Output format(String format,
                      Object... args)
```
    Appends a formatted string to this output stream using the specified format string and arguments.
    
    Parameters:
    
    format - the format string.
    
    args - Arguments referenced by the format specifiers in the format string.
    
    Returns:
    
    this Output instance to allow invocation chaining.
    
    Throws:
    
    IllegalFormatException - If a format string contains an illegal syntax, a format specifier that is incompatible with the given arguments, insufficient arguments given the format string, or other illegal conditions.
    
    See Also:
    
    Formatter.format(String, Object...)
  - format
```
default Output format(Locale l,
                      String format,
                      Object... args)
```
    Appends a formatted string to this output stream using the specified format string and arguments.
    
    Parameters:
    
    l - The locale to apply during formatting. If l is null then no localization is applied.
    
    format - the format string.
    
    args - Arguments referenced by the format specifiers in the format string.
    
    Returns:
    
    this Output instance to allow invocation chaining.
    
    Throws:
    
    IllegalFormatException - If a format string contains an illegal syntax, a format specifier that is incompatible with the given arguments, insufficient arguments given the format string, or other illegal conditions.
    
    See Also:
    
    Formatter.format(Locale, String, Object...)
  - flush
```
default void flush()
```
    Flushes the underlying output.
  - close
```
default void close()
```
    Specified by:
    
    close in interface AutoCloseable
    
    Specified by:
    
    close in interface Closeable
  - writer
```
default Writer writer()
```
    Return a Writer that writes to this Output.
    
    Returns:
    
    a Writer that writes to this Output.
  - codePointAt
```
static int codePointAt(CharSequence str,
                       int index)
```
    Get the Unicode code point of the specified character sequence at the specified index.
    This method improves the corresponding method in Character by delegating to methods on specific CharSequence implementations if present.
    
    Parameters:
    
    str - the character sequence to get the code point from.
    
    index - the index in the character sequnce the get the code point at.
    
    Returns:
    
    the code point value of the character(s) at the index of the character sequence.
    
    Throws:
    
    IndexOutOfBoundsException - if the index argument is negative or not less than the length of the contents of the character sequence.
    
    See Also:
    
    Character.codePointAt(CharSequence, int)
  - getChars
```
static void getChars(CharSequence source,
                     int begin,
                     int end,
                     char[] target,
                     int off)
```
    Copies characters from the source CharSequence into the destination character array.
    This method delegates to methods on specific CharSequence implementations if present.
    Parameters:
    
    source - the character sequence to copy characters from.
    
    begin - the index of the first character in the sequence to copy.
    
    end - the index after the last character in the sequence to copy.
    
    target - the destination array.
    
    off - the start offset in the destination array.
    
    Throws:
    IndexOutOfBoundsException - If any of the following is true:
    srcBegin is negative.
    srcBegin is greater than srcEnd
    srcEnd is greater than the length of the character sequence
    dstBegin is negative
    dstBegin+(srcEnd-srcBegin) is larger than dst.length
    See Also:
    
    the corresponding method in String

Interface Output

Nested Class Summary

Method Summary

Method Detail

output

output

output

output

output

output

stringBuilder

stringBuilder

stdOut

stdErr

nowhere

lineNumbers

multiplex

and

string

lines

escape

escape

append

append

append

append

append

append

append

append

append

appendCodePoint

append

append

append

printLines

println

println

println

println

println

println

println

println

println

format

format

flush

close

writer

codePointAt

getChars