com.ibm.wsspi.adaptable.module
Interface Container
An adaptable container.
Method Summary
Modifier and Type | Method and Description |
---|---|
getEnclosingContainer()
Get the Container that encloses this one.
|
|
getEntry(java.lang.String pathAndName)
Obtain adaptable entry from this container.
Path may be relative to this node, or absolute to the local root. Local root is the 'enclosingContainer' above this Container in the hierarchy, that returns true for 'isRoot'. |
|
|
getName()
Get name for this Container.
|
|
getPath()
Get path for this Container.
|
|
getPhysicalPath()
Deprecated. added purely to support getRealPath on ServletContext .. post alpha this will need replacing.
|
getRoot()
Gets the Container that represents the root of this Entries
hierarchy.
|
|
|
getURLs()
This may not be implemented by all implementations of this interface and it should never return
null but should return an empty collection instead.
|
|
isRoot()
True if this Container represents a root for paths.
|
Methods inherited from interface com.ibm.wsspi.adaptable.module.Adaptable |
---|
adapt |
Methods inherited from interface java.lang.Iterable |
---|
iterator |
Method Detail
getEntry
- Entry getEntry(java.lang.String pathAndName)
pathAndName
- path to obtain entry at. getName
- java.lang.String getName()
eg. /wibble/fish will give fish, /wibble will give wibble
getPath
- java.lang.String getPath()
getEnclosingContainer
- Container getEnclosingContainer( )
Even containers that return true for isRoot, may return an enclosing Container.
Eg. a Jar within a directory, the jar will return true for isRoot, and it's enclosing container would be the directory.
isRoot
- boolean isRoot()
Even containers that return true for isRoot, may still be enclosed by another Container. Eg. a Jar within a directory, the jar will return true for isRoot, and it's enclosing container would be the directory.
getRoot
- Container getRoot()
getURLs
- java.util.Collection<java.net.URL> getURLs( )
null
but should return an empty collection instead.
java.lang.UnsupportedOperationException
- if the implementation does not support this method getPhysicalPath
- @Deprecated
- java.lang.String getPhysicalPath( )
Get path for this Entity. Not all implementations of this interface need to support this method and should return null
if they do not support them.
If the entry is container within an archive file such as a JAR or ZIP then this will return null
.
For directories that have more than one physical location mapped to them then this will return the first mapped resource.
Path may be relative to this node, or absolute to the local root.
Local root is the 'enclosingContainer' above this Container in the hierarchy, that returns true for 'isRoot'.