com.healthmarketscience.jackcess.impl

Class DefaultCodecProvider.DummyHandler

java.lang.Object

com.healthmarketscience.jackcess.impl.DefaultCodecProvider.DummyHandler

All Implemented Interfaces:

CodecHandler

Enclosing class:

DefaultCodecProvider

public static class DefaultCodecProvider.DummyHandler
extends java.lang.Object
implements CodecHandler

CodecHandler implementation which does nothing, useful for databases with no extra encoding.

Constructor Summary

Constructors

Constructor and Description
DummyHandler()

Method Summary

Modifier and Type	Method and Description
boolean	canDecodeInline() Returns true if this handler can decode a page inline, false otherwise.
boolean	canEncodePartialPage() Returns true if this handler can encode partial pages, false otherwise.
void	decodePage(java.nio.ByteBuffer inPage, java.nio.ByteBuffer outPage, int pageNumber) Decodes the given page buffer.
java.nio.ByteBuffer	encodePage(java.nio.ByteBuffer page, int pageNumber, int pageOffset) Encodes the given page buffer into a new page buffer and returns it.

Methods inherited from class java.lang.Object

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

Constructor Detail

DummyHandler

public DummyHandler()

Method Detail

canEncodePartialPage

public boolean canEncodePartialPage()

Description copied from interface: CodecHandler

Returns true if this handler can encode partial pages, false otherwise. If this method returns false, the CodecHandler.encodePage(java.nio.ByteBuffer, int, int) method will never be called with a non-zero pageOffset.

Specified by:

canEncodePartialPage in interface CodecHandler

canDecodeInline

public boolean canDecodeInline()

Description copied from interface: CodecHandler

Returns true if this handler can decode a page inline, false otherwise. If this method returns false, the CodecHandler.decodePage(java.nio.ByteBuffer, java.nio.ByteBuffer, int) method will always be called with separate buffers.

Specified by:

canDecodeInline in interface CodecHandler

decodePage

public void decodePage(java.nio.ByteBuffer inPage,
                       java.nio.ByteBuffer outPage,
                       int pageNumber)
                throws java.io.IOException

Description copied from interface: CodecHandler

Decodes the given page buffer.

Specified by:

decodePage in interface CodecHandler

Parameters:

inPage - the page to be decoded

outPage - the decoded page. if CodecHandler.canDecodeInline() is true, this will be the same buffer as inPage.

pageNumber - the page number of the given page

Throws:

java.io.IOException - if an exception occurs during decoding

encodePage

public java.nio.ByteBuffer encodePage(java.nio.ByteBuffer page,
                                      int pageNumber,
                                      int pageOffset)
                               throws java.io.IOException

Description copied from interface: CodecHandler

Encodes the given page buffer into a new page buffer and returns it. The returned page buffer will be used immediately and discarded so that it may be re-used for subsequent page encodings.

Specified by:

encodePage in interface CodecHandler

Parameters:

page - the page to be encoded, should not be modified

pageNumber - the page number of the given page

pageOffset - offset within the page at which to start writing the page data

Returns:

the properly encoded page buffer for the given page buffer

Throws:

java.io.IOException - if an exception occurs during decoding