Package org.apache.bcel.util

Class ClassPath

java.lang.Object

org.apache.bcel.util.ClassPath

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable

public class ClassPath
extends java.lang.Object
implements java.io.Closeable

Loads class files from the CLASSPATH. Inspired by sun.tools.ClassPath.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static class	ClassPath.AbstractPathEntry
private static class	ClassPath.AbstractZip
static interface	ClassPath.ClassFile	Contains information about file/ZIP entry of the Java class.
private static class	ClassPath.Dir
private static class	ClassPath.Jar
private static class	ClassPath.JrtModule
private static class	ClassPath.JrtModules
private static class	ClassPath.Module

Field Summary

Fields

Modifier and Type	Field	Description
private static java.io.FilenameFilter	ARCHIVE_FILTER
private java.lang.String	classPathString
private static java.io.FilenameFilter	MODULES_FILTER
private ClassPath	parent
private java.util.List<ClassPath.AbstractPathEntry>	paths
static ClassPath	SYSTEM_CLASS_PATH

Constructor Summary

Constructors

Constructor	Description
ClassPath()	Deprecated. Use SYSTEM_CLASS_PATH constant
ClassPath(java.lang.String classPath)	Search for classes in given path.
ClassPath(ClassPath parent, java.lang.String classPathString)

Method Summary

Modifier and Type	Method	Description
private static void	addJdkModules(java.lang.String javaHome, java.util.List<java.lang.String> list)
void	close()
boolean	equals(java.lang.Object obj)
byte[]	getBytes(java.lang.String name)
byte[]	getBytes(java.lang.String name, java.lang.String suffix)
ClassPath.ClassFile	getClassFile(java.lang.String name)
ClassPath.ClassFile	getClassFile(java.lang.String name, java.lang.String suffix)
private ClassPath.ClassFile	getClassFileInternal(java.lang.String name, java.lang.String suffix)
static java.lang.String	getClassPath()	Checks for class path components in the following properties: "java.class.path", "sun.boot.class.path", "java.ext.dirs"
java.io.InputStream	getInputStream(java.lang.String name)	Gets an InputStream.
java.io.InputStream	getInputStream(java.lang.String name, java.lang.String suffix)	Gets an InputStream for a class or resource on the classpath.
java.lang.String	getPath(java.lang.String name)
java.lang.String	getPath(java.lang.String name, java.lang.String suffix)
private static void	getPathComponents(java.lang.String path, java.util.List<java.lang.String> list)
java.net.URL	getResource(java.lang.String name)
java.io.InputStream	getResourceAsStream(java.lang.String name)
java.util.Enumeration<java.net.URL>	getResources(java.lang.String name)
int	hashCode()
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

ARCHIVE_FILTER

private static final java.io.FilenameFilter ARCHIVE_FILTER

MODULES_FILTER

private static final java.io.FilenameFilter MODULES_FILTER

SYSTEM_CLASS_PATH

public static final ClassPath SYSTEM_CLASS_PATH

classPathString

private final java.lang.String classPathString

parent

private final ClassPath parent

paths

private final java.util.List<ClassPath.AbstractPathEntry> paths

Constructor Detail

ClassPath

@Deprecated
public ClassPath()

Deprecated.

Use SYSTEM_CLASS_PATH constant

Search for classes in CLASSPATH.

ClassPath

public ClassPath(ClassPath parent,
                 java.lang.String classPathString)

ClassPath

public ClassPath(java.lang.String classPath)

Search for classes in given path.

Parameters:

classPath -

Method Detail

addJdkModules

private static void addJdkModules(java.lang.String javaHome,
                                  java.util.List<java.lang.String> list)

getClassPath

public static java.lang.String getClassPath()

Checks for class path components in the following properties: "java.class.path", "sun.boot.class.path", "java.ext.dirs"

Returns:

class path as used by default by BCEL

getPathComponents

private static void getPathComponents(java.lang.String path,
                                      java.util.List<java.lang.String> list)

close

public void close()
           throws java.io.IOException

Specified by:

close in interface java.lang.AutoCloseable

Specified by:

close in interface java.io.Closeable

Throws:

java.io.IOException

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

getBytes

public byte[] getBytes(java.lang.String name)
                throws java.io.IOException

Parameters:

name - fully qualified file name, e.g. java/lang/String

Returns:

byte array for class

Throws:

java.io.IOException - if an I/O error occurs.

getBytes

public byte[] getBytes(java.lang.String name,
                       java.lang.String suffix)
                throws java.io.IOException

Parameters:

name - fully qualified file name, e.g. java/lang/String

suffix - file name ends with suffix, e.g. .java

Returns:

byte array for file on class path

Throws:

java.io.IOException - if an I/O error occurs.

getClassFile

public ClassPath.ClassFile getClassFile(java.lang.String name)
                                 throws java.io.IOException

Parameters:

name - fully qualified class name, e.g. java.lang.String

Returns:

input stream for class

Throws:

java.io.IOException - if an I/O error occurs.

getClassFile

public ClassPath.ClassFile getClassFile(java.lang.String name,
                                        java.lang.String suffix)
                                 throws java.io.IOException

Parameters:

name - fully qualified file name, e.g. java/lang/String

suffix - file name ends with suff, e.g. .java

Returns:

class file for the Java class

Throws:

java.io.IOException - if an I/O error occurs.

getClassFileInternal

private ClassPath.ClassFile getClassFileInternal(java.lang.String name,
                                                 java.lang.String suffix)

getInputStream

public java.io.InputStream getInputStream(java.lang.String name)
                                   throws java.io.IOException

Gets an InputStream.

The caller is responsible for closing the InputStream.

Parameters:

name - fully qualified class name, e.g. java.lang.String

Returns:

input stream for class

Throws:

java.io.IOException - if an I/O error occurs.

getInputStream

public java.io.InputStream getInputStream(java.lang.String name,
                                          java.lang.String suffix)
                                   throws java.io.IOException

Gets an InputStream for a class or resource on the classpath.

The caller is responsible for closing the InputStream.

Parameters:

name - fully qualified file name, e.g. java/lang/String

suffix - file name ends with suff, e.g. .java

Returns:

input stream for file on class path

Throws:

java.io.IOException - if an I/O error occurs.

getPath

public java.lang.String getPath(java.lang.String name)
                         throws java.io.IOException

Parameters:

name - name of file to search for, e.g. java/lang/String.java

Returns:

full (canonical) path for file

Throws:

java.io.IOException - if an I/O error occurs.

getPath

public java.lang.String getPath(java.lang.String name,
                                java.lang.String suffix)
                         throws java.io.IOException

Parameters:

name - name of file to search for, e.g. java/lang/String

suffix - file name suffix, e.g. .java

Returns:

full (canonical) path for file, if it exists

Throws:

java.io.IOException - if an I/O error occurs.

getResource

public java.net.URL getResource(java.lang.String name)

Parameters:

name - fully qualified resource name, e.g. java/lang/String.class

Returns:

URL supplying the resource, or null if no resource with that name.

Since:

6.0

getResourceAsStream

public java.io.InputStream getResourceAsStream(java.lang.String name)

Parameters:

name - fully qualified resource name, e.g. java/lang/String.class

Returns:

InputStream supplying the resource, or null if no resource with that name.

Since:

6.0

getResources

public java.util.Enumeration<java.net.URL> getResources(java.lang.String name)

Parameters:

name - fully qualified resource name, e.g. java/lang/String.class

Returns:

An Enumeration of URLs supplying the resource, or an empty Enumeration if no resource with that name.

Since:

6.0

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

Returns:

used class path string