org.apache.commons.compress.archivers.sevenz.SevenZMethodConfiguration Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of commons-compress Show documentation
Show all versions of commons-compress Show documentation
Apache Commons Compress software defines an API for working with
compression and archive formats. These include: bzip2, gzip, pack200,
lzma, xz, Snappy, traditional Unix Compress, DEFLATE, DEFLATE64, LZ4,
Brotli, Zstandard and ar, cpio, jar, tar, zip, dump, 7z, arj.
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
*/
package org.apache.commons.compress.archivers.sevenz;
import 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
*
* @Immutable
* @since 1.8
*/
public class SevenZMethodConfiguration {
private final SevenZMethod method;
private final Object options;
/**
* Doesn't configure any additional options.
* @param method the method to use
*/
public SevenZMethodConfiguration(final SevenZMethod method) {
this(method, null);
}
/**
* Specifies and method plus configuration options.
* @param method the method to use
* @param options the options to use
* @throws IllegalArgumentException if the method doesn't understand the options specified.
*/
public SevenZMethodConfiguration(final SevenZMethod method, final Object options) {
this.method = method;
this.options = options;
if (options != null && !Coders.findByMethod(method).canAcceptOptions(options)) {
throw new IllegalArgumentException("The " + method + " method doesn't support options of type "
+ options.getClass());
}
}
/**
* The specified method.
* @return the method
*/
public SevenZMethod getMethod() {
return method;
}
/**
* The specified options.
* @return the options
*/
public Object getOptions() {
return options;
}
@Override
public int hashCode() {
return method == null ? 0 : method.hashCode();
}
@Override
public boolean equals(final Object obj) {
if (this == obj) {
return true;
}
if (obj == null || getClass() != obj.getClass()) {
return false;
}
final SevenZMethodConfiguration other = (SevenZMethodConfiguration) obj;
return Objects.equals(method, other.method)
&& Objects.equals(options, other.options);
}
}