net.openhft.chronicle.bytes.internal

Class ByteStringWriter

java.lang.Object

java.io.Writer

net.openhft.chronicle.bytes.internal.ByteStringWriter

All Implemented Interfaces:

Closeable, Flushable, Appendable, AutoCloseable

public class ByteStringWriter
extends Writer

A Writer for an underlying Bytes. This moves the writePosition() up to the writeLimit().

Field Summary

Fields inherited from class java.io.Writer

lock

Constructor Summary

Constructors

Constructor and Description
ByteStringWriter(ByteStringAppender out) Constructs a new ByteStringWriter with the provided ByteStringAppender.

Method Summary

Modifier and Type	Method and Description
@NotNull Writer	append(char c) Appends a single character.
@NotNull Writer	append(@NotNull CharSequence csq) Appends a character sequence.
@NotNull Writer	append(@NotNull CharSequence csq, int start, int end) Appends a portion of a character sequence.
void	close() Closes the writer, flushing it first.
void	flush() Flushes the stream.
void	write(char[] cbuf, int off, int len) Writes a portion of an array of characters.
void	write(int c) Writes a single character.
void	write(@NotNull String str) Writes a string.
void	write(@NotNull String str, int off, int len) Writes a portion of a string.

Methods inherited from class java.io.Writer

write

Methods inherited from class java.lang.Object

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

Constructor Detail

ByteStringWriter

public ByteStringWriter(ByteStringAppender out)

Constructs a new ByteStringWriter with the provided ByteStringAppender.

Parameters:

out - The ByteStringAppender to be used.

Throws:

IllegalStateException - if the input ByteStringAppender is released.

Method Detail

write

public void write(int c)
           throws IOException

Writes a single character.

Overrides:

write in class Writer

Parameters:

c - int specifying a character to be written.

Throws:

IOException - if an I/O error occurs.

write

public void write(@NotNull
                  @NotNull String str)
           throws IOException

Writes a string.

Overrides:

write in class Writer

Parameters:

str - String to be written.

Throws:

IOException - if an I/O error occurs.

write

public void write(@NotNull
                  @NotNull String str,
                  int off,
                  int len)
           throws IOException

Writes a portion of a string.

Overrides:

write in class Writer

Parameters:

str - String to be written.

off - Offset from which to start reading characters.

len - Number of characters to be written.

Throws:

IOException - if an I/O error occurs.

append

@NotNull
public @NotNull Writer append(@NotNull
                                       @NotNull CharSequence csq)
                                throws IOException

Appends a character sequence.

Specified by:

append in interface Appendable

Overrides:

append in class Writer

Parameters:

csq - The character sequence to append.

Returns:

This writer

Throws:

IOException - if an I/O error occurs.

append

@NotNull
public @NotNull Writer append(@NotNull
                                       @NotNull CharSequence csq,
                                       int start,
                                       int end)

Appends a portion of a character sequence.

Specified by:

append in interface Appendable

Overrides:

append in class Writer

Parameters:

csq - The character sequence to append.

start - The index of the first character to append.

end - The index of the character following the last character to append.

Returns:

This writer

append

@NotNull
public @NotNull Writer append(char c)

Appends a single character.

Specified by:

append in interface Appendable

Overrides:

append in class Writer

Parameters:

c - The character to append.

Returns:

This writer

flush

public void 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.

Specified by:

flush in interface Flushable

Specified by:

flush in class Writer

close

public void close()

Closes the writer, flushing it first. Once a writer has been closed, further write() invocations will cause an IOException to be thrown.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Specified by:

close in class Writer

write

public void write(char[] cbuf,
                  int off,
                  int len)
           throws IOException

Writes a portion of an array of characters.

Specified by:

write in class Writer

Parameters:

cbuf - Array of characters.

off - Offset from which to start reading characters.

len - Number of characters to be written.

Throws:

IOException - if an I/O error occurs.