com.ibm.wala.classLoader

Interface ModuleEntry

All Known Subinterfaces:

SourceModule

All Known Implementing Classes:

AbstractURLModule, ClassFileModule, CompoundModule, FileModule, JarFileEntry, SourceFileModule, SourceURLModule

public interface ModuleEntry

A ModuleEntry represents a wrapper around a file representation in a Module.

Method Summary

Modifier and Type	Method and Description
Module	asModule() Precondition: isModuleFile().
java.lang.String	getClassName()
Module	getContainer() the containing module
java.io.InputStream	getInputStream()
java.lang.String	getName()
boolean	isClassFile()
boolean	isModuleFile()
boolean	isSourceFile()

Method Detail

getName

java.lang.String getName()

Returns:

a String that represents the name of the file described by this object

isClassFile

boolean isClassFile()

Returns:

true if the file is a class file.

isSourceFile

boolean isSourceFile()

Returns:

true if the file is a source file.

getInputStream

java.io.InputStream getInputStream()

Returns:

an InputStream which provides the contents of this logical file.

isModuleFile

boolean isModuleFile()

Returns:

true iff this module entry (file) represents a module in its own right. e.g., a jar file which is an entry in another jar file.

asModule

Module asModule()

Precondition: isModuleFile().

Returns:

a Module view of this entry.

getClassName

java.lang.String getClassName()

Returns:

the name of the class represented by this entry

Throws:

java.lang.UnsupportedOperationException - if !isClassFile() and !isSourceFile()

getContainer

Module getContainer()

the containing module