class RecordHeaderParserFixedLen extends Serializable with RecordHeaderParser
This is a parser for fixed length record files.
- Alphabetic
- By Inheritance
- RecordHeaderParserFixedLen
- RecordHeaderParser
- Serializable
- Serializable
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Instance Constructors
- new RecordHeaderParserFixedLen(recordSize: Int, fileHeaderBytes: Int, fileFooterBytes: Int)
Value Members
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
def
clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
def
getHeaderLength: Int
This type of files do not have record headers
This type of files do not have record headers
- Definition Classes
- RecordHeaderParserFixedLen → RecordHeaderParser
-
def
getRecordMetadata(header: Array[Byte], fileOffset: Long, maxOffset: Long, fileSize: Long, recordNum: Long): RecordMetadata
Given a raw values of a record header returns metadata sufficient to parse the record.
Given a raw values of a record header returns metadata sufficient to parse the record.
- header
A record header as an array of bytes
- fileOffset
An offset from the beginning of the underlying file
- maxOffset
A maximum offset allowed to read by the current index chunk
- fileSize
A size of the underlying file
- recordNum
A sequential record number
- returns
A parsed record metadata
- Definition Classes
- RecordHeaderParserFixedLen → RecordHeaderParser
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
def
isHeaderDefinedInCopybook: Boolean
If true the record parser will expect record headers to be defined in the copybook itself.
If true the record parser will expect record headers to be defined in the copybook itself. If false the headers are not expected to be defined in the copybook and the number of bytes returned by
getHeaderLengthwill be truncated before record bytes are passed to the parser.- Definition Classes
- RecordHeaderParserFixedLen → RecordHeaderParser
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
def
onReceiveAdditionalInfo(additionalInfo: String): Unit
Clients of 'spark-cobol' can pass additional information to custom record header parsers using
Clients of 'spark-cobol' can pass additional information to custom record header parsers using
.option("rhp_additional_info", "...anything as a string...")If a client provides any additional info the method will be executed just after constructing the record header parser.
Built-in record header parsers ignore the additional info. This info string is intended for custom record header parsers.
- additionalInfo
A string provided by a client for the record header parser.
- Definition Classes
- RecordHeaderParser
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
toString(): String
- Definition Classes
- AnyRef → Any
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()