Top Description Fields Constructors Methods
org.apache.commons.compress.archivers.sevenz

public Class SevenZMethodConfiguration

extends Object
Class Inheritance
Imports
java.util.Objects

Combines a SevenZMethod with configuration options for the method.

The exact type and interpretation of options depends on the method being configured. Currently supported are:

Options
Method Option Type Description
BZIP2 Number Block Size - an number between 1 and 9
DEFLATE Number Compression Level - an number between 1 and 9
LZMA2 Number Dictionary Size - a number between 4096 and 768 MiB (768 << 20)
LZMA2 org.tukaani.xz.LZMA2Options Whole set of LZMA2 options.
DELTA_FILTER Number Delta Distance - a number between 1 and 256
Since
1.8

Field Summary

Modifier and TypeField and Description
private final SevenZMethod
private final Object

Constructor Summary

AccessConstructor and Description
public
SevenZMethodConfiguration(final SevenZMethod
the method to use
method
)

Doesn't configure any additional options.

public
SevenZMethodConfiguration(final SevenZMethod
the method to use
method
,
final Object
the options to use
options
)

Specifies and method plus configuration options.

Method Summary

Modifier and TypeMethod and Description
public boolean
equals(final Object
the reference object with which to compare.
obj
)

Overrides java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.
public SevenZMethod

Returns:

the method
getMethod
()

The specified method.

public Object

Returns:

the options
getOptions
()

The specified options.

public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for the object.
Inherited from java.lang.Object:
clonefinalizegetClassnotifynotifyAlltoStringwaitwaitwait

Field Detail

methodback to summary
private final SevenZMethod method
optionsback to summary
private final Object options

Constructor Detail

SevenZMethodConfigurationback to summary
public SevenZMethodConfiguration(final SevenZMethod method)

Doesn't configure any additional options.

Parameters
method:SevenZMethod

the method to use

SevenZMethodConfigurationback to summary
public SevenZMethodConfiguration(final SevenZMethod method, final Object options)

Specifies and method plus configuration options.

Parameters
method:SevenZMethod

the method to use

options:Object

the options to use

Exceptions
IllegalArgumentException:
if the method doesn't understand the options specified.

Method Detail

equalsback to summary
public boolean equals(final Object obj)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

  • It is reflexive: for any non-null reference value x, x.equals(x) should return true.
  • It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
  • It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
  • For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters
obj:Object

the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations
@Override
getMethodback to summary
public SevenZMethod getMethod()

The specified method.

Returns:SevenZMethod

the method

getOptionsback to summary
public Object getOptions()

The specified options.

Returns:Object

the options

hashCodeback to summary
public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

  • Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
  • If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
  • It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.
Returns:int

a hash code value for this object.

Annotations
@Override