alma.acs.eclipse.utils.jar

Class JarFileHelper

java.lang.Object

alma.acs.eclipse.utils.jar.JarFileHelper

public class JarFileHelper
extends java.lang.Object

Objects from this class allow to browse the content of a jar file focusing on classes and packages.

There are 2 ways to use JarFileHelper objects:

1. from the name of a jar like for example lc.jar: in this case the jar file is retrieved by following ACS rules i.e. ../lib, INROOT/lib...
2. by passing directly the jar file like for example $INTROOT/lib/lc.jar

Given the name of a jar file, JarFile get the right jar file from the file system looking the folder as ACS rules. The content of thSe jar file is then examined to get the list of the java classes and packages it contains as well as any other info needed.

Note: this class is intended to work only with ACS distributed jar files.

Author:

acaproni

Constructor Summary

Constructors

Constructor and Description
JarFileHelper(java.io.File file) Constructor
JarFileHelper(java.lang.String name, java.lang.String[] folders) Constructor.

Method Summary

Modifier and Type	Method and Description
void	getClasses(java.util.Collection<java.lang.String> javaClasses) Flush the java classes contained in this jar file into the passed vector.
java.lang.String	getFilePathName()
java.util.Collection<java.lang.String>	getMatchingClasses(java.lang.String name) Check if a class with the given name is in the jar.
java.lang.String	getName()
int	getPackages(java.util.Collection<java.lang.String> javaPackages) Flush the java packages contained in this jar file into the passed vector.

Methods inherited from class java.lang.Object

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

Constructor Detail

JarFileHelper

public JarFileHelper(java.lang.String name,
                     java.lang.String[] folders)
              throws java.lang.Exception

Constructor.

Parameters:

name - The name of the ACS jar file (like lc.jar)

folders - The folders to look for the jar files

Throws:

java.lang.Exception

JarFileHelper

public JarFileHelper(java.io.File file)
              throws java.lang.Exception

Constructor

Parameters:

file - The jar file

Throws:

java.lang.Exception

Method Detail

getPackages

public int getPackages(java.util.Collection<java.lang.String> javaPackages)
                throws java.io.IOException

Flush the java packages contained in this jar file into the passed vector.

Returns:

the number of java packages in the jar file

Throws:

java.io.IOException - In case of error reading the jar file

getClasses

public void getClasses(java.util.Collection<java.lang.String> javaClasses)
                throws java.io.IOException

Flush the java classes contained in this jar file into the passed vector.

Throws:

java.io.IOException

getMatchingClasses

public java.util.Collection<java.lang.String> getMatchingClasses(java.lang.String name)
                                                          throws java.io.IOException

Check if a class with the given name is in the jar. The match is not done for the whole name of the class but from its initial part. For example if the parameter is Logging and the jar is lc.jar then the returned array contains LoggingClient and LoggingClientText

Parameters:

name - The beginning of the name of the class

Returns:

A list of class names matching the parameter or null if no class name in the jar matches with the parameter

Throws:

java.io.IOException - In case of error reading the jar file

getFilePathName

public java.lang.String getFilePathName()

Returns:

the absolute path of the file of the jar

getName

public java.lang.String getName()

Returns:

the name