Class JavaSource

Method Details

• getFileName

  public String getFileName()

  Gets the file name.

• dispose

  protected boolean dispose()

  Disposes of the Java source and all its classes. No call to Java Manager. is done, this call is initiated from there.

  Returns:

  true if disposed of, false if already disposed of.

• isDisposed

  public boolean isDisposed()

  Checks if the instance is disposed of.

• getJavaClassCount

  protected int getJavaClassCount()

  Gets the JavaClass count, for assertions.

• getJavaProject

  public IJavaProject getJavaProject()

  Gets the Java project when class is UNRESOLVED or PARSED.

  Returns:

  The Java project if possible to retrieve, null otherwise.

• getSourceFile

  public IFile getSourceFile()

  Gets the ".java" source file for PARSED.

  Returns:

  The file, null if BINARY or UNRESOLVED.

• getProject

  public IProject getProject()

  Attempts to locate the IProject of the Java source file.

  Returns:

  The project, or null if not found.

• getClass

  public JavaClass getClass(String className, IType javaType, IClassReferenceListener listener)

  Called to add a new class name or to get an existing one.

  Parameters:

  className - The fully qualified class name.

  javaType - The resolved type or null if not resolved.

  listener - The listener for the JavaClass.

  Returns:

  A new or existing instance of the JavaClass for the type, with a reference listener.

• getType

  public JavaSource.Type getType()

  Gets the file type.

• onJavaSourceRemoved

  protected boolean onJavaSourceRemoved(IFile file)

  Called when a Java source has been removed.

  Parameters:

  file - The file handle.

  Returns:

  true if the file belonged to this class, false otherwise.

• onJavaSourceMoved

  protected void onJavaSourceMoved(IFile newFile, String oldPKG, String newPKG)

  Called when a Java source has been moved or renamed. The getSourceFile() method in JavaSource is already moved or renamed when this method is called.

  Parameters:

  newFile - The new file name.

  oldPKG - The old class name of the main class.

  newPKG - The new class name of the main class.

• onRefactoringChange

  protected void onRefactoringChange(String classFQN, String oldFQN, String newFQN)

  Called from Refactoring Rename for classes or methods. The "FQN" is for classes including packages, and enclosed classes are separated by '.' and not '$'. For methods, it's the name followed by ',' and "returnType(param1,..,paramN)" as JavaHelper.getSignature gives.

  Parameters:

  classFQN - The class fully qualified name, null for classes (only for methods).

  oldFQN - The old fully qualified name or "oldName,signature".

  newFQN - The new fully qualified name or "newName,signature".

• resolveClassReferences

  public void resolveClassReferences()

  When a SOURCE file is touched, e.g. changed or added in the workspace, this method attempts to resolve the class references.

  When a Java file is touched, it's package name will attempt to resolve UNRESOLVED classes.

• triggerSWTChangeEvent

  public void triggerSWTChangeEvent()

  Triggers an SWT changed event to the JavaClass listeners to perform resolve, etc.

• clearCache

  protected void clearCache()

  Clears the cache.

• validateClass

  public String validateClass(IType type, String implementsInterface, String requiredAnnotation, String annotationParam, String annotationValue)

  Validates the class for the interface and annotation.

  Parameters:

  implementsInterface - The interface required, or null for none.

  requiredAnnotation - The required annotation, or null for none.

  annotationParam - Parameter member value pair to verify the value with for back-referencing, null for none.

  annotationValue - The value to match for back-referencing, null for none.

  Returns:

  null for OK, otherwise an error message.

• validateClassProcessors

  protected String validateClassProcessors(IType type, String implementsInterface, String requiredAnnotation, String annotationParam, String annotationValue)

  Validates the class for the interface and annotation.

  Parameters:

  implementsInterface - The interface required, or null for none.

  requiredAnnotation - The required annotation, or null for none.

  annotationParam - Parameter member value pair to verify the value with for back-referencing, null for none.

  annotationValue - The value to match for back-referencing, null for none.

  Returns:

  null for OK, otherwise an error message.

• validateMethod

  public MethodLookup validateMethod(IType type, String method, boolean isStatic, String requiredAnnotation, String annotationParam, String annotationValue, boolean allowAll)

  Validates the method for the annotation.

  Parameters:

  type - Type containing method.

  method - The method name.

  isStatic - Method must be static flag.

  requiredAnnotation - The required annotation, or null for none.

  annotationParam - Parameter member value pair to verify the value with for back-referencing, null for none.

  annotationValue - The value to match for back-referencing, null for none.

  allowAll - Flag to allow a ref "*" as back-reference.

  Returns:

  The method look-up.

• validateMethodProcessors

  protected MethodLookup validateMethodProcessors(IType type, String method, boolean isStatic, String requiredAnnotation, String annotationParam, String annotationValue, boolean allowAll)

  Validates the method for the annotation.

  Parameters:

  method - The method name.

  isStatic - Method must be static flag.

  requiredAnnotation - The required annotation, or null for none.

  annotationParam - Parameter member value pair to verify the value with for back-referencing, null for none.

  annotationValue - The value to match for back-referencing, null for none.

  allowAll - Flag to allow a ref "*" as back-reference.

  Returns:

  The method look-up or null if not processed.

• getPublicOrStaticClasses

  protected void getPublicOrStaticClasses(ArrayList<JavaClass> list)

  Gets all the JavaClasses available in all projects that are parsed. Matching classes are public and public static inner classes.