Package com.intellij.openapi.components

Interface PathMacroSubstitutor

All Known Subinterfaces:

TrackingPathMacroSubstitutor

All Known Implementing Classes:

ModulePathMacroManager, PathMacroManager, ProjectPathMacroManager

public interface PathMacroSubstitutor

Provides methods to convert paths from absolute to portable form and vice versa.

See Also:

PathMacros

Method Summary

Modifier and Type	Method and Description
default java.lang.String	collapsePath(java.lang.String text)
java.lang.String	collapsePath(java.lang.String text, boolean recursively) Convert paths inside text to portable form by replacing all values of path variables by their names.
default void	collapsePaths(Element element)
void	collapsePaths(Element element, boolean recursively) Process sub tags of element recursively and convert paths to portable forms in all tag texts and attribute values.
default void	collapsePathsRecursively(Element element)
java.lang.String	expandPath(java.lang.String text) Convert path to absolute by replacing all names of path variables by its values
void	expandPaths(Element element) Process sub tags of element recursively and convert paths to absolute forms in all tag texts and attribute values.

Method Detail

expandPath

java.lang.String expandPath(java.lang.String text)

Convert path to absolute by replacing all names of path variables by its values

collapsePath

default java.lang.String collapsePath(java.lang.String text)

collapsePath

java.lang.String collapsePath(java.lang.String text,
                              boolean recursively)

Convert paths inside text to portable form by replacing all values of path variables by their names.

Parameters:

recursively - if true all occurrences of paths inside text will be processed, otherwise text will be converted only if its entire content is a path (or URL)

expandPaths

void expandPaths(Element element)

Process sub tags of element recursively and convert paths to absolute forms in all tag texts and attribute values.

collapsePaths

default void collapsePaths(Element element)

collapsePathsRecursively

default void collapsePathsRecursively(Element element)

collapsePaths

void collapsePaths(Element element,
                   boolean recursively)

Process sub tags of element recursively and convert paths to portable forms in all tag texts and attribute values.

Parameters:

recursively - if true all occurrences of paths inside tag texts and attribute values will be processed, otherwise they will be converted only if their entire content is a path (or URL)