/*
* 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
*
* https://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.tools.ant.types.resources;
import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;
import java.util.zip.GZIPInputStream;
import java.util.zip.GZIPOutputStream;
import org.apache.tools.ant.types.ResourceCollection;
A GZip compressed resource.
Wraps around another resource, delegates all queries to that
other resource but uncompresses/compresses streams on the fly.
Since: Ant 1.7
/**
* A GZip compressed resource.
*
* <p>Wraps around another resource, delegates all queries to that
* other resource but uncompresses/compresses streams on the fly.</p>
*
* @since Ant 1.7
*/
public class GZipResource extends CompressedResource {
A no-arg constructor /** A no-arg constructor */
public GZipResource() {
}
Constructor with another resource to wrap.
Params: - other – the resource to wrap.
/**
* Constructor with another resource to wrap.
* @param other the resource to wrap.
*/
public GZipResource(ResourceCollection other) {
super(other);
}
Decompress on the fly using java.util.zip.GZIPInputStream.
Params: - in – the stream to wrap.
Throws: - IOException – if there is a problem.
Returns: the wrapped stream.
/**
* Decompress on the fly using java.util.zip.GZIPInputStream.
* @param in the stream to wrap.
* @return the wrapped stream.
* @throws IOException if there is a problem.
*/
@Override
protected InputStream wrapStream(InputStream in) throws IOException {
return new GZIPInputStream(in);
}
Compress on the fly using java.util.zip.GZIPOutStream.
Params: - out – the stream to wrap.
Throws: - IOException – if there is a problem.
Returns: the wrapped stream.
/**
* Compress on the fly using java.util.zip.GZIPOutStream.
* @param out the stream to wrap.
* @return the wrapped stream.
* @throws IOException if there is a problem.
*/
@Override
protected OutputStream wrapStream(OutputStream out) throws IOException {
return new GZIPOutputStream(out);
}
Get the name of the compression method.
Returns: the string "GZip".
/**
* Get the name of the compression method.
* @return the string "GZip".
*/
@Override
protected String getCompressionName() {
return "GZip";
}
}