Interface FileHeader


public interface FileHeader
Calypso EF metadata.
Since:
1.0.0
  • Method Summary

    Modifier and Type
    Method
    Description
    byte[]
    Gets a reference to the access conditions.
    Gets the DF status.
    Gets the Elementary File type.
    byte[]
    Gets a reference to the keys indexes.
    short
    Gets the associated LID.
    int
    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
    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.
    Gets the non-zero unique identifier of the shared data when the file data is shared.
  • Method Details

    • getLid

      short getLid()
      Gets the associated LID.
      Returns:
      The LID.
      Since:
      1.0.0
    • getDfStatus

      Byte getDfStatus()
      Gets the DF status.
      Returns:
      Null if the status is not available (e.g. when the FileHeader is created following the response to a "Get Data" command with the GetDataTag.EF_LIST tag).
      Since:
      1.0.0
    • getEfType

      ElementaryFile.Type getEfType()
      Gets the Elementary File type.
      Returns:
      A non-null file type.
      Since:
      1.0.0
    • getRecordsNumber

      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:
      1.0.0
    • getRecordSize

      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:
      1.0.0
    • getAccessConditions

      byte[] getAccessConditions()
      Gets a reference to the access conditions.
      Returns:
      An empty array if the access conditions are not available (e.g. when the FileHeader is created following the response to a "Get Data" command with the GetDataTag.EF_LIST tag).
      Since:
      1.0.0
    • getKeyIndexes

      byte[] getKeyIndexes()
      Gets a reference to the keys indexes.
      Returns:
      An empty array if the key indexes are not available (e.g. when the FileHeader is created following the response to a "Get Data" command with the GetDataTag.EF_LIST tag).
      Since:
      1.0.0
    • getSharedReference

      Short getSharedReference()
      Gets the non-zero unique identifier of the shared data when the file data is shared.
      Returns:
      Zero if the file data is not shared or null if the information is not available (e.g. when the FileHeader is created following the response to a "Get Data" command with the GetDataTag.EF_LIST tag).
      Since:
      1.0.0