readium-shared/org.readium.r2.shared.util.zip.compress.archivers.zip/ZipArchiveEntry/ExtraFieldParsingMode

ExtraFieldParsingMode

enum ExtraFieldParsingMode : ExtraFieldParsingBehavior

How to try to parse the extra fields.

Configures the behavior for:

What shall happen if the extra field content doesn't follow the recommended pattern of two-byte id followed by a two-byte length?
What shall happen if an extra field is generally supported by Commons Compress but its content cannot be parsed correctly? This may for example happen if the archive is corrupt, it triggers a bug in Commons Compress or the extra field uses a version not (yet) supported by Commons Compress.

Since

1.19

Entries

BEST_EFFORT

Try to parse as many extra fields as possible and wrap unknown extra fields as well as supported extra fields that cannot be parsed in UnrecognizedExtraField.

STRICT_FOR_KNOW_EXTRA_FIELDS

Try to parse as many extra fields as possible and wrap unknown extra fields in UnrecognizedExtraField.

ONLY_PARSEABLE_LENIENT

Try to parse as many extra fields as possible and wrap unknown extra fields as well as supported extra fields that cannot be parsed in UnrecognizedExtraField.

ONLY_PARSEABLE_STRICT

Try to parse as many extra fields as possible and wrap unknown extra fields in UnrecognizedExtraField.

DRACONIC

Throw an exception if any of the recognized extra fields cannot be parsed or any extra field violates the recommended pattern.

Functions

createExtraField

open fun createExtraField(headerId: ZipShort): ZipExtraField

Creates an instance of ZipExtraField for the given id.

fill

open fun fill(field: ZipExtraField, data: Array<Byte>, off: Int, len: Int, local: Boolean): ZipExtraField

Fills in the extra field data for a single extra field.

onUnparseableExtraField

open fun onUnparseableExtraField(data: Array<Byte>, off: Int, len: Int, local: Boolean, claimedLength: Int): ZipExtraField

Decides what to do with extra field data that doesn't follow the recommended pattern.

valueOf

open fun valueOf(name: String): ZipArchiveEntry.ExtraFieldParsingMode

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

values

open fun values(): Array<ZipArchiveEntry.ExtraFieldParsingMode>

Returns an array containing the constants of this enum type, in the order they're declared. This method may be used to iterate over the constants.