Package com.ibm.wsspi.artifact

Interface ArtifactContainer

All Superinterfaces:
EnclosedEntity, Entity, Iterable<ArtifactEntry>
All Known Subinterfaces:
OverlayContainer
public interface ArtifactContainer extends Iterable<ArtifactEntry>, EnclosedEntity
Represents an immediate enclosure of a number of Entries.

Entries within this Container, may themselves be Containers

Note that Container does not require hashCode/equals, and thus should not be used as a key in HashMaps, etc. This can be used to represent, for example, a directory on the file system or a JAR file.

  • Method Details

    • useFastMode

      void useFastMode()
      Instruct this container it may commit to using more resources to speed access to it's content.

      Fast Mode is enabled at the root container, and enables/disables for all containers beneath that root.
      Fast Mode does not cascade into new root containers (eg, where Entry.convertToContainer().isRoot()==true)

      Calling this method requires you to later invoke stopUsingFastMode()

      This method is equivalent to {@link ArtifactContainer.getRoot().useFastMode()}

    • stopUsingFastMode

      void stopUsingFastMode()
      Instruct this container that you no longer require it to consume resources to speed access to it's content.

      Fast Mode is enabled at the root container, and enables/disables for all containers beneath that root.
      Fast Mode does not cascade into new root containers (eg, where Entry.convertToContainer().isRoot()==true)

      Calling this method requires you to have previously invoked useFastMode()

      This method is equivalent to {@link ArtifactContainer.getRoot().useFastMode()}

    • isRoot

      boolean isRoot()
      Does this container represent the root of an artifact.
      Returns:
      true if root, false otherwise.

    • getEntry

      ArtifactEntry getEntry(String pathAndName)
      Obtain an entry from this container.

      If path is absolute (starts with '/') and this Container is not root the path is interpreted as being from the Container that is root enclosing this one.
      If the path is not absolute, (does not start with '/'), or this Container is root and the path is absolute, then the entry is searched for relative to this Container.

      Parameters:
      pathAndName - absolute or relative path to search for.
      Returns:
      ArtifactEntry if Entry was found, null otherwise.

    • getURLs

      Collection<URL> 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.
      Returns:
      A collection of URLs that represent all of the locations on disk that contribute to this container
      Throws:
      UnsupportedOperationException - if the implementation does not support this method

    • getEntryInEnclosingContainer

      ArtifactEntry getEntryInEnclosingContainer()
      Get the Entry representing this entity within its EnclosingContainer
      Returns:
      entry representing this entity in the enclosing container, or null if there is no enclosing container, and therefore no entry.

    • getArtifactNotifier

      ArtifactNotifier getArtifactNotifier()
      Obtain the notification manager for this container.
      Returns: