Package net.sf.sevenzipjbinding

Enum Class ReportExtractResultIndexType

java.lang.Object

java.lang.Enum<ReportExtractResultIndexType>

net.sf.sevenzipjbinding.ReportExtractResultIndexType

All Implemented Interfaces:

Serializable, Comparable<ReportExtractResultIndexType>, Constable

public enum ReportExtractResultIndexType
extends Enum<ReportExtractResultIndexType>

Index type parameter for IArchiveExtractCallback.reportExtractResult(ReportExtractResultIndexType, int, ExtractOperationResult). This enum corresponds to 7-zip's NEventIndexType namespace and indicates what kind of index is being reported in extract result callbacks.

Since:

23.01-2.2

Author:

Boris Brodski

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
BLOCK_INDEX	Block index.
IN_ARCHIVE_INDEX	Index in the input (source) archive.
NO_INDEX	No index available or applicable.
OUT_ARCHIVE_INDEX	Index in the output (destination) archive.

Method Summary

Modifier and Type	Method	Description
static ReportExtractResultIndexType	getIndexType(int index)	Convert an integer index to its corresponding enumeration value.
static ReportExtractResultIndexType	valueOf(String name)	Returns the enum constant of this class with the specified name.
static ReportExtractResultIndexType[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, describeConstable, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

NO_INDEX

public static final ReportExtractResultIndexType NO_INDEX

No index available or applicable.

IN_ARCHIVE_INDEX

public static final ReportExtractResultIndexType IN_ARCHIVE_INDEX

Index in the input (source) archive. Used when reporting errors for specific files within the archive being extracted.

BLOCK_INDEX

public static final ReportExtractResultIndexType BLOCK_INDEX

Block index. Used for multi-volume or compressed block-level operations.

OUT_ARCHIVE_INDEX

public static final ReportExtractResultIndexType OUT_ARCHIVE_INDEX

Index in the output (destination) archive. Less commonly used.

Method Details

values

public static ReportExtractResultIndexType[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static ReportExtractResultIndexType valueOf(String name)

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

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

getIndexType

public static ReportExtractResultIndexType getIndexType(int index)

Convert an integer index to its corresponding enumeration value.

Parameters:

index - the integer index (typically from 7-zip native code)

Returns:

the corresponding ReportExtractResultIndexType, or NO_INDEX if out of range