org.pfsw.tools.cda.base.model.container

Class BundleContainerSpecification

java.lang.Object

org.pfsw.tools.cda.base.model.container.ContainerSpecification

org.pfsw.tools.cda.base.model.container.ExtractedContainerSpecification

org.pfsw.tools.cda.base.model.container.BundleContainerSpecification

All Implemented Interfaces:

org.pfsw.bif.lifecycle.IReleasable

public class BundleContainerSpecification
extends ExtractedContainerSpecification

Represents a container that itself contains other containers and some classes directly, too.

Field Summary

Fields inherited from class org.pfsw.tools.cda.base.model.container.ExtractedContainerSpecification

TEMP_FOLEDR_PREFIX

Constructor Summary

Constructors

Constructor and Description
BundleContainerSpecification(BundleContainerSpecification parentSpec, java.lang.String containerName, java.lang.String relativeName, java.io.File zipFile, java.io.File tempFolder)

Method Summary

Modifier and Type	Method and Description
java.lang.String	determineRelativeName(java.io.File file) Returns the relative path name of the given file related to the temp folder where this bundle has been extracted to.
java.lang.String	getClassesFolderName() Returns the name of sub-folder in which class files of this container can be found.
java.lang.String	getClassesSubFolder()
java.lang.String	getDisplayName()
java.util.Set<java.lang.String>	getExtraContainerDirNames()
IStringChecker	getSubDirExcludeFilter() Returns a filter for (relative) sub directory paths that should be excluded from this container's class and resource files analysis.
java.io.File	getTempFolder()
java.lang.String	getTempFolderName()
boolean	hasTempFolder()
void	release() Since by definition the file represented by this specification is actually a (zip) bundle, its physical representation is a temporary folder which will now be (recursively) deleted.
void	setClassesSubFolder(java.lang.String classesSubFolder)
void	setExtraContainerDirNames(java.util.Set<java.lang.String> extraContainerDirNames)

Methods inherited from class org.pfsw.tools.cda.base.model.container.ExtractedContainerSpecification

getLogger, getParentBundleSpec, hasParentBundleSpec

Methods inherited from class org.pfsw.tools.cda.base.model.container.ContainerSpecification

close, fileUtil, getClasspathElement, getContainerNames, getContainerType, getFileInfo, getFullContainerName, getPhysicalName, getQualifiedContainerName, getSimpleContainerName, isArchive, isDirectory, isEmbedded, isMetaData, isPhysicalArchive, isPhysicalDirectory, isValid, open, openContainedFile, setClasspathElement, setContainerType, setFileRepresentation, str, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

BundleContainerSpecification

public BundleContainerSpecification(BundleContainerSpecification parentSpec,
                                    java.lang.String containerName,
                                    java.lang.String relativeName,
                                    java.io.File zipFile,
                                    java.io.File tempFolder)

Method Detail

release

public void release()

Since by definition the file represented by this specification is actually a (zip) bundle, its physical representation is a temporary folder which will now be (recursively) deleted.

Specified by:

release in interface org.pfsw.bif.lifecycle.IReleasable

Overrides:

release in class ContainerSpecification

determineRelativeName

public java.lang.String determineRelativeName(java.io.File file)

Returns the relative path name of the given file related to the temp folder where this bundle has been extracted to.

hasTempFolder

public boolean hasTempFolder()

getTempFolderName

public java.lang.String getTempFolderName()

getTempFolder

public java.io.File getTempFolder()

getDisplayName

public java.lang.String getDisplayName()

Overrides:

getDisplayName in class ContainerSpecification

getClassesFolderName

public java.lang.String getClassesFolderName()

Returns the name of sub-folder in which class files of this container can be found. An empty string is returned for the container's root folder.

Overrides:

getClassesFolderName in class ContainerSpecification

getSubDirExcludeFilter

public IStringChecker getSubDirExcludeFilter()

Description copied from class: ContainerSpecification

Returns a filter for (relative) sub directory paths that should be excluded from this container's class and resource files analysis.

This default implementation returns an exclude filter that matches no given directory path. That is, no sub directory will be excluded.
Subclasses must override this method in order to exclude one or more sub directories.

Overrides:

getSubDirExcludeFilter in class ContainerSpecification

getClassesSubFolder

public java.lang.String getClassesSubFolder()

setClassesSubFolder

public void setClassesSubFolder(java.lang.String classesSubFolder)

getExtraContainerDirNames

public java.util.Set<java.lang.String> getExtraContainerDirNames()

setExtraContainerDirNames

public void setExtraContainerDirNames(java.util.Set<java.lang.String> extraContainerDirNames)