Class ShrinkWrapFileSystems

java.lang.Object

org.jboss.shrinkwrap.api.nio2.file.ShrinkWrapFileSystems

public final class ShrinkWrapFileSystems
extends Object

Convenience API bridge to the NIO.2 FileSystems support for ShrinkWrap Archives.

Author:

Andrew Lee Rubinger

Field Summary

Fields

Modifier and Type	Field	Description
static final String	FS_ENV_KEY_ARCHIVE	Map key used to store a Archive when creating a new FileSystem via FileSystems.newFileSystem(URI, Map)
static final String	PROTOCOL	Protocol portion of a URI to ShrinkWrap FileSystems

Method Summary

Modifier and Type	Method	Description
static URI	getRootUri(Archive<?> archive)	Constructs a new URI with the form:
static FileSystem	newFileSystem(Archive<?> archive)	Creates a new file system for the given Archive; in effect invoking this method is equal to invoking FileSystems.newFileSystem(URI, Map), passing the value of getRootUri(Archive) as the URI and the specified archive as a value in a Map under the key FS_ENV_KEY_ARCHIVE

Methods inherited from class Object

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

Field Details

PROTOCOL

public static final String PROTOCOL

Protocol portion of a URI to ShrinkWrap FileSystems

See Also:

• Constant Field Values

FS_ENV_KEY_ARCHIVE

public static final String FS_ENV_KEY_ARCHIVE

Map key used to store a Archive when creating a new FileSystem via FileSystems.newFileSystem(URI, Map)

See Also:

• Constant Field Values

Method Details

newFileSystem

public static FileSystem newFileSystem(Archive<?> archive)
                                throws IllegalArgumentException,
IOException

Creates a new file system for the given Archive; in effect invoking this method is equal to invoking FileSystems.newFileSystem(URI, Map), passing the value of getRootUri(Archive) as the URI and the specified archive as a value in a Map under the key FS_ENV_KEY_ARCHIVE

Parameters:

archive - The Archive for which a new file system is to be created. Must not be null.

Returns:

A new FileSystem associated with the given Archive.

Throws:

IllegalArgumentException - If the archive is not specified

IOException - If an error was encountered during creation of the new FileSystem via FileSystems.newFileSystem(URI, Map)

getRootUri

public static URI getRootUri(Archive<?> archive)
                      throws IllegalArgumentException

Constructs a new URI with the form:

shrinkwrap://{archive.getId()}/

Parameters:

archive - The Archive for which the root URI is to be constructed. Must not be null.

Returns:

A new URI representing the root of the given Archive.

Throws:

IllegalArgumentException - If the archive is not specified