Package com.intellij.lang

Class PerFileMappingsBase<T>

java.lang.Object

com.intellij.lang.PerFileMappingsBase<T>

All Implemented Interfaces:

PerFileMappings<T>, PersistentStateComponent<Element>, Disposable

Direct Known Subclasses:

LanguagePerFileMappings

public abstract class PerFileMappingsBase<T>
extends java.lang.Object
implements PersistentStateComponent<Element>, PerFileMappings<T>, Disposable

Nested Class Summary

Nested classes/interfaces inherited from interface com.intellij.openapi.Disposable

Disposable.Parent

Constructor Summary

Constructors

Constructor and Description
PerFileMappingsBase()

Method Summary

Modifier and Type	Method and Description
void	cleanupForNextTest()
void	dispose() Usually not invoked directly, see class javadoc.
abstract java.util.List<T>	getAvailableValues()
T	getConfiguredMapping(VirtualFile file)
T	getDefaultMapping(VirtualFile file)
T	getDirectlyConfiguredMapping(VirtualFile file)
protected FilePropertyPusher<T>	getFilePropertyPusher()
T	getImmediateMapping(VirtualFile file)
T	getMapping(VirtualFile file)
java.util.Map<VirtualFile,T>	getMappings()
protected T	getNotInHierarchy(VirtualFile file, java.util.Map<VirtualFile,T> mappings)
protected Project	getProject()
Element	getState()
protected java.lang.String	getValueAttribute() Deprecated.
protected T	handleUnknownMapping(VirtualFile file, java.lang.String value)
boolean	hasMappings()
void	loadState(Element element) This method is called when new component state is loaded.
protected abstract java.lang.String	serialize(T t)
void	setMapping(VirtualFile file, T value)
void	setMappings(java.util.Map<VirtualFile,T> mappings)
protected boolean	shouldReparseFiles()

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.intellij.openapi.components.PersistentStateComponent

initializeComponent, noStateLoaded

Constructor Detail

PerFileMappingsBase

public PerFileMappingsBase()

Method Detail

dispose

public void dispose()

Description copied from interface: Disposable

Usually not invoked directly, see class javadoc.

Specified by:

dispose in interface Disposable

getFilePropertyPusher

protected FilePropertyPusher<T> getFilePropertyPusher()

getProject

protected Project getProject()

getMappings

public java.util.Map<VirtualFile,T> getMappings()

Specified by:

getMappings in interface PerFileMappings<T>

getMapping

public T getMapping(VirtualFile file)

Specified by:

getMapping in interface PerFileMappings<T>

getConfiguredMapping

public T getConfiguredMapping(VirtualFile file)

getDirectlyConfiguredMapping

public T getDirectlyConfiguredMapping(VirtualFile file)

getNotInHierarchy

protected T getNotInHierarchy(VirtualFile file,
                              java.util.Map<VirtualFile,T> mappings)

getDefaultMapping

public T getDefaultMapping(VirtualFile file)

Specified by:

getDefaultMapping in interface PerFileMappings<T>

getImmediateMapping

public T getImmediateMapping(VirtualFile file)

setMappings

public void setMappings(java.util.Map<VirtualFile,T> mappings)

Specified by:

setMappings in interface PerFileMappings<T>

setMapping

public void setMapping(VirtualFile file,
                       T value)

Specified by:

setMapping in interface PerFileMappings<T>

getAvailableValues

public abstract java.util.List<T> getAvailableValues()

serialize

protected abstract java.lang.String serialize(T t)

getState

public Element getState()

Specified by:

getState in interface PersistentStateComponent<Element>

Returns:

a component state. All properties, public and annotated fields are serialized. Only values, which differ from the default (i.e., the value of newly instantiated class) are serialized. null value indicates that the returned state won't be stored, as a result previously stored state will be used.

See Also:

XmlSerializer

handleUnknownMapping

protected T handleUnknownMapping(VirtualFile file,
                                 java.lang.String value)

getValueAttribute

@Deprecated
protected java.lang.String getValueAttribute()

Deprecated.

loadState

public void loadState(Element element)

Description copied from interface: PersistentStateComponent

This method is called when new component state is loaded. The method can and will be called several times, if config files were externally changed while IDE was running.

State object should be used directly, defensive copying is not required.

Specified by:

loadState in interface PersistentStateComponent<Element>

Parameters:

element - loaded component state

See Also:

XmlSerializerUtil.copyBean(Object, Object)

cleanupForNextTest

public void cleanupForNextTest()

shouldReparseFiles

protected boolean shouldReparseFiles()

hasMappings

public boolean hasMappings()