io.vertx.codegen.writer

Class CodeWriter

java.lang.Object

java.io.Writer

java.io.PrintWriter

io.vertx.codegen.writer.CodeWriter

All Implemented Interfaces:

Closeable, Flushable, Appendable, AutoCloseable

public class CodeWriter
extends PrintWriter

Class to simplify code write that maintains indentation status

Author:

Francesco Guardiani @slinkydeveloper

Field Summary

Fields inherited from class java.io.PrintWriter

out

Fields inherited from class java.io.Writer

lock

Constructor Summary

Constructors

Constructor and Description
CodeWriter(Writer out)

Method Summary

Modifier and Type	Method and Description
CodeWriter	append(char c)
CodeWriter	append(CharSequence csq)
CodeWriter	append(CharSequence csq, int start, int end)
CodeWriter	code(String string) Print the specified string with an indent prefix.
CodeWriter	codeln(String line) Print the specified line with an indent prefix and end with a new line char.
CodeWriter	format(Locale l, String format, Object... args)
CodeWriter	format(String format, Object... args)
CodeWriter	indent() Increment the current indentation.
String	indentation()
CodeWriter	indented(Runnable block)
int	indentSize()
CodeWriter	indentSize(int size) Set the current indentation size, this can only be done when the current indentation is 0.
CodeWriter	javaImport(String name) Append the name as a java package import.
CodeWriter	newLine() Print a new line char.
void	println()
CodeWriter	stmt(String statement) This function prints an indentation before the statement and a semicolon followed by a newline after.
CodeWriter	unindent() Decrement the current indentation.
void	write(int c)
void	write(String s, int off, int len)
Writer	writer()
CodeWriter	writeSeq(Stream<String> sequence, String delimiter) Write a sequence delimited by a delimiter.

Methods inherited from class java.io.PrintWriter

checkError, clearError, close, flush, print, print, print, print, print, print, print, print, print, printf, printf, println, println, println, println, println, println, println, println, println, setError, write, write, write

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CodeWriter

public CodeWriter(Writer out)

Method Detail

writer

public Writer writer()

Returns:

the current underlying writer

indentSize

public int indentSize()

Returns:

the current indentation size

indentSize

public CodeWriter indentSize(int size)

Set the current indentation size, this can only be done when the current indentation is 0.

Parameters:

size - the new size

Returns:

this object

indentation

public String indentation()

Returns:

the current indentation string

indent

public CodeWriter indent()

Increment the current indentation.

Returns:

this object

unindent

public CodeWriter unindent()

Decrement the current indentation.

Returns:

this object

indented

public CodeWriter indented(Runnable block)

javaImport

public CodeWriter javaImport(String name)

Append the name as a java package import.

Returns:

this object

code

public CodeWriter code(String string)

Print the specified string with an indent prefix. This method forces the writer to be the first line

Parameters:

string - the string to print

Returns:

this object

codeln

public CodeWriter codeln(String line)

Print the specified line with an indent prefix and end with a new line char.

Parameters:

line - the line to print

Returns:

this object

stmt

public CodeWriter stmt(String statement)

This function prints an indentation before the statement and a semicolon followed by a newline after.

Parameters:

statement - the statement

Returns:

this object

newLine

public CodeWriter newLine()

Print a new line char.

Returns:

this object

writeSeq

public CodeWriter writeSeq(Stream<String> sequence,
                           String delimiter)

Write a sequence delimited by a delimiter.

Returns:

this object

println

public void println()

Overrides:

println in class PrintWriter

write

public void write(String s,
                  int off,
                  int len)

Overrides:

write in class PrintWriter

write

public void write(int c)

Overrides:

write in class PrintWriter

append

public CodeWriter append(CharSequence csq)

Specified by:

append in interface Appendable

Overrides:

append in class PrintWriter

append

public CodeWriter append(CharSequence csq,
                         int start,
                         int end)

Specified by:

append in interface Appendable

Overrides:

append in class PrintWriter

append

public CodeWriter append(char c)

Specified by:

append in interface Appendable

Overrides:

append in class PrintWriter

format

public CodeWriter format(String format,
                         Object... args)

Overrides:

format in class PrintWriter

format

public CodeWriter format(Locale l,
                         String format,
                         Object... args)

Overrides:

format in class PrintWriter