org.apache.maven.jxr.pacman

Class JavaFile

java.lang.Object

org.apache.maven.jxr.pacman.JavaFile

Direct Known Subclasses:

JavaFileImpl

public abstract class JavaFile
extends Object

Interface for objects which wish to provide meta-info about a JavaFile.

Version:

$Id$

Author:

Kevin A. Burton

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	JavaFile(Path path, String encoding)

Method Summary

Modifier and Type	Method and Description
void	addClassType(ClassType classType) Add a ClassType to the current list of class types.
void	addImportType(ImportType importType) Add an ImportType to the current imports.
ClassType	getClassType() Get the name of this class.
List<ClassType>	getClassTypes() Get the names of the classes in this file.
String	getEncoding() Gets the encoding attribute of the JavaFile object
String	getFilename() File name without path and extension.
protected static String	getFilenameWithoutPathOrExtension(Path path) Remove the path and the ".java" extension from a filename.
Set<ImportType>	getImportTypes() Get the imported packages/files that this package has.
PackageType	getPackageType() Get the package of this class.
Path	getPath() Gets the filename attribute of the JavaFile object
void	setClassType(ClassType classType) Set the name of this class.
void	setPackageType(PackageType packageType) Set the PackageType of this class.

Methods inherited from class java.lang.Object

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

Constructor Detail

JavaFile

protected JavaFile(Path path,
                   String encoding)

Method Detail

getImportTypes

public Set<ImportType> getImportTypes()

Get the imported packages/files that this package has.

getClassType

public ClassType getClassType()

Get the name of this class.

getClassTypes

public List<ClassType> getClassTypes()

Get the names of the classes in this file.

getPackageType

public PackageType getPackageType()

Get the package of this class.

addClassType

public void addClassType(ClassType classType)

Add a ClassType to the current list of class types.

addImportType

public void addImportType(ImportType importType)

Add an ImportType to the current imports.

setClassType

public void setClassType(ClassType classType)

Set the name of this class.

setPackageType

public void setPackageType(PackageType packageType)

Set the PackageType of this class.

getPath

public Path getPath()

Gets the filename attribute of the JavaFile object

getFilename

public String getFilename()

File name without path and extension.

getEncoding

public String getEncoding()

Gets the encoding attribute of the JavaFile object

getFilenameWithoutPathOrExtension

protected static String getFilenameWithoutPathOrExtension(Path path)

Remove the path and the ".java" extension from a filename.