org.eclipse.xtend.shared.ui.core
Interface IXtendXpandProject

All Superinterfaces:
org.eclipse.core.runtime.IAdaptable
All Known Implementing Classes:
XtendXpandProject

public interface IXtendXpandProject
extends org.eclipse.core.runtime.IAdaptable

Represents a project containing openArchitectureWare resources. These are Xpand template, Xtend files, Workflow files etc.

Since:
4.0

Method Summary
 void analyze(org.eclipse.core.runtime.IProgressMonitor monitor, ExecutionContext ctx)
          Analyzes the project's resources and marks erraneous resources.
 IXtendXpandResource findExtXptResource(java.lang.String fqn, java.lang.String extension)
          Finds an Xtend resource by its fully qualified name and file extension.
 IXtendXpandResource findXtendXpandResource(org.eclipse.core.resources.IStorage file)
          Finds an Xtend resource by it's underlying IStorage instance
 IXtendXpandProject[] getAllReferencedProjects()
           
 IXtendXpandResource[] getAllRegisteredResources()
           
 org.eclipse.jdt.core.IJavaProject getProject()
          Returns the corresponding Java Project.
 IXtendXpandProject[] getReferencedProjects()
           
 IXtendXpandResource[] getRegisteredResources()
          Returns all registered resources within the project.
 void unregisterXtendXpandResource(IXtendXpandResource res)
          Unregisters a resource from the project.
 
Methods inherited from interface org.eclipse.core.runtime.IAdaptable
getAdapter
 

Method Detail

findExtXptResource

IXtendXpandResource findExtXptResource(java.lang.String fqn,
                                       java.lang.String extension)
Finds an Xtend resource by its fully qualified name and file extension.

Parameters:
fqn - The full qualified name in Xtend syntax. For example: my::templates::Main
Returns:
The resource or null if the resource could not be located.

findXtendXpandResource

IXtendXpandResource findXtendXpandResource(org.eclipse.core.resources.IStorage file)
Finds an Xtend resource by it's underlying IStorage instance

Parameters:
-
Returns:
The resource or null if the resource could not be located (i.e it's not an Xtend/Xpand resource).

getRegisteredResources

IXtendXpandResource[] getRegisteredResources()
Returns all registered resources within the project.

Returns:

getProject

org.eclipse.jdt.core.IJavaProject getProject()
Returns the corresponding Java Project.


unregisterXtendXpandResource

void unregisterXtendXpandResource(IXtendXpandResource res)
Unregisters a resource from the project.

Parameters:
res - Resource which should be unregistered.

analyze

void analyze(org.eclipse.core.runtime.IProgressMonitor monitor,
             ExecutionContext ctx)
Analyzes the project's resources and marks erraneous resources.

Parameters:
monitor - (optional) A monitor for the progress of the analysis.

getAllRegisteredResources

IXtendXpandResource[] getAllRegisteredResources()

getReferencedProjects

IXtendXpandProject[] getReferencedProjects()

getAllReferencedProjects

IXtendXpandProject[] getAllReferencedProjects()