org.egothor.robot.escape

Class SimpleEscape

java.lang.Object

org.egothor.robot.escape.SimpleEscape

All Implemented Interfaces:

Escape

Direct Known Subclasses:

RotateEscape

public class SimpleEscape
extends Object
implements Escape

Author:

galambos

Field Summary

Fields

Modifier and Type	Field and Description
static byte	COMMIT
static byte	DATA
static byte	DROP
static byte	NEW

Constructor Summary

Constructors

Constructor and Description
SimpleEscape(String filename, boolean append) Creates a new instance of SimpleEscape

Method Summary

Modifier and Type	Method and Description
void	commit(long handle) The previous blocks saved by Escape.save(long, java.lang.String, java.lang.String, java.nio.ByteBuffer) method should be commited.
void	drop(long handle) The previous blocks saved by Escape.save(long, java.lang.String, java.lang.String, java.nio.ByteBuffer) method should be forgotten.
long	save(long handle, ByteBuffer buf) Save the consequent buffer related to a stream of the key.
long	save(long id, String key, String contentType, ByteBuffer buf) Save the very first buffer related to a stream of the key.
void	shutdown() Closes (shuts down) this interface.

Methods inherited from class java.lang.Object

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

Field Detail

COMMIT

public static final byte COMMIT

See Also:

Constant Field Values

DROP

public static final byte DROP

See Also:

Constant Field Values

DATA

public static final byte DATA

See Also:

Constant Field Values

NEW

public static final byte NEW

See Also:

Constant Field Values

Constructor Detail

SimpleEscape

public SimpleEscape(String filename,
                    boolean append)
             throws IOException

Creates a new instance of SimpleEscape

Throws:

IOException

Method Detail

save

public long save(long id,
                 String key,
                 String contentType,
                 ByteBuffer buf)
          throws IOException

Description copied from interface: Escape

Save the very first buffer related to a stream of the key. It clears the buffer on a successful operation.

Specified by:

save in interface Escape

Throws:

IOException

save

public long save(long handle,
                 ByteBuffer buf)
          throws IOException

Description copied from interface: Escape

Save the consequent buffer related to a stream of the key. It clears the buffer on a successful operation.

Specified by:

save in interface Escape

Returns:

the original handle for your convinience

Throws:

IOException

drop

public void drop(long handle)
          throws IOException

Description copied from interface: Escape

The previous blocks saved by Escape.save(long, java.lang.String, java.lang.String, java.nio.ByteBuffer) method should be forgotten.

Specified by:

drop in interface Escape

Throws:

IOException

commit

public void commit(long handle)
            throws IOException

Description copied from interface: Escape

The previous blocks saved by Escape.save(long, java.lang.String, java.lang.String, java.nio.ByteBuffer) method should be commited.

Specified by:

commit in interface Escape

Throws:

IOException

shutdown

public void shutdown()

Description copied from interface: Escape

Closes (shuts down) this interface.

Specified by:

shutdown in interface Escape