Vert.x 4.5.13 · io.vertx.codegen.writer.CodeWriter · APIdia, the JavaDoc alternative

Modifier and Type	Field and Description
private boolean	first
private int	indent
private int	indentSize

Access	Constructor and Description
public	CodeWriter(Writer out)

Method Summary

Modifier and Type	Method and Description
public CodeWriter	append(CharSequence The character sequence to append. If `csq` is `null`, then the four characters `"null"` are appended to this writer. csq) Overrides java.io.PrintWriter.append. Implements java.lang.Appendable.append. Appends the specified character sequence to this writer.
public CodeWriter	append(CharSequence The character sequence from which a subsequence will be appended. If `csq` is `null`, then characters will be appended as if `csq` contained the four characters `"null"`. csq, int The index of the first character in the subsequence start, int The index of the character following the last character in the subsequence end) Overrides java.io.PrintWriter.append. Implements java.lang.Appendable.append. Appends a subsequence of the specified character sequence to this writer.
public CodeWriter	append(char The 16-bit character to append c) Overrides java.io.PrintWriter.append. Implements java.lang.Appendable.append. Appends the specified character to this writer.
public CodeWriter	Returns: this object code(String the string to print string) Print the specified `string` with an indent prefix.
public CodeWriter	Returns: this object codeln(String the line to print line) Print the specified `line` with an indent prefix and end with a new line char.
public CodeWriter	format(String A format string as described in Format string syntax. format, Object... Arguments referenced by the format specifiers in the format string. If there are more arguments than format specifiers, the extra arguments are ignored. The number of arguments is variable and may be zero. The maximum number of arguments is limited by the maximum dimension of a Java array as defined by The Java Virtual Machine Specification. The behaviour on a `null` argument depends on the conversion. args) Overrides java.io.PrintWriter.format. Writes a formatted string to this writer using the specified format string and arguments.
public CodeWriter	format(Locale The locale to apply during formatting. If `l` is `null` then no localization is applied. l, String A format string as described in Format string syntax. format, Object... Arguments referenced by the format specifiers in the format string. If there are more arguments than format specifiers, the extra arguments are ignored. The number of arguments is variable and may be zero. The maximum number of arguments is limited by the maximum dimension of a Java array as defined by The Java Virtual Machine Specification. The behaviour on a `null` argument depends on the conversion. args) Overrides java.io.PrintWriter.format. Writes a formatted string to this writer using the specified format string and arguments.
public CodeWriter	Returns: this object indent() Increment the current indentation.
public String	Returns: the current indentation string indentation()
public CodeWriter	indented(Runnable block)
public int	Returns: the current indentation size indentSize()
public CodeWriter	Returns: this object indentSize(int the new size size) Set the current indentation size, this can only be done when the current indentation is `0`.
public CodeWriter	Returns: this object javaImport(String name) Append the `name` as a java package import.
public CodeWriter	Returns: this object newLine() Hides java.io.PrintWriter.newLine. Print a new line char.
public void	println() Overrides java.io.PrintWriter.println. Terminates the current line by writing the line separator string.
public CodeWriter	Returns: this object stmt(String the statement statement) This function prints an indentation before the `statement` and a semicolon followed by a newline after.
public CodeWriter	Returns: this object unindent() Decrement the current indentation.
public void	write(String A String s, int Offset from which to start writing characters off, int Number of characters to write len) Overrides java.io.PrintWriter.write. Writes a portion of a string.
public void	write(int int specifying a character to be written. c) Overrides java.io.PrintWriter.write. Writes a single character.
public Writer	Returns: the current underlying writer writer()
public CodeWriter	Returns: this object writeSeq(Stream<String> sequence, String delimiter) Write a `sequence` delimited by a `delimiter`.

first	back to summary
private boolean first

indent	back to summary
private int indent

indentSize	back to summary
private int indentSize

CodeWriter	back to summary
public CodeWriter(Writer out)

Method Detail

append back to summary

append	back to summary
public CodeWriter append(CharSequence csq) Overrides java.io.PrintWriter.append. Implements java.lang.Appendable.append. Doc from java.io.PrintWriter.append. Appends the specified character sequence to this writer. An invocation of this method of the form `out.append(csq)` when `csq` is not `null`, behaves in exactly the same way as the invocation `out.write(csq.toString())` out.write(csq.toString()) Depending on the specification of `toString` for the character sequence `csq`, the entire sequence may not be appended. For instance, invoking the `toString` method of a character buffer will return a subsequence whose content depends upon the buffer's position and limit. Parameters csq:CharSequence The character sequence to append. If `csq` is `null`, then the four characters `"null"` are appended to this writer. Returns:CodeWriter This writer Annotations @Override

public CodeWriter append(CharSequence csq)

Overrides java.io.PrintWriter.append.

Implements java.lang.Appendable.append.

Doc from java.io.PrintWriter.append.

Appends the specified character sequence to this writer.

An invocation of this method of the form out.append(csq) when csq is not null, behaves in exactly the same way as the invocation

out.write(csq.toString())

Depending on the specification of toString for the character sequence csq, the entire sequence may not be appended. For instance, invoking the toString method of a character buffer will return a subsequence whose content depends upon the buffer's position and limit.

Parameters

csq:CharSequence: The character sequence to append. If csq is null, then the four characters "null" are appended to this writer.

Returns:CodeWriter

This writer

Annotations

@Override

append back to summary

append	back to summary
public CodeWriter append(CharSequence csq, int start, int end) Overrides java.io.PrintWriter.append. Implements java.lang.Appendable.append. Doc from java.io.PrintWriter.append. Appends a subsequence of the specified character sequence to this writer. An invocation of this method of the form `out.append(csq, start, end)` when `csq` is not `null`, behaves in exactly the same way as the invocation `out.write(csq.subSequence(start, end).toString())` out.write(csq.subSequence(start, end).toString()) Parameters csq:CharSequence The character sequence from which a subsequence will be appended. If `csq` is `null`, then characters will be appended as if `csq` contained the four characters `"null"`. start:int The index of the first character in the subsequence end:int The index of the character following the last character in the subsequence Returns:CodeWriter This writer Annotations @Override

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

Overrides java.io.PrintWriter.append.

Implements java.lang.Appendable.append.

Doc from java.io.PrintWriter.append.

Appends a subsequence of the specified character sequence to this writer.

An invocation of this method of the form out.append(csq, start, end) when csq is not null, behaves in exactly the same way as the invocation

out.write(csq.subSequence(start, end).toString())

Parameters

csq:CharSequence: The character sequence from which a subsequence will be appended. If csq is null, then characters will be appended as if csq contained the four characters "null".
start:int: The index of the first character in the subsequence
end:int: The index of the character following the last character in the subsequence

Returns:CodeWriter

This writer

Annotations

@Override

append back to summary

append	back to summary
public CodeWriter append(char c) Overrides java.io.PrintWriter.append. Implements java.lang.Appendable.append. Doc from java.io.PrintWriter.append. Appends the specified character to this writer. An invocation of this method of the form `out.append(c)` behaves in exactly the same way as the invocation `out.write(c)` out.write(c) Parameters c:char The 16-bit character to append Returns:CodeWriter This writer Annotations @Override

public CodeWriter append(char c)

Overrides java.io.PrintWriter.append.

Implements java.lang.Appendable.append.

Doc from java.io.PrintWriter.append.

Appends the specified character to this writer.

An invocation of this method of the form out.append(c) behaves in exactly the same way as the invocation

out.write(c)

Parameters

c:char: The 16-bit character to append

Returns:CodeWriter

This writer

Annotations

@Override

code back to summary

code	back to summary
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:String the string to print Returns:CodeWriter this object

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:String: the string to print

Returns:CodeWriter

this object

codeln back to summary

codeln	back to summary
public CodeWriter codeln(String line) Print the specified `line` with an indent prefix and end with a new line char. Parameters line:String the line to print Returns:CodeWriter this object

public CodeWriter codeln(String line)

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

Parameters

line:String: the line to print

Returns:CodeWriter

this object

format back to summary

format	back to summary
public CodeWriter format(String format, Object... args) Overrides java.io.PrintWriter.format. Doc from java.io.PrintWriter.format. Writes a formatted string to this writer using the specified format string and arguments. If automatic flushing is enabled, calls to this method will flush the output buffer. The locale always used is the one returned by `Locale.getDefault()`, regardless of any previous invocations of other formatting methods on this object. Parameters format:String A format string as described in Format string syntax. args:Object[] Arguments referenced by the format specifiers in the format string. If there are more arguments than format specifiers, the extra arguments are ignored. The number of arguments is variable and may be zero. The maximum number of arguments is limited by the maximum dimension of a Java array as defined by The Java Virtual Machine Specification. The behaviour on a `null` argument depends on the conversion. Returns:CodeWriter This writer Annotations @Override

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

Overrides java.io.PrintWriter.format.

Doc from java.io.PrintWriter.format.

Writes a formatted string to this writer using the specified format string and arguments. If automatic flushing is enabled, calls to this method will flush the output buffer.

The locale always used is the one returned by Locale.getDefault(), regardless of any previous invocations of other formatting methods on this object.

Parameters

format:String: A format string as described in Format string syntax.
args:Object[]: Arguments referenced by the format specifiers in the format string. If there are more arguments than format specifiers, the extra arguments are ignored. The number of arguments is variable and may be zero. The maximum number of arguments is limited by the maximum dimension of a Java array as defined by The Java Virtual Machine Specification. The behaviour on a null argument depends on the conversion.

Returns:CodeWriter

This writer

Annotations

@Override

format back to summary

format	back to summary
public CodeWriter format(Locale l, String format, Object... args) Overrides java.io.PrintWriter.format. Doc from java.io.PrintWriter.format. Writes a formatted string to this writer using the specified format string and arguments. If automatic flushing is enabled, calls to this method will flush the output buffer. Parameters l:Locale The locale to apply during formatting. If `l` is `null` then no localization is applied. format:String A format string as described in Format string syntax. args:Object[] Arguments referenced by the format specifiers in the format string. If there are more arguments than format specifiers, the extra arguments are ignored. The number of arguments is variable and may be zero. The maximum number of arguments is limited by the maximum dimension of a Java array as defined by The Java Virtual Machine Specification. The behaviour on a `null` argument depends on the conversion. Returns:CodeWriter This writer Annotations @Override

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

Overrides java.io.PrintWriter.format.

Doc from java.io.PrintWriter.format.

Writes a formatted string to this writer using the specified format string and arguments. If automatic flushing is enabled, calls to this method will flush the output buffer.

Parameters

l:Locale: The locale to apply during formatting. If l is null then no localization is applied.
format:String: A format string as described in Format string syntax.
args:Object[]: Arguments referenced by the format specifiers in the format string. If there are more arguments than format specifiers, the extra arguments are ignored. The number of arguments is variable and may be zero. The maximum number of arguments is limited by the maximum dimension of a Java array as defined by The Java Virtual Machine Specification. The behaviour on a null argument depends on the conversion.

Returns:CodeWriter

This writer

Annotations

@Override

indent	back to summary
public CodeWriter indent() Increment the current indentation. Returns:CodeWriter this object

indent

back to summary

public CodeWriter indent()

Increment the current indentation.

Returns:CodeWriter: this object

indentation	back to summary
public String indentation() Returns:String the current indentation string

indented	back to summary
public CodeWriter indented(Runnable block)

indentSize	back to summary
public int indentSize() Returns:int the current indentation size

indentSize back to summary

indentSize	back to summary
public CodeWriter indentSize(int size) Set the current indentation size, this can only be done when the current indentation is `0`. Parameters size:int the new size Returns:CodeWriter this object

public CodeWriter indentSize(int size)

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

Parameters

size:int: the new size

Returns:CodeWriter

this object

javaImport back to summary

javaImport	back to summary
public CodeWriter javaImport(String name) Append the `name` as a java package import. Returns:CodeWriter this object

public CodeWriter javaImport(String name)

Append the name as a java package import.

Returns:CodeWriter: this object

newLine	back to summary
public CodeWriter newLine() Hides java.io.PrintWriter.newLine. Print a new line char. Returns:CodeWriter this object

newLine

back to summary

public CodeWriter newLine()

Hides java.io.PrintWriter.newLine.

Print a new line char.

Returns:CodeWriter: this object

println back to summary

println	back to summary
public void println() Overrides java.io.PrintWriter.println. Doc from java.io.PrintWriter.println. Terminates the current line by writing the line separator string. The line separator is `System#lineSeparator()` and is not necessarily a single newline character (`'\n'`).

public void println()

Overrides java.io.PrintWriter.println.

Doc from java.io.PrintWriter.println.

Terminates the current line by writing the line separator string. The line separator is System#lineSeparator() and is not necessarily a single newline character ('\n').

stmt back to summary

stmt	back to summary
public CodeWriter stmt(String statement) This function prints an indentation before the `statement` and a semicolon followed by a newline after. Parameters statement:String the statement Returns:CodeWriter this object

public CodeWriter stmt(String statement)

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

Parameters

statement:String: the statement

Returns:CodeWriter

this object

unindent	back to summary
public CodeWriter unindent() Decrement the current indentation. Returns:CodeWriter this object

unindent

back to summary

public CodeWriter unindent()

Decrement the current indentation.

Returns:CodeWriter: this object

write	back to summary
public void write(String s, int off, int len) Overrides java.io.PrintWriter.write. Doc from java.io.PrintWriter.write. Writes a portion of a string. Parameters s:String A String off:int Offset from which to start writing characters len:int Number of characters to write Annotations @Override

write

back to summary

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

Overrides java.io.PrintWriter.write.

Doc from java.io.PrintWriter.write.

Writes a portion of a string.

Parameters

s:String: A String
off:int: Offset from which to start writing characters
len:int: Number of characters to write

Annotations

@Override

write	back to summary
public void write(int c) Overrides java.io.PrintWriter.write. Doc from java.io.PrintWriter.write. Writes a single character. Parameters c:int int specifying a character to be written. Annotations @Override

write

back to summary

public void write(int c)

Overrides java.io.PrintWriter.write.

Doc from java.io.PrintWriter.write.

Writes a single character.

Parameters

c:int: int specifying a character to be written.

Annotations

@Override

writer	back to summary
public Writer writer() Returns:Writer the current underlying writer

writeSeq back to summary

writeSeq	back to summary
public CodeWriter writeSeq(Stream<String> sequence, String delimiter) Write a `sequence` delimited by a `delimiter`. Returns:CodeWriter this object

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

Write a sequence delimited by a delimiter.

Returns:CodeWriter: this object

public Class CodeWriter

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail