Vert.x Docgen 3.5.1 · io.vertx.docgen.DocWriter · APIdia, the JavaDoc alternative

Modifier and Type	Field and Description
private final List<Object>	chunks
private final StringBuilder	delegate
private boolean	literal
private int	status

Access	Constructor and Description
pack-priv	DocWriter()

Method Summary

Modifier and Type	Method and Description
public DocWriter	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.Writer.append. Implements java.lang.Appendable.append. Appends the specified character sequence to this writer.
public DocWriter	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.Writer.append. Implements java.lang.Appendable.append. Appends a subsequence of the specified character sequence to this writer.
public DocWriter	append(char The 16-bit character to append c) Overrides java.io.Writer.append. Implements java.lang.Appendable.append. Appends the specified character to this writer.
public void	close() Implements abstract java.io.Writer.close. Implements java.io.Closeable.close. Closes the stream, flushing it first.
pack-priv void	commentMode() Switch to comment mode: after a `\n` char, the first space is skipped.
pack-priv void	exec(Runnable r)
public void	flush() Implements abstract java.io.Writer.flush. Implements java.io.Flushable.flush. Flushes the stream.
pack-priv void	literalMode() Switch the write to literal mode: appended text is added as is.
pack-priv String	render()
private void	render(StringBuilder buffer)
pack-priv void	resetParagraph()
pack-priv void	write(Supplier<DocWriter> future)
public void	write(int int specifying a character to be written c) Overrides java.io.Writer.write. Writes a single character.
public void	write(char[] Array of characters to be written cbuf) Overrides java.io.Writer.write. Writes an array of characters.
public void	write(String String to be written str) Overrides java.io.Writer.write. Writes a string.
public void	write(String A String str, int Offset from which to start writing characters off, int Number of characters to write len) Overrides java.io.Writer.write. Writes a portion of a string.
public void	write(char[] Array of characters cbuf, int Offset from which to start writing characters off, int Number of characters to write len) Implements abstract java.io.Writer.write. Writes a portion of an array of characters.

Inherited from java.io.Writer:: nullWriter

chunks	back to summary
private final List<Object> chunks

delegate	back to summary
private final StringBuilder delegate

literal	back to summary
private boolean literal

status	back to summary
private int status

DocWriter	back to summary
pack-priv DocWriter()

Method Detail

append back to summary

append	back to summary
public DocWriter append(CharSequence csq) Overrides java.io.Writer.append. Implements java.lang.Appendable.append. Doc from java.io.Writer.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:DocWriter This writer Annotations @Override

public DocWriter append(CharSequence csq)

Overrides java.io.Writer.append.

Implements java.lang.Appendable.append.

Doc from java.io.Writer.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:DocWriter

This writer

Annotations

@Override

append back to summary

append	back to summary
public DocWriter append(CharSequence csq, int start, int end) Overrides java.io.Writer.append. Implements java.lang.Appendable.append. Doc from java.io.Writer.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:DocWriter This writer Annotations @Override

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

Overrides java.io.Writer.append.

Implements java.lang.Appendable.append.

Doc from java.io.Writer.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:DocWriter

This writer

Annotations

@Override

append back to summary

append	back to summary
public DocWriter append(char c) Overrides java.io.Writer.append. Implements java.lang.Appendable.append. Doc from java.io.Writer.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:DocWriter This writer Annotations @Override

public DocWriter append(char c)

Overrides java.io.Writer.append.

Implements java.lang.Appendable.append.

Doc from java.io.Writer.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:DocWriter

This writer

Annotations

@Override

close	back to summary
public void close() throws IOException Implements abstract java.io.Writer.close. Implements java.io.Closeable.close. Doc from java.io.Writer.close. Closes the stream, flushing it first. Once the stream has been closed, further write() or flush() invocations will cause an IOException to be thrown. Closing a previously closed stream has no effect. Annotations @Override Exceptions IOException: If an I/O error occurs

back to summary

public void close() throws IOException

Implements abstract java.io.Writer.close.

Implements java.io.Closeable.close.

Doc from java.io.Writer.close.

Closes the stream, flushing it first. Once the stream has been closed, further write() or flush() invocations will cause an IOException to be thrown. Closing a previously closed stream has no effect.

Annotations

@Override

Exceptions

IOException:: If an I/O error occurs

commentMode	back to summary
pack-priv void commentMode() Switch to comment mode: after a `\n` char, the first space is skipped. This is needed because the javadoc text we obtain adds an extra space, except for the first time.

exec	back to summary
pack-priv void exec(Runnable r)

flush	back to summary
public void flush() throws IOException Implements abstract java.io.Writer.flush. Implements java.io.Flushable.flush. Doc from java.io.Writer.flush. Flushes the stream. If the stream has saved any characters from the various write() methods in a buffer, write them immediately to their intended destination. Then, if that destination is another character or byte stream, flush it. Thus one flush() invocation will flush all the buffers in a chain of Writers and OutputStreams. If the intended destination of this stream is an abstraction provided by the underlying operating system, for example a file, then flushing the stream guarantees only that bytes previously written to the stream are passed to the operating system for writing; it does not guarantee that they are actually written to a physical device such as a disk drive. Annotations @Override Exceptions IOException: If an I/O error occurs

flush

back to summary

public void flush() throws IOException

Implements abstract java.io.Writer.flush.

Implements java.io.Flushable.flush.

Doc from java.io.Writer.flush.

Flushes the stream. If the stream has saved any characters from the various write() methods in a buffer, write them immediately to their intended destination. Then, if that destination is another character or byte stream, flush it. Thus one flush() invocation will flush all the buffers in a chain of Writers and OutputStreams.

If the intended destination of this stream is an abstraction provided by the underlying operating system, for example a file, then flushing the stream guarantees only that bytes previously written to the stream are passed to the operating system for writing; it does not guarantee that they are actually written to a physical device such as a disk drive.

Annotations

@Override

Exceptions

IOException:: If an I/O error occurs

literalMode	back to summary
pack-priv void literalMode() Switch the write to literal mode: appended text is added as is.

render	back to summary
pack-priv String render()

render	back to summary
private void render(StringBuilder buffer)

resetParagraph	back to summary
pack-priv void resetParagraph()

write	back to summary
pack-priv void write(Supplier<DocWriter> future)

write	back to summary
public void write(int c) Overrides java.io.Writer.write. Doc from java.io.Writer.write. Writes a single character. The character to be written is contained in the 16 low-order bits of the given integer value; the 16 high-order bits are ignored. Subclasses that intend to support efficient single-character output should override this method. Parameters c:int int specifying a character to be written Annotations @Override

write

back to summary

public void write(int c)

Overrides java.io.Writer.write.

Doc from java.io.Writer.write.

Writes a single character. The character to be written is contained in the 16 low-order bits of the given integer value; the 16 high-order bits are ignored.

Subclasses that intend to support efficient single-character output should override this method.

Parameters

c:int: int specifying a character to be written

Annotations

@Override

write	back to summary
public void write(char[] cbuf) Overrides java.io.Writer.write. Doc from java.io.Writer.write. Writes an array of characters. Parameters cbuf:char[] Array of characters to be written Annotations @Override

write

back to summary

public void write(char[] cbuf)

Overrides java.io.Writer.write.

Doc from java.io.Writer.write.

Writes an array of characters.

Parameters

cbuf:char[]: Array of characters to be written

Annotations

@Override

write	back to summary
public void write(String str) Overrides java.io.Writer.write. Doc from java.io.Writer.write. Writes a string. Parameters str:String String to be written Annotations @Override

write

back to summary

public void write(String str)

Overrides java.io.Writer.write.

Doc from java.io.Writer.write.

Writes a string.

Parameters

str:String: String to be written

Annotations

@Override

write	back to summary
public void write(String str, int off, int len) Overrides java.io.Writer.write. Doc from java.io.Writer.write. Writes a portion of a string. Parameters str: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 str, int off, int len)

Overrides java.io.Writer.write.

Doc from java.io.Writer.write.

Writes a portion of a string.

Parameters

str: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(char[] cbuf, int off, int len) Implements abstract java.io.Writer.write. Doc from java.io.Writer.write. Writes a portion of an array of characters. Parameters cbuf:char[] Array of characters 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(char[] cbuf, int off, int len)

Implements abstract java.io.Writer.write.

Doc from java.io.Writer.write.

Writes a portion of an array of characters.

Parameters

cbuf:char[]: Array of characters
off:int: Offset from which to start writing characters
len:int: Number of characters to write

Annotations

@Override

pack-priv Class DocWriter

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail