/*
* JBoss, Home of Professional Open Source
* Copyright 2009, Red Hat Middleware LLC, and individual contributors
* by the @authors tag. See the copyright.txt in the distribution for a
* full listing of individual contributors.
*
* Licensed 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.jboss.shrinkwrap.api.exporter;
import java.io.File;
import org.jboss.shrinkwrap.api.Assignable;
Exporter used to export an Archive as an exploded directory structure.
Author: John Bailey, Aslak Knutsen Version: $Revision: $
/**
* Exporter used to export an Archive as an exploded directory structure.
*
* @author <a href="mailto:baileyje@gmail.com">John Bailey</a>
* @author <a href="mailto:aslak@conduct.no">Aslak Knutsen</a>
* @version $Revision: $
*/
public interface ExplodedExporter extends Assignable {
// -------------------------------------------------------------------------------------||
// Contracts --------------------------------------------------------------------------||
// -------------------------------------------------------------------------------------||
Exports provided archive as an exploded directory structure.
Params: - parentDirectory –
Must be a folder
Throws: - IllegalArgumentException –
if the archive or parent directory not valid
- ArchiveExportException –
if the export process fails
Returns: File for exploded archive contents
/**
* Exports provided archive as an exploded directory structure.
*
* @param parentDirectory
* Must be a folder
* @return File for exploded archive contents
* @throws IllegalArgumentException
* if the archive or parent directory not valid
* @throws ArchiveExportException
* if the export process fails
*/
File exportExploded(File parentDirectory);
Exports provided archive as an exploded directory structure.
Params: - parentDirectory –
Must be a folder
- directoryName –
The exploded directory name
Throws: - IllegalArgumentException –
if the archive or parent directory not valid
- ArchiveExportException –
if the export process fails
Returns: File for exploded archive contents
/**
* Exports provided archive as an exploded directory structure.
*
* @param parentDirectory
* Must be a folder
* @param directoryName
* The exploded directory name
* @return File for exploded archive contents
* @throws IllegalArgumentException
* if the archive or parent directory not valid
* @throws ArchiveExportException
* if the export process fails
*/
File exportExploded(File parentDirectory, String directoryName);
Exports provided archive as an exploded directory structure
into the given directory.
Params: - directory –
Must be a folder
Throws: - IllegalArgumentException –
if the archive or parent directory not valid
- ArchiveExportException –
if the export process fails
Returns: File for exploded archive contents
/**
* Exports provided archive as an exploded directory structure
* into the given directory.
*
* @param directory
* Must be a folder
* @return File for exploded archive contents
* @throws IllegalArgumentException
* if the archive or parent directory not valid
* @throws ArchiveExportException
* if the export process fails
*/
File exportExplodedInto(File directory);
}