org.apache.commons.compress.archivers.sevenz

Class SevenZFileOptions

java.lang.Object

org.apache.commons.compress.archivers.sevenz.SevenZFileOptions

public class SevenZFileOptions
extends java.lang.Object

Collects options for reading 7z archives.

Since:

1.19

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SevenZFileOptions.Builder Mutable builder for the immutable SevenZFileOptions.

Field Summary

Fields

Modifier and Type	Field and Description
private static int	DEFAUL_MEMORY_LIMIT_IN_KB
static SevenZFileOptions	DEFAULT The default options.
private static boolean	DEFAULT_USE_DEFAULTNAME_FOR_UNNAMED_ENTRIES
private int	maxMemoryLimitInKb
private boolean	useDefaultNameForUnnamedEntries

Constructor Summary

Constructors

Modifier	Constructor and Description
private	SevenZFileOptions(int maxMemoryLimitInKb, boolean useDefaultNameForUnnamedEntries)

Method Summary

Modifier and Type	Method and Description
static SevenZFileOptions.Builder	builder() Obtains a builder for SevenZFileOptions.
int	getMaxMemoryLimitInKb() Gets the maximum amount of memory to use for extraction.
boolean	getUseDefaultNameForUnnamedEntries() Gets whether entries without a name should get their names set to the archive's default file name.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DEFAUL_MEMORY_LIMIT_IN_KB

private static final int DEFAUL_MEMORY_LIMIT_IN_KB

See Also:

Constant Field Values

DEFAULT_USE_DEFAULTNAME_FOR_UNNAMED_ENTRIES

private static final boolean DEFAULT_USE_DEFAULTNAME_FOR_UNNAMED_ENTRIES

See Also:

Constant Field Values

maxMemoryLimitInKb

private final int maxMemoryLimitInKb

useDefaultNameForUnnamedEntries

private final boolean useDefaultNameForUnnamedEntries

DEFAULT

public static final SevenZFileOptions DEFAULT

The default options.

• no memory limit
• don't modifiy the name of unnamed entries

Constructor Detail

SevenZFileOptions

private SevenZFileOptions(int maxMemoryLimitInKb,
                          boolean useDefaultNameForUnnamedEntries)

Method Detail

builder

public static SevenZFileOptions.Builder builder()

Obtains a builder for SevenZFileOptions.

Returns:

a builder for SevenZFileOptions.

getMaxMemoryLimitInKb

public int getMaxMemoryLimitInKb()

Gets the maximum amount of memory to use for extraction. Not all codecs will honor this setting. Currently only lzma and lzma2 are supported.

Returns:

the maximum amount of memory to use for extraction

getUseDefaultNameForUnnamedEntries

public boolean getUseDefaultNameForUnnamedEntries()

Gets whether entries without a name should get their names set to the archive's default file name.

Returns:

whether entries without a name should get their names set to the archive's default file name