org.jboss.deployers.vfs.spi.structure
Interface VFSDeploymentUnit

All Superinterfaces:

Attachments, DeploymentUnit, MutableAttachments, Serializable

All Known Implementing Classes:

AbstractVFSDeploymentUnit

public interface VFSDeploymentUnit
extends DeploymentUnit

VFSDeploymentUnit.

Version:

$Revision: 1.1 $

Author:

Adrian Brock, Ales Justin

Method Summary

void	addClassPath(List<org.jboss.virtual.VirtualFile> files) Add virtual files to the classpath
void	addClassPath(org.jboss.virtual.VirtualFile... files) Append virtual files to the classpath
void	appendClassPath(List<org.jboss.virtual.VirtualFile> files) Add virtual files to the classpath
void	appendClassPath(org.jboss.virtual.VirtualFile... files) Append virtual files to the classpath
void	appendMetaDataLocation(org.jboss.virtual.VirtualFile... locations) Append metadata file locations.
List<org.jboss.virtual.VirtualFile>	getClassPath() Get the class path
org.jboss.virtual.VirtualFile	getFile(String path) Get a virtual file
org.jboss.virtual.VirtualFile	getMetaDataFile(String name) Gets a metadata file.
List<org.jboss.virtual.VirtualFile>	getMetaDataFiles(String name, String suffix) Gets the metadata files for this deployment unit
List<org.jboss.virtual.VirtualFile>	getMetaDataFiles(org.jboss.virtual.VirtualFileFilter filter) Gets the metadata files for this deployment unit
VFSDeploymentUnit	getParent() Get the parent deployment unit
VFSDeploymentResourceLoader	getResourceLoader() Get a resource loader
org.jboss.virtual.VirtualFile	getRoot() Get the root
VFSDeploymentUnit	getTopLevel() Get the top leve deployment unit
List<VFSDeploymentUnit>	getVFSChildren() Get the children
void	prependClassPath(List<org.jboss.virtual.VirtualFile> files) Prepend virtual files to the classpath
void	prependClassPath(org.jboss.virtual.VirtualFile... files) Prepend virtual files to the classpath
void	prependMetaDataLocation(org.jboss.virtual.VirtualFile... locations) Prepend metadata file locations.
void	removeClassPath(org.jboss.virtual.VirtualFile... files) Remove classpath files.
void	removeMetaDataLocation(org.jboss.virtual.VirtualFile... locations) Remove metadata file locations.
void	setClassPath(List<org.jboss.virtual.VirtualFile> classPath) Deprecated. user view should not have setters

Methods inherited from interface org.jboss.deployers.structure.spi.DeploymentUnit

addComponent, addControllerContextName, addIDependOn, createClassLoader, getAllMetaData, getChildren, getClassLoader, getComponent, getComponents, getControllerContextName, getControllerContextNames, getDependencyInfo, getMainDeployer, getMetaData, getMutableMetaData, getMutableScope, getName, getRelativePath, getResourceClassLoader, getScope, getSimpleName, getTransientManagedObjects, isComponent, isTopLevel, removeClassLoader, removeComponent, removeControllerContextName, removeIDependOn, setMutableScope, setRequiredStage, setScope, visit

Methods inherited from interface org.jboss.deployers.spi.attachments.MutableAttachments

addAttachment, addAttachment, addAttachment, clear, clearChangeCount, getChangeCount, removeAttachment, removeAttachment, removeAttachment, setAttachments

Methods inherited from interface org.jboss.deployers.spi.attachments.Attachments

getAttachment, getAttachment, getAttachment, getAttachments, hasAttachments, isAttachmentPresent, isAttachmentPresent, isAttachmentPresent

Method Detail

getMetaDataFile

org.jboss.virtual.VirtualFile getMetaDataFile(String name)

Gets a metadata file. This is a file located under the deployment metadata context(s).

Parameters:

name - the name to exactly match

Returns:

the virtual file or null if not found

Throws:

IllegalArgumentException - for a null name

getMetaDataFiles

List<org.jboss.virtual.VirtualFile> getMetaDataFiles(String name,
                                                     String suffix)

Gets the metadata files for this deployment unit

Parameters:

name - the name to exactly match

suffix - the suffix to partially match

Returns:

the virtual files that match

Throws:

IllegalArgumentException - if both the name and suffix are null

getMetaDataFiles

List<org.jboss.virtual.VirtualFile> getMetaDataFiles(org.jboss.virtual.VirtualFileFilter filter)

Gets the metadata files for this deployment unit

Parameters:

filter - the file filter

Returns:

the virtual files that match

Throws:

IllegalArgumentException - if both the name and suffix are null

prependMetaDataLocation

void prependMetaDataLocation(org.jboss.virtual.VirtualFile... locations)

Prepend metadata file locations.

Parameters:

locations - the locations

appendMetaDataLocation

void appendMetaDataLocation(org.jboss.virtual.VirtualFile... locations)

Append metadata file locations.

Parameters:

locations - the locations

removeMetaDataLocation

void removeMetaDataLocation(org.jboss.virtual.VirtualFile... locations)

Remove metadata file locations.

Parameters:

locations - the locations

getResourceLoader

VFSDeploymentResourceLoader getResourceLoader()

Get a resource loader

Specified by:

getResourceLoader in interface DeploymentUnit

Returns:

the resource loader

getFile

org.jboss.virtual.VirtualFile getFile(String path)

Get a virtual file

Parameters:

path - the relative path of the file

Returns:

the virtual file or null if not found

getRoot

org.jboss.virtual.VirtualFile getRoot()

Get the root

Returns:

the root

getClassPath

List<org.jboss.virtual.VirtualFile> getClassPath()

Get the class path

Returns:

the class path

setClassPath

@Deprecated
void setClassPath(List<org.jboss.virtual.VirtualFile> classPath)

Deprecated. user view should not have setters

Set the classpath

Parameters:

classPath - the classpath

prependClassPath

void prependClassPath(org.jboss.virtual.VirtualFile... files)

Prepend virtual files to the classpath

Parameters:

files - a virtual file

prependClassPath

void prependClassPath(List<org.jboss.virtual.VirtualFile> files)

Prepend virtual files to the classpath

Parameters:

files - a virtual file

appendClassPath

void appendClassPath(org.jboss.virtual.VirtualFile... files)

Append virtual files to the classpath

Parameters:

files - a virtual file

appendClassPath

void appendClassPath(List<org.jboss.virtual.VirtualFile> files)

Add virtual files to the classpath

Parameters:

files - a virtual file

addClassPath

void addClassPath(org.jboss.virtual.VirtualFile... files)

Append virtual files to the classpath

Parameters:

files - a virtual file

addClassPath

void addClassPath(List<org.jboss.virtual.VirtualFile> files)

Add virtual files to the classpath

Parameters:

files - a virtual file

removeClassPath

void removeClassPath(org.jboss.virtual.VirtualFile... files)

Remove classpath files.

Parameters:

files - the files

getTopLevel

VFSDeploymentUnit getTopLevel()

Get the top leve deployment unit

Specified by:

getTopLevel in interface DeploymentUnit

Returns:

the top level deployment unit

getParent

VFSDeploymentUnit getParent()

Get the parent deployment unit

Specified by:

getParent in interface DeploymentUnit

Returns:

the parent or null if there is no parent

getVFSChildren

List<VFSDeploymentUnit> getVFSChildren()

Get the children

Returns:

the children