Field Detail

• NO_HEADER_END

  public static final long NO_HEADER_END

  The value of the headerEnd field when there's no header

  See Also:

  Constant Field Values

• EMPTY_HEADER

  public static final FeatureCodecHeader EMPTY_HEADER

  A public instance representing no header

Constructor Detail

• FeatureCodecHeader

  public FeatureCodecHeader​(Object headerValue,
                            long headerEnd)

  Create a FeatureCodecHeader indicating the contents of the header (can be null) and the byte position in the file where the header ends (not inclusive). headerEnd should be NO_HEADER_END when no header is present.

  Parameters:

  headerValue - the header data read by the codec

  headerEnd - the position (not inclusive) of the end of the header. 1 would mean just the first byte of the file is the header. Zero indicates there's no header at all

Method Detail

• getHeaderValue

  public Object getHeaderValue()

  Returns:

  the header value provided by the codec for this file

• getHeaderEnd

  public long getHeaderEnd()

  Returns:

  to position, not inclusive, where the header ends. Must be >= 0

• skipHeaderBytes

  public boolean skipHeaderBytes()

  Returns:

  true if we should skip some bytes to skip this header