Package org.aspectj.org.eclipse.jdt.internal.core

Class BasicCompilationUnit

java.lang.Object

org.aspectj.org.eclipse.jdt.internal.core.BasicCompilationUnit

All Implemented Interfaces:

ICompilationUnit, IDependent

public class BasicCompilationUnit
extends Object
implements ICompilationUnit

A basic implementation of ICompilationUnit for use in the SourceMapper.

See Also:

• ICompilationUnit

Field Summary

Fields

Modifier and Type	Field	Description
protected final char[]	contents
protected String	encoding
protected final char[]	fileName
protected char[]	mainTypeName
protected char[]	moduleName
protected final char[][]	packageName

Fields inherited from interface org.aspectj.org.eclipse.jdt.internal.compiler.env.IDependent

JAR_FILE_ENTRY_SEPARATOR

Constructor Summary

Constructors

Constructor	Description
BasicCompilationUnit(char[] contents, char[][] packageName, String fileName, String encoding)	Deprecated. Should pass a javaElement via BasicCompilationUnit(char[], char[][], String, IJavaElement).
BasicCompilationUnit(char[] contents, char[][] packageName, String fileName, IJavaElement javaElement)

Method Summary

Modifier and Type	Method	Description
char[]	getContents()	Answer the contents of the compilation unit.
char[]	getFileName()	Answer the file name which defines the type.
char[]	getMainTypeName()	Answer the name of the top level public type.
char[]	getModuleName()	Returns the name of the module to which this compilation unit is associated.
char[][]	getPackageName()	Answer the name of the package according to the directory structure or null if package consistency checks should be ignored.
boolean	ignoreOptionalProblems()	Answer if optional problems should be ignored for this compilation unit.
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.aspectj.org.eclipse.jdt.internal.compiler.env.ICompilationUnit

getDestinationPath, getExternalAnnotationPath, module

Field Details

contents

protected final char[] contents

fileName

protected final char[] fileName

packageName

protected final char[][] packageName

mainTypeName

protected char[] mainTypeName

moduleName

protected char[] moduleName

encoding

protected String encoding

Constructor Details

BasicCompilationUnit

@Deprecated
public BasicCompilationUnit(char[] contents,
 char[][] packageName,
 String fileName,
 String encoding)

Deprecated.

Should pass a javaElement via BasicCompilationUnit(char[], char[][], String, IJavaElement).

BasicCompilationUnit

public BasicCompilationUnit(char[] contents,
 char[][] packageName,
 String fileName,
 IJavaElement javaElement)

Method Details

getContents

public char[] getContents()

Description copied from interface: ICompilationUnit

Answer the contents of the compilation unit. In normal use, the contents are requested twice. Once during the initial lite parsing step, then again for the more detailed parsing step. Implementors must never return null - return an empty char[] instead, CharOperation.NO_CHAR being the candidate of choice.

Specified by:

getContents in interface ICompilationUnit

getFileName

public char[] getFileName()

Description copied from interface: IDependent

Answer the file name which defines the type. The path part (optional) must be separated from the actual file proper name by a separator suitable for the type (java.io.File.separator for example), e.g. "c:\\source\\com\\p\\X.java" or "/com/p/Y.java". The path to the zip or jar file (optional) must be separated from the actual path part by JAR_FILE_ENTRY_SEPARATOR, e.g. "c:\\lib\\some.jar|/com/p/X.class" or "/lib/some.zip|/com/q/Y.class". The proper file name includes the suffix extension (e.g. ".java") e.g. "c:/org/eclipse/jdt/internal/compileri/env/IDependent.java" Return null if no file defines the type.

Specified by:

getFileName in interface IDependent

See Also:

• invalid reference

  org.eclipse.jdt.internal.compiler.env.IDependent#getFileName()

getMainTypeName

public char[] getMainTypeName()

Description copied from interface: ICompilationUnit

Answer the name of the top level public type. For example, {Hashtable}.

Specified by:

getMainTypeName in interface ICompilationUnit

getPackageName

public char[][] getPackageName()

Description copied from interface: ICompilationUnit

Answer the name of the package according to the directory structure or null if package consistency checks should be ignored. For example, {java, lang}.

Specified by:

getPackageName in interface ICompilationUnit

ignoreOptionalProblems

public boolean ignoreOptionalProblems()

Description copied from interface: ICompilationUnit

Answer if optional problems should be ignored for this compilation unit. Implementors should return false if there is no preference.

Specified by:

ignoreOptionalProblems in interface ICompilationUnit

toString

public String toString()

Overrides:

toString in class Object

getModuleName

public char[] getModuleName()

Description copied from interface: ICompilationUnit

Returns the name of the module to which this compilation unit is associated. A return value of null signals the unnamed module.

Specified by:

getModuleName in interface ICompilationUnit

Returns:

module name or null for the unnamed module.