Class MemoryMapArchiveBase<T extends Archive<T>>

java.lang.Object

org.jboss.shrinkwrap.impl.base.ArchiveBase<T>

org.jboss.shrinkwrap.impl.base.MemoryMapArchiveBase<T>

Type Parameters:

T -

All Implemented Interfaces:

Archive<T>, Assignable, ArchiveFormatAssociable, Configurable, Identifiable

Direct Known Subclasses:

MemoryMapArchiveImpl

public abstract class MemoryMapArchiveBase<T extends Archive<T>>
extends ArchiveBase<T>
implements Archive<T>

MemoryMapArchiveBase A base implementation for all MemoryMap archives. Thread-safe.

Version:

$Revision: $

Field Summary

Fields

Modifier and Type	Field	Description
private final Map<ArchivePath, NodeImpl>	content	Storage for the Nodes.
private final List<ArchiveEventHandler>	handlers
private final Map<ArchivePath, ArchiveAsset>	nestedArchives	Storage for the ArchiveAssets.

Constructor Summary

Constructors

Constructor	Description
MemoryMapArchiveBase(String archiveName, Configuration configuration)	Constructor This constructor will generate an Archive with the provided name.
MemoryMapArchiveBase(Configuration configuration)	Constructor This constructor will generate a unique Archive.getName() per instance.

Method Summary

Modifier and Type	Method	Description
T	add(Archive<?> archive, String path, Class<? extends StreamExporter> exporter)	Add an archive under a specific context and maintain the archive name as context path.
T	add(Archive<?> archive, ArchivePath path, Class<? extends StreamExporter> exporter)	Add an archive under a specific context and maintain the archive name as context path.
T	add(Asset asset, ArchivePath path)	Adds the specified asset under the specified path into the target context
T	addAsDirectory(ArchivePath path)	Adds the specified directory.
private T	addAsset(ArchivePath path, Asset asset)
T	addHandlers(ArchiveEventHandler... handlers)	Add an array of listeners for call back based.
private void	addNewNode(ArchivePath path, Asset handledAsset)
boolean	contains(String path)	Denotes whether this archive contains a resource at the specified path
boolean	contains(ArchivePath path)	Denotes whether this archive contains a resource at the specified path
Node	delete(String archivePath)	Removes the Node in the Archive at the ArchivePath indicated by the specified String archivePath.
Node	delete(ArchivePath path)	Removes the Node in the Archive at the specified ArchivePath.
Node	get(ArchivePath path)	Obtains the Node located at the specified path
Map<ArchivePath, Node>	getContent()	Obtains all assets in this archive, along with their respective paths.
Map<ArchivePath, Node>	getContent(Filter<ArchivePath> filter)	Obtains all assets matching given filter in this archive, along with its respective Path.
private Node	getNestedNode(ArchivePath path)	Attempt to get the asset from a nested archive.
private ArchivePath	getNestedPath(ArchivePath fullPath, ArchivePath basePath)	Given a full path and a base path return a new path containing the full path with the base path removed from the beginning.
private Asset	invokeHandlers(ArchivePath path, Asset asset)
private boolean	nestedContains(ArchivePath path)	Check to see if a path is found in a nested archive
private NodeImpl	obtainParent(ArchivePath path)	Used to retrieve a Node from the content of the Archive.
private Node	removeNodeRecursively(NodeImpl node, ArchivePath path)	Removes the specified node and its associated children from the contents of this archive.
private boolean	startsWith(ArchivePath fullPath, ArchivePath startingPath)	Check to see if one path starts with another

Methods inherited from class ArchiveBase

add, add, add, add, addAsDirectories, addAsDirectories, addAsDirectory, as, covariantReturn, equals, filter, get, getActualClass, getArchiveFormat, getAsType, getAsType, getAsType, getAsType, getAsType, getAsType, getConfiguration, getId, getName, hashCode, merge, merge, merge, merge, merge, merge, move, move, setId, shallowCopy, shallowCopy, toString, toString, toString, writeTo

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface Archive

add, add, add, add, addAsDirectories, addAsDirectories, addAsDirectory, filter, get, getAsType, getAsType, getAsType, getAsType, getAsType, getAsType, getId, getName, merge, merge, merge, merge, merge, merge, move, move, shallowCopy, shallowCopy, toString, toString, toString, writeTo

Methods inherited from interface Assignable

as

Field Details

content

private final Map<ArchivePath, NodeImpl> content

Storage for the Nodes.

nestedArchives

private final Map<ArchivePath, ArchiveAsset> nestedArchives

Storage for the ArchiveAssets. Used to help get access to nested archive content.

handlers

private final List<ArchiveEventHandler> handlers

Constructor Details

MemoryMapArchiveBase

public MemoryMapArchiveBase(Configuration configuration)
                     throws IllegalArgumentException

Constructor This constructor will generate a unique Archive.getName() per instance.

Parameters:

configuration - The configuration for this archive

Throws:

IllegalArgumentException - If the configuration is not specified

MemoryMapArchiveBase

public MemoryMapArchiveBase(String archiveName,
 Configuration configuration)
                     throws IllegalArgumentException

Constructor This constructor will generate an Archive with the provided name.

Parameters:

archiveName -

configuration - The configuration for this archive

Throws:

IllegalArgumentException - If the name or configuration is not specified

Method Details

add

public T add(Asset asset,
 ArchivePath path)

Adds the specified asset under the specified path into the target context

Specified by:

add in interface Archive<T extends Archive<T>>

Parameters:

asset -

path - The context under which to add the assets

Returns:

See Also:

• Archive.add(org.jboss.shrinkwrap.api.asset.Asset, org.jboss.shrinkwrap.api.ArchivePath)

add

public T add(Archive<?> archive,
 String path,
 Class<? extends StreamExporter> exporter)

Add an archive under a specific context and maintain the archive name as context path.

Specified by:

add in interface Archive<T extends Archive<T>>

Parameters:

archive - to add

path - to use

exporter - Exporter type to use in fulfilling the Asset.openStream() contract for the added (nested) archive.

Returns:

See Also:

• Archive.add(org.jboss.shrinkwrap.api.Archive, java.lang.String, java.lang.Class)

add

public T add(Archive<?> archive,
 ArchivePath path,
 Class<? extends StreamExporter> exporter)

Add an archive under a specific context and maintain the archive name as context path.

Specified by:

add in interface Archive<T extends Archive<T>>

Overrides:

add in class ArchiveBase<T extends Archive<T>>

Parameters:

archive - to add

path - to use

exporter - Exporter type to use in fulfilling the Asset.openStream() contract for the added (nested) archive.

Returns:

See Also:

• ArchiveBase.add(org.jboss.shrinkwrap.api.Archive, org.jboss.shrinkwrap.api.ArchivePath, java.lang.Class)

addAsDirectory

public T addAsDirectory(ArchivePath path)
                 throws IllegalArgumentException

Adds the specified directory.

Specified by:

addAsDirectory in interface Archive<T extends Archive<T>>

Parameters:

path - The path to add

Returns:

This archive

Throws:

IllegalArgumentException - If no path was specified

See Also:

• Archive.addAsDirectory(org.jboss.shrinkwrap.api.ArchivePath)

addAsset

private T addAsset(ArchivePath path,
 Asset asset)

addNewNode

private void addNewNode(ArchivePath path,
 Asset handledAsset)

addHandlers

public T addHandlers(ArchiveEventHandler... handlers)

Add an array of listeners for call back based.

Specified by:

addHandlers in interface Archive<T extends Archive<T>>

Returns:

This archive

See Also:

• invalid reference

  org.jboss.shrinkwrap.api.Archive#addListener(org.jboss.shrinkwrap.api.Filter, org.jboss.shrinkwrap.api.ArchiveEventHandler)

invokeHandlers

private Asset invokeHandlers(ArchivePath path,
 Asset asset)

contains

public boolean contains(ArchivePath path)

Denotes whether this archive contains a resource at the specified path

Specified by:

contains in interface Archive<T extends Archive<T>>

Parameters:

path -

Returns:

See Also:

• Archive.contains(org.jboss.shrinkwrap.api.ArchivePath)

contains

public boolean contains(String path)
                 throws IllegalArgumentException

Denotes whether this archive contains a resource at the specified path

Specified by:

contains in interface Archive<T extends Archive<T>>

Parameters:

path -

Returns:

Throws:

IllegalArgumentException - If the path is not specified

See Also:

• Archive.contains(java.lang.String)

delete

public Node delete(ArchivePath path)

Removes the Node in the Archive at the specified ArchivePath. If the path is a directory, recursively removes all contents. If the path does not exist, return null.

Specified by:

delete in interface Archive<T extends Archive<T>>

Parameters:

path -

Returns:

The Node removed

See Also:

• Archive.delete(org.jboss.declarchive.api.ArchivePath)

removeNodeRecursively

private Node removeNodeRecursively(NodeImpl node,
 ArchivePath path)

Removes the specified node and its associated children from the contents of this archive.

Parameters:

node - the node to remove recursively

path - the path denoting the specified node

Returns:

the removed node itself

delete

public Node delete(String archivePath)

Removes the Node in the Archive at the ArchivePath indicated by the specified String archivePath. If the path is a directory, recursively removes all contents. If the path does not exist, return null.

Specified by:

delete in interface Archive<T extends Archive<T>>

Parameters:

archivePath -

Returns:

The Node removed

See Also:

• Archive.delete(java.lang.String)

get

public Node get(ArchivePath path)

Obtains the Node located at the specified path

Specified by:

get in interface Archive<T extends Archive<T>>

Parameters:

path -

Returns:

The Node, or null if nothing is found at the specified path

See Also:

• Archive.get(org.jboss.shrinkwrap.api.ArchivePath)

getContent

public Map<ArchivePath, Node> getContent()

Obtains all assets in this archive, along with their respective paths. The returned Map will be an immutable view.

Specified by:

getContent in interface Archive<T extends Archive<T>>

Returns:

See Also:

• Archive.getContent()

getContent

public Map<ArchivePath, Node> getContent(Filter<ArchivePath> filter)

Obtains all assets matching given filter in this archive, along with its respective Path. The returned Map will be an immutable view.

Specified by:

getContent in interface Archive<T extends Archive<T>>

Returns:

See Also:

• Archive.getContent(org.jboss.shrinkwrap.api.Filter)

nestedContains

private boolean nestedContains(ArchivePath path)

Check to see if a path is found in a nested archive

getNestedNode

private Node getNestedNode(ArchivePath path)

Attempt to get the asset from a nested archive.

Parameters:

path -

Returns:

startsWith

private boolean startsWith(ArchivePath fullPath,
 ArchivePath startingPath)

Check to see if one path starts with another

Parameters:

fullPath -

startingPath -

Returns:

getNestedPath

private ArchivePath getNestedPath(ArchivePath fullPath,
 ArchivePath basePath)

Given a full path and a base path return a new path containing the full path with the base path removed from the beginning.

Parameters:

fullPath -

basePath -

Returns:

obtainParent

private NodeImpl obtainParent(ArchivePath path)

Used to retrieve a Node from the content of the Archive. If the Node doesn�t exists in the specified location, it is created and added to the Archive. The same happens to all its non-existing parents. However, if the Node is an asset, an IllegalArchivePathException is thrown.

Parameters:

path - The ArchivePath from which we are obtaining the Node

Returns:

The Node in the specified path

Throws:

IllegalArchivePathException - if the node is an Asset