com.asakusafw.runtime.stage.temporary

Class TemporaryFile

java.lang.Object

com.asakusafw.runtime.stage.temporary.TemporaryFile

public final class TemporaryFile
extends Object

Utilities for temporary files.

Since:

0.7.0

Field Summary

Fields

Modifier and Type	Field and Description
static int	BLOCK_SIZE The block size.
static int	EMPTY_ENTRY_PADDING The padding byte for empty entries.
static int	MAX_PAGE_SIZE The maximum page size.
static int	PAGE_HEADER_EOB The page header value which represents END_OF_BLOCK.
static int	PAGE_HEADER_EOF The page header value which represents END_OF_FILE.
static int	PAGE_HEADER_SIZE The page header size.

Method Summary

Modifier and Type	Method and Description
static boolean	canWritePage(int positionInBlock, int length) Returns whether clients can write a content page into the current block.
static int	readBlockHeader(InputStream input) Reads and verifies the block header.
static int	readPageHeader(InputStream input) Reads a page header from the head of the stream.
static int	readString(InputStream input, Appendable appendable) Reads a string into appendable.
static int	writeBlockHeader(OutputStream output) Writes a block header.
static void	writeContentPageMark(OutputStream output, int length) Writes a content page header.
static void	writeEndOfBlockMark(OutputStream output) Writes an end-of-block header.
static int	writeString(OutputStream output, String string) Writes a string.

Methods inherited from class java.lang.Object

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

Field Detail

BLOCK_SIZE

public static final int BLOCK_SIZE

The block size.

See Also:

Constant Field Values

PAGE_HEADER_SIZE

public static final int PAGE_HEADER_SIZE

The page header size.

See Also:

Constant Field Values

PAGE_HEADER_EOB

public static final int PAGE_HEADER_EOB

The page header value which represents END_OF_BLOCK.

See Also:

Constant Field Values

PAGE_HEADER_EOF

public static final int PAGE_HEADER_EOF

The page header value which represents END_OF_FILE.

See Also:

Constant Field Values

EMPTY_ENTRY_PADDING

public static final int EMPTY_ENTRY_PADDING

The padding byte for empty entries.

See Also:

Constant Field Values

MAX_PAGE_SIZE

public static final int MAX_PAGE_SIZE

The maximum page size.

See Also:

Constant Field Values

Method Detail

writeBlockHeader

public static int writeBlockHeader(OutputStream output)
                            throws IOException

Writes a block header.

Parameters:

output - the target output

Returns:

the bytes written

Throws:

IOException - if failed to write

readBlockHeader

public static int readBlockHeader(InputStream input)
                           throws IOException

Reads and verifies the block header.

Parameters:

input - the target input

Returns:

the bytes read

Throws:

IOException - if failed to read

writeString

public static int writeString(OutputStream output,
                              String string)
                       throws IOException

Writes a string.

Parameters:

output - the target output

string - the contents

Returns:

the bytes written

Throws:

IOException - if failed to write

readString

public static int readString(InputStream input,
                             Appendable appendable)
                      throws IOException

Reads a string into appendable.

Parameters:

input - the target input

appendable - the target appendable

Returns:

the bytes read

Throws:

IOException - if failed to read

canWritePage

public static boolean canWritePage(int positionInBlock,
                                   int length)

Returns whether clients can write a content page into the current block.

Parameters:

positionInBlock - the byte position in the current block

length - the content length in bytes

Returns:

true if clients can write a content page into the current block, otherwise false

writeContentPageMark

public static void writeContentPageMark(OutputStream output,
                                        int length)
                                 throws IOException

Writes a content page header.

Parameters:

output - the target output stream

length - the content length

Throws:

IOException - if failed to write a page header by I/O error

writeEndOfBlockMark

public static void writeEndOfBlockMark(OutputStream output)
                                throws IOException

Writes an end-of-block header.

Parameters:

output - the target output stream

Throws:

IOException - if failed to write a page header by I/O error

readPageHeader

public static int readPageHeader(InputStream input)
                          throws IOException

Reads a page header from the head of the stream.

Parameters:

input - the target input stream

Returns:

the page header

Throws:

IOException - if failed to read a page header

See Also:

MAX_PAGE_SIZE, PAGE_HEADER_EOB, PAGE_HEADER_EOF