org.waarp.common.file

Class DataBlock

java.lang.Object

org.waarp.common.file.DataBlock

public class DataBlock
extends Object

Main object implementing Data Block whaveter the mode, type, structure used.

Constructor Summary

Constructors

Constructor and Description
DataBlock() Create a simple and empty DataBlock

Method Summary

Modifier and Type	Method and Description
void	addOffset(int offset) Increase the offset position
void	clear() Clear the object
io.netty.buffer.ByteBuf	getBlock() Deprecated. method, prefer getByteBlock()
byte[]	getByteBlock()
int	getByteCount()
byte	getByteCountLower()
byte	getByteCountUpper()
byte[]	getByteMarkers()
byte	getDescriptor()
int[]	getMarkers()
int	getOffset()
boolean	isCleared() Is this Block cleared
boolean	isEOF()
boolean	isEOR()
boolean	isERROR()
boolean	isRESTART()
void	setBlock(byte[] block) Set the block and the byte count according to the block
void	setBlock(byte[] block, int size) Set the block and the byte count
void	setBlock(io.netty.buffer.ByteBuf block) Set the block and the byte count according to the block
void	setByteCount(byte upper, byte lower)
void	setByteCount(int byteCount)
void	setDescriptor(int descriptor)
void	setEOF(boolean isEOF)
void	setEOR(boolean isEOR)
void	setERROR(boolean isERROR)
void	setMarkers(int[] markers) Set the markers and the byte count
void	setRESTART(boolean isRESTART)
static String	toBinaryString(byte[] bytes, boolean cutted) Translate the given array of byte into a string in binary format
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

DataBlock

public DataBlock()

Create a simple and empty DataBlock

Method Detail

getBlock

@Deprecated
public final io.netty.buffer.ByteBuf getBlock()

Deprecated. method, prefer getByteBlock()

Returns:

the block

getByteBlock

public final byte[] getByteBlock()

Returns:

the block

getOffset

public final int getOffset()

Returns:

the offset of the ByteBlock

addOffset

public final void addOffset(int offset)

Increase the offset position

Parameters:

offset -

setBlock

public final void setBlock(io.netty.buffer.ByteBuf block)

Set the block and the byte count according to the block

Parameters:

block - the block to set

setBlock

public final void setBlock(byte[] block)

Set the block and the byte count according to the block

Parameters:

block - the block to set

setBlock

public final void setBlock(byte[] block,
                           int size)

Set the block and the byte count

Parameters:

block - the block to set

size - the real size to set

getByteCount

public final int getByteCount()

Returns:

the byteCount

setByteCount

public final void setByteCount(int byteCount)

Parameters:

byteCount - the byteCount to set

setByteCount

public final void setByteCount(byte upper,
                               byte lower)

Parameters:

upper - upper byte of the 2 bytes length

lower - lower byte of the 2 bytes length

getByteCountUpper

public final byte getByteCountUpper()

Returns:

the Upper byte of the byte count

getByteCountLower

public final byte getByteCountLower()

Returns:

the Lower byte of the byte count

getDescriptor

public final byte getDescriptor()

Returns:

the descriptor

setDescriptor

public final void setDescriptor(int descriptor)

Parameters:

descriptor - the descriptor to set

isEOF

public final boolean isEOF()

Returns:

the isEOF

setEOF

public final void setEOF(boolean isEOF)

Parameters:

isEOF - the isEOF to set

isEOR

public final boolean isEOR()

Returns:

the isEOR

setEOR

public final void setEOR(boolean isEOR)

Parameters:

isEOR - the isEOR to set

isERROR

public final boolean isERROR()

Returns:

the isERROR

setERROR

public final void setERROR(boolean isERROR)

Parameters:

isERROR - the isERROR to set

isRESTART

public final boolean isRESTART()

Returns:

the isRESTART

setRESTART

public final void setRESTART(boolean isRESTART)

Parameters:

isRESTART - the isRESTART to set

getMarkers

public final int[] getMarkers()

Returns:

the markers

getByteMarkers

public final byte[] getByteMarkers()

Returns:

the 6 bytes representation of the markers

setMarkers

public final void setMarkers(int[] markers)

Set the markers and the byte count

Parameters:

markers - the markers to set

clear

public final void clear()

Clear the object

isCleared

public final boolean isCleared()

Is this Block cleared

Returns:

True if this Block is cleared

toString

public String toString()

Overrides:

toString in class Object

toBinaryString

public static String toBinaryString(byte[] bytes,
                                    boolean cutted)

Translate the given array of byte into a string in binary format

Parameters:

bytes -

cutted - True if each Byte should be 'blank' separated or not

Returns:

the string