Package org.tinylog.writers.raw

Class CharsetAdjustmentWriterDecorator

java.lang.Object

org.tinylog.writers.raw.CharsetAdjustmentWriterDecorator

All Implemented Interfaces:

ByteArrayWriter

public class CharsetAdjustmentWriterDecorator
extends Object
implements ByteArrayWriter

Wrapper for skipping charset headers (for example BOM for UTF-16).

Unfortunately, String.getBytes() can add a charset header (like a BOM for UTF-16) for every call. Typically, file based writers call String.getBytes() for each log entry. However, the charset header should only be written only at the start of a log file and not for each log entry.

Constructor Summary

Constructors

Constructor	Description
CharsetAdjustmentWriterDecorator(ByteArrayWriter writer, byte[] charsetHeader)

Method Summary

Modifier and Type	Method	Description
void	close()	Closes this writer and releases any associated system resources.
void	flush()	Forces writing of any buffered data.
int	readTail(byte[] data, int offset, int length)	Reads the last bytes.
void	truncate(int count)	Truncates the file size.
void	write(byte[] data, int length)	Outputs a byte array.
void	write(byte[] data, int offset, int length)	Outputs a byte array.

Methods inherited from class java.lang.Object

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

Constructor Detail

CharsetAdjustmentWriterDecorator

public CharsetAdjustmentWriterDecorator(ByteArrayWriter writer,
                                        byte[] charsetHeader)

Parameters:

writer - Underlying writer

charsetHeader - Charset header to skip

Method Detail

readTail

public int readTail(byte[] data,
                    int offset,
                    int length)
             throws IOException

Description copied from interface: ByteArrayWriter

Reads the last bytes.

The bytes are read from the end of the current file. If the file size is equal to or greater than the passed length, the passed array is filled completely. Otherwise, the passed array is filled with the entire available file content and all remaining bytes of the array are left untouched.

Specified by:

readTail in interface ByteArrayWriter

Parameters:

data - Target byte array for storing the read bytes

offset - Start offset to fill passed byte array

length - Maximum number of bytes to read

Returns:

Number of read bytes

Throws:

IOException - Reading failed

write

public void write(byte[] data,
                  int length)
           throws IOException

Description copied from interface: ByteArrayWriter

Outputs a byte array.

Specified by:

write in interface ByteArrayWriter

Parameters:

data - Byte array to output

length - Number of bytes to output

Throws:

IOException - Writing failed

write

public void write(byte[] data,
                  int offset,
                  int length)
           throws IOException

Description copied from interface: ByteArrayWriter

Outputs a byte array.

Specified by:

write in interface ByteArrayWriter

Parameters:

data - Byte array to output

offset - Start offset to output

length - Number of bytes to output

Throws:

IOException - Writing failed

truncate

public void truncate(int count)
              throws IOException

Description copied from interface: ByteArrayWriter

Truncates the file size.

Specified by:

truncate in interface ByteArrayWriter

Parameters:

count - Number of bytes to remove from the file end

Throws:

IOException - Resizing failed

flush

public void flush()
           throws IOException

Description copied from interface: ByteArrayWriter

Forces writing of any buffered data.

Specified by:

flush in interface ByteArrayWriter

Throws:

IOException - Writing failed

close

public void close()
           throws IOException

Description copied from interface: ByteArrayWriter

Closes this writer and releases any associated system resources.

Specified by:

close in interface ByteArrayWriter

Throws:

IOException - Closing failed