org.eclipse.keyple.calypso.transaction

Class FileHeader

java.lang.Object

org.eclipse.keyple.calypso.transaction.FileHeader

All Implemented Interfaces:

java.io.Serializable

public class FileHeader
extends java.lang.Object
implements java.io.Serializable

This POJO contains all metadata of a Calypso EF.

Since:

0.9

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FileHeader.FileType The EF type enum

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o) Comparison is based on field "lid".
byte[]	getAccessConditions() Gets a reference to the access conditions.
byte	getDfStatus() Gets the DF status.
byte[]	getKeyIndexes() Gets a reference to the keys indexes.
short	getLid() Gets the associated LID.
int	getRecordSize() Gets the size of a record : For a Counter file, the record size is the original size of the record #1. Extra bytes (rest of the division of the file size by 3) aren't accessible.
int	getRecordsNumber() Gets the number of records : For a Counter file, the number of records is always 1. Extra bytes (rest of the division of the file size by 3) aren't accessible.
java.lang.Short	getSharedReference() Gets the shared reference of a shared file.
FileHeader.FileType	getType() Gets the file type.
int	hashCode() Comparison is based on field "lid".
boolean	isShared() Returns true if EF is a shared file.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

getLid

public short getLid()

Gets the associated LID.

Returns:

the LID

Since:

0.9

getRecordsNumber

public int getRecordsNumber()

Gets the number of records :

• For a Counter file, the number of records is always 1.
  Extra bytes (rest of the division of the file size by 3) aren't accessible.
• For a Binary file, the number of records is always 1.

Returns:

the number of records

Since:

0.9

getRecordSize

public int getRecordSize()

Gets the size of a record :

• For a Counter file, the record size is the original size of the record #1.
  Extra bytes (rest of the division of the file size by 3) aren't accessible.
• For a Binary file, the size of the record is corresponding to the file size.

Returns:

the size of a record

Since:

0.9

getType

public FileHeader.FileType getType()

Gets the file type.

Returns:

a not null file type

Since:

0.9

getAccessConditions

public byte[] getAccessConditions()

Gets a reference to the access conditions.

Returns:

a not empty byte array reference

Since:

0.9

getKeyIndexes

public byte[] getKeyIndexes()

Gets a reference to the keys indexes.

Returns:

a not empty byte array reference

Since:

0.9

getDfStatus

public byte getDfStatus()

Gets the DF status.

Returns:

the DF status byte

Since:

0.9

isShared

public boolean isShared()

Returns true if EF is a shared file.

Returns:

true if the EF is a shared file

Since:

0.9

getSharedReference

public java.lang.Short getSharedReference()

Gets the shared reference of a shared file.

Returns:

null if file is not shared

Since:

0.9

equals

public boolean equals(java.lang.Object o)

Comparison is based on field "lid".

Overrides:

equals in class java.lang.Object

Parameters:

o - the object to compare

Returns:

the comparison evaluation

Since:

0.9

hashCode

public int hashCode()

Comparison is based on field "lid".

Overrides:

hashCode in class java.lang.Object

Returns:

the hashcode

Since:

0.9

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object