Package com.intellij.openapi.application

Class PathMacros

java.lang.Object

com.intellij.openapi.application.PathMacros

public abstract class PathMacros
extends java.lang.Object

Stores predefined and custom (user-defined) path variables. Path variables are used to convert paths from absolute to portable form and vice versa. It allows us to reuse project configuration files on different machines.

In order to make a path (or URL) portable the serialization subsystem replaces its prefix by name of a corresponding path variable. There are predefined path variables and also it's possible to specify custom path variables.

Constructor Summary

Constructors

Constructor and Description
PathMacros()

Method Summary

Modifier and Type	Method and Description
abstract void	addIgnoredMacro(java.lang.String name)
abstract java.util.Set<java.lang.String>	getAllMacroNames()
abstract java.util.Collection<java.lang.String>	getIgnoredMacroNames()
static PathMacros	getInstance()
abstract java.util.Collection<java.lang.String>	getLegacyMacroNames()
abstract java.util.Set<java.lang.String>	getSystemMacroNames()
abstract java.util.Set<java.lang.String>	getUserMacroNames()
abstract java.util.Map<java.lang.String,java.lang.String>	getUserMacros()
abstract java.lang.String	getValue(java.lang.String name)
abstract boolean	isIgnoredMacroName(java.lang.String macro)
abstract void	removeAllMacros()
void	removeMacro(java.lang.String name) Deprecated. Use PathMacroContributor
abstract void	setIgnoredMacroNames(java.util.Collection<java.lang.String> names)
abstract void	setMacro(java.lang.String name, java.lang.String value) Consider using PathMacroContributor.

Methods inherited from class java.lang.Object

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

Constructor Detail

PathMacros

public PathMacros()

Method Detail

getInstance

public static PathMacros getInstance()

getAllMacroNames

public abstract java.util.Set<java.lang.String> getAllMacroNames()

getValue

public abstract java.lang.String getValue(java.lang.String name)

setMacro

public abstract void setMacro(java.lang.String name,
                              java.lang.String value)

Consider using PathMacroContributor.

removeMacro

@Deprecated
public void removeMacro(java.lang.String name)

Deprecated. Use PathMacroContributor

getUserMacroNames

public abstract java.util.Set<java.lang.String> getUserMacroNames()

getUserMacros

public abstract java.util.Map<java.lang.String,java.lang.String> getUserMacros()

getSystemMacroNames

public abstract java.util.Set<java.lang.String> getSystemMacroNames()

getIgnoredMacroNames

public abstract java.util.Collection<java.lang.String> getIgnoredMacroNames()

setIgnoredMacroNames

public abstract void setIgnoredMacroNames(java.util.Collection<java.lang.String> names)

addIgnoredMacro

public abstract void addIgnoredMacro(java.lang.String name)

isIgnoredMacroName

public abstract boolean isIgnoredMacroName(java.lang.String macro)

removeAllMacros

public abstract void removeAllMacros()

getLegacyMacroNames

public abstract java.util.Collection<java.lang.String> getLegacyMacroNames()