Class BundleManager

java.lang.Object
org.netbeans.jemmy.BundleManager

public class BundleManager extends Object
Provides functionality to work with a bunch of resource files.
Author:
Alexandre Iline (alexandre.iline@sun.com)
See Also:
  • Constructor Details

    • BundleManager

      public BundleManager()
      Bundle manager constructor.
  • Method Details

    • addBundle

      public Bundle addBundle(Bundle bundle, String ID)
      Adds a Bundle to the managed collection of resource files.
      Parameters:
      bundle - Bundle object
      ID - Symbolic bundle id
      Returns:
      First parameter or null if bundle with ID already exists.
      See Also:
    • removeBundle

      public Bundle removeBundle(String ID)
      Removes a Bundle from the managed collection of resource files.
      Parameters:
      ID - Symbolic bundle id
      Returns:
      Removed bundle or null if no bundle ID is.
    • getBundle

      public Bundle getBundle(String ID)
      Returns a Bundle given it's symbolic ID.
      Parameters:
      ID - Symbolic bundle ID
      Returns:
      the Bundle. A null reference is returned if no bundle with the symbolic ID was found.
    • loadBundleFromFile

      public Bundle loadBundleFromFile(String fileName, String ID) throws IOException, FileNotFoundException
      Create a new Bundle, load resources from a simple text file, and add the bundle. Load resources from a text file to a new Bundle object. The new Bundle is added to the collection of objects managed by this BundleManager.
      Parameters:
      fileName - Name of a file to load resources from.
      ID - Symbolic bundle ID used to identify the new bundle used to manage the resources from the file.
      Returns:
      a newly created bundle.
      Throws:
      IOException
      FileNotFoundException
    • loadBundleFromStream

      public Bundle loadBundleFromStream(InputStream stream, String ID) throws IOException, FileNotFoundException
      Throws:
      IOException
      FileNotFoundException
    • loadBundleFromResource

      public Bundle loadBundleFromResource(ClassLoader cl, String resource, String ID) throws IOException, FileNotFoundException
      Throws:
      IOException
      FileNotFoundException
    • load

      public Bundle load() throws IOException, FileNotFoundException
      Loads resources from simple text file pointed by jemmy.resources system property. The resources are loaded into the Bundle with ID "". Does not do anything if jemmy.resources has not been set or is empty.
      Returns:
      a newly created bundle.
      Throws:
      IOException
      FileNotFoundException
    • loadBundleFromJar

      public Bundle loadBundleFromJar(String fileName, String entryName, String ID) throws IOException, FileNotFoundException
      Loads resources from file in jar archive into new Bundle object and adds it.
      Parameters:
      fileName - Name of jar file.
      entryName - ?enryName? Name of file to load resources from.
      ID - Symbolic bundle id
      Returns:
      a newly created bundle.
      Throws:
      IOException
      FileNotFoundException
    • loadBundleFromZip

      public Bundle loadBundleFromZip(String fileName, String entryName, String ID) throws IOException, FileNotFoundException, ZipException
      Loads resources from file in zip archive into new Bundle object and adds it.
      Parameters:
      fileName - Name of jar file.
      entryName - ?enryName? Name of file to load resources from.
      ID - Symbolic bundle id
      Returns:
      a newly created bundle.
      Throws:
      ZipException
      IOException
      FileNotFoundException
    • print

      public void print(PrintWriter writer)
      Prints bundles contents.
      Parameters:
      writer - Writer to print data in.
    • print

      public void print(PrintStream stream)
      Prints bundles contents.
      Parameters:
      stream - Stream to print data in.
    • getResource

      public String getResource(String bundleID, String key)
      Returns resource from ID bundle.
      Parameters:
      bundleID - Bundle ID.
      key - Resource key.
      Returns:
      the resource value. If the bundle ID does not exist if the resource with the given key cannot be found, a null reference is returned.
    • getResource

      public String getResource(String key)
      Searches for a resource in all the managed Bundles.
      Parameters:
      key - Resource key.
      Returns:
      first resource value found that is indexed by the given key. If no resource is found, return a null reference.
    • calculateResources

      public int calculateResources(String key)
      Counts the number of resource occurences in all the managed Bundles.
      Parameters:
      key - Resource key
      Returns:
      the number of resource occurences with the given key among all the Bundles managed by this BundleManager.
    • cloneThis

      public BundleManager cloneThis()
      Creates a shallow copy of this BundleManager. Does not copy bundles, only their references.
      Returns:
      a copy of this BundleManager.