Package com.intellij.openapi.paths

Class PathReferenceManager

java.lang.Object

com.intellij.openapi.paths.PathReferenceManager

Direct Known Subclasses:

PathReferenceManagerImpl

public abstract class PathReferenceManager
extends java.lang.Object

See Also:

PathReferenceProvider

Field Summary

Fields

Modifier and Type	Field and Description
static ExtensionPointName<PathReferenceProvider>	ANCHOR_REFERENCE_PROVIDER_EP
static ExtensionPointName<PathReferenceProvider>	PATH_REFERENCE_PROVIDER_EP

Constructor Summary

Constructors

Constructor and Description
PathReferenceManager()

Method Summary

Modifier and Type	Method and Description
abstract PsiReference []	createCustomReferences(PsiElement psiElement, boolean soft, PathReferenceProvider... providers)
abstract PsiReference[]	createReferences(PsiElement psiElement, boolean soft, boolean endingSlashNotAllowed, boolean relativePathsAllowed, FileType[] suitableFileTypes, PathReferenceProvider... additionalProviders)
abstract PsiReference []	createReferences(PsiElement psiElement, boolean soft, boolean endingSlashNotAllowed, boolean relativePathsAllowed, PathReferenceProvider... additionalProviders) Create web path references for given PsiElement.
abstract PsiReference []	createReferences(PsiElement psiElement, boolean soft, PathReferenceProvider... additionalProviders) Create web path references for given PsiElement.
abstract PathReferenceProvider	createStaticPathReferenceProvider(boolean relativePathsAllowed)
abstract PathReference	getCustomPathReference(java.lang.String path, Module module, PsiElement element, PathReferenceProvider... providers)
abstract PathReferenceProvider	getGlobalWebPathReferenceProvider()
static PathReferenceManager	getInstance()
abstract PathReference	getPathReference(java.lang.String path, PsiElement element, PathReferenceProvider... additionalProviders)
static PsiReference[]	getReferencesFromProvider(PathReferenceProvider provider, PsiElement psiElement, boolean soft)

Methods inherited from class java.lang.Object

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

Field Detail

PATH_REFERENCE_PROVIDER_EP

public static final ExtensionPointName<PathReferenceProvider> PATH_REFERENCE_PROVIDER_EP

ANCHOR_REFERENCE_PROVIDER_EP

public static final ExtensionPointName<PathReferenceProvider> ANCHOR_REFERENCE_PROVIDER_EP

Constructor Detail

PathReferenceManager

public PathReferenceManager()

Method Detail

getInstance

public static PathReferenceManager getInstance()

createReferences

public abstract PsiReference [] createReferences(PsiElement psiElement,
                                                 boolean soft,
                                                 PathReferenceProvider... additionalProviders)

Create web path references for given PsiElement. The same as createReferences(PsiElement, boolean, boolean, boolean, PathReferenceProvider[]) with endingSlashNotAllowed = true and relativePathsAllowed = true.

Parameters:

psiElement - the underlying PSI element.

soft - set this to true to create soft references (see PsiReference.isSoft()).

additionalProviders - additional providers to process.

Returns:

created references or an empty array.

createReferences

public abstract PsiReference [] createReferences(PsiElement psiElement,
                                                 boolean soft,
                                                 boolean endingSlashNotAllowed,
                                                 boolean relativePathsAllowed,
                                                 PathReferenceProvider... additionalProviders)

Create web path references for given PsiElement.

Parameters:

psiElement - the underlying PSI element.

soft - set this to true to create soft references (see PsiReference.isSoft()).

endingSlashNotAllowed - true if paths like "/foo/" should not be resolved.

relativePathsAllowed - true if the folder of the file containing the PsiElement should be used as "root". Otherwise, web application root will be used.

additionalProviders - additional providers to process. @return created references or an empty array.

createReferences

public abstract PsiReference[] createReferences(PsiElement psiElement,
                                                boolean soft,
                                                boolean endingSlashNotAllowed,
                                                boolean relativePathsAllowed,
                                                FileType[] suitableFileTypes,
                                                PathReferenceProvider... additionalProviders)

createCustomReferences

public abstract PsiReference [] createCustomReferences(PsiElement psiElement,
                                                       boolean soft,
                                                       PathReferenceProvider... providers)

getPathReference

public abstract PathReference getPathReference(java.lang.String path,
                                               PsiElement element,
                                               PathReferenceProvider... additionalProviders)

getCustomPathReference

public abstract PathReference getCustomPathReference(java.lang.String path,
                                                     Module module,
                                                     PsiElement element,
                                                     PathReferenceProvider... providers)

getGlobalWebPathReferenceProvider

public abstract PathReferenceProvider getGlobalWebPathReferenceProvider()

createStaticPathReferenceProvider

public abstract PathReferenceProvider createStaticPathReferenceProvider(boolean relativePathsAllowed)

getReferencesFromProvider

public static PsiReference[] getReferencesFromProvider(PathReferenceProvider provider,
                                                       PsiElement psiElement,
                                                       boolean soft)