org.eclipse.xtext.ui.resource

Class Storage2UriMapperJavaImpl

java.lang.Object

org.eclipse.xtext.ui.resource.Storage2UriMapperJavaImpl

All Implemented Interfaces:

org.eclipse.jdt.core.IElementChangedListener, IStorage2UriMapperContribution, IStorage2UriMapperJdtExtensions

public class Storage2UriMapperJavaImpl
extends java.lang.Object
implements IStorage2UriMapperJdtExtensions, IStorage2UriMapperContribution, org.eclipse.jdt.core.IElementChangedListener

Author:

Sven Efftinge - Initial contribution and API

This class is not intended to be subclassed by clients.

This class is not intended to be subclassed by clients.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Storage2UriMapperJavaImpl.PackageFragmentRootData

Constructor Summary

Constructors

Constructor and Description
Storage2UriMapperJavaImpl()

Method Summary

Methods

Modifier and Type	Method and Description
void	elementChanged(org.eclipse.jdt.core.ElementChangedEvent event)
java.util.Map<org.eclipse.emf.common.util.URI,org.eclipse.core.resources.IStorage>	getAllEntries(org.eclipse.jdt.core.IPackageFragmentRoot root)
java.lang.Iterable<Pair<org.eclipse.core.resources.IStorage,org.eclipse.core.resources.IProject>>	getStorages(org.eclipse.emf.common.util.URI uri) Returns all the pairs of IStorage and IProject that map to the given URI, e.g. if the uri points to an archive file that is used by different projects, all known references should be returned.
org.eclipse.emf.common.util.URI	getUri(org.eclipse.core.resources.IStorage storage) Returns the URI for the given storage or null if this contribution does no handle the storage explicitly.
Pair<org.eclipse.emf.common.util.URI,org.eclipse.emf.common.util.URI>	getURIMapping(org.eclipse.jdt.core.IPackageFragmentRoot root)
void	initializeCache() Initialize any local caching.
protected Storage2UriMapperJavaImpl.PackageFragmentRootData	initializeData(org.eclipse.jdt.core.IPackageFragmentRoot root)
boolean	isRejected(org.eclipse.core.resources.IFolder folder) Rejects Java output folders when traversing a project.
void	setHost(IStorage2UriMapper host) Public for testing purpose
void	setJdtHelper(IJdtHelper jdtHelper) Public for testing purpose
void	setLocator(JarEntryLocator locator) Public for testing purpose
void	setUriValidator(UriValidator uriValidator) Public for testing purpose

Methods inherited from class java.lang.Object

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

Constructor Detail

Storage2UriMapperJavaImpl

public Storage2UriMapperJavaImpl()

Method Detail

setJdtHelper

public void setJdtHelper(IJdtHelper jdtHelper)

Public for testing purpose

Since:

2.4

This method is not intended to be referenced by clients.

This method is not intended to be referenced by clients.

This method is not intended to be extended (re-implement with a call to the overridden parent) or re-implemented (with no call to the overridden parent) by clients.

This method is not intended to be re-implemented or extended by clients.

setLocator

public void setLocator(JarEntryLocator locator)

Public for testing purpose

This method is not intended to be referenced by clients.

This method is not intended to be referenced by clients.

This method is not intended to be extended (re-implement with a call to the overridden parent) or re-implemented (with no call to the overridden parent) by clients.

This method is not intended to be re-implemented or extended by clients.

setUriValidator

public void setUriValidator(UriValidator uriValidator)

Public for testing purpose

This method is not intended to be referenced by clients.

This method is not intended to be referenced by clients.

This method is not intended to be extended (re-implement with a call to the overridden parent) or re-implemented (with no call to the overridden parent) by clients.

This method is not intended to be re-implemented or extended by clients.

setHost

public void setHost(IStorage2UriMapper host)

Public for testing purpose

Since:

2.5

This method is not intended to be referenced by clients.

This method is not intended to be referenced by clients.

This method is not intended to be extended (re-implement with a call to the overridden parent) or re-implemented (with no call to the overridden parent) by clients.

This method is not intended to be re-implemented or extended by clients.

isRejected

public boolean isRejected(org.eclipse.core.resources.IFolder folder)

Rejects Java output folders when traversing a project.

Specified by:

isRejected in interface IStorage2UriMapperContribution

Returns:

true if the folder is a java output folder. Otherwise false.

Since:

2.5

getURIMapping

public Pair<org.eclipse.emf.common.util.URI,org.eclipse.emf.common.util.URI> getURIMapping(org.eclipse.jdt.core.IPackageFragmentRoot root)
                                                                                    throws org.eclipse.jdt.core.JavaModelException

Specified by:

getURIMapping in interface IStorage2UriMapperJdtExtensions

Returns:

the URI mapping for the given IPackageFragmentRoot. The first entry in the pair is the possibly logical URI, the second the physical one.

Throws:

org.eclipse.jdt.core.JavaModelException

Since:

2.4

getAllEntries

public java.util.Map<org.eclipse.emf.common.util.URI,org.eclipse.core.resources.IStorage> getAllEntries(org.eclipse.jdt.core.IPackageFragmentRoot root)

Specified by:

getAllEntries in interface IStorage2UriMapperJdtExtensions

Returns:

all managed uris and their corresponding storages contained in the given IPackageFragmentRoot

Since:

2.4

initializeData

protected Storage2UriMapperJavaImpl.PackageFragmentRootData initializeData(org.eclipse.jdt.core.IPackageFragmentRoot root)

Since:

2.4

getStorages

public java.lang.Iterable<Pair<org.eclipse.core.resources.IStorage,org.eclipse.core.resources.IProject>> getStorages(org.eclipse.emf.common.util.URI uri)

Description copied from interface: IStorage2UriMapperContribution

Returns all the pairs of IStorage and IProject that map to the given URI, e.g. if the uri points to an archive file that is used by different projects, all known references should be returned.

Specified by:

getStorages in interface IStorage2UriMapperContribution

getUri

public org.eclipse.emf.common.util.URI getUri(org.eclipse.core.resources.IStorage storage)

Description copied from interface: IStorage2UriMapperContribution

Returns the URI for the given storage or null if this contribution does no handle the storage explicitly.

Specified by:

getUri in interface IStorage2UriMapperContribution

Since:

2.5

elementChanged

public void elementChanged(org.eclipse.jdt.core.ElementChangedEvent event)

Specified by:

elementChanged in interface org.eclipse.jdt.core.IElementChangedListener

initializeCache

public void initializeCache()

Description copied from interface: IStorage2UriMapperContribution

Initialize any local caching. Called before first access.

Specified by:

initializeCache in interface IStorage2UriMapperContribution

Since:

2.4