Package com.intellij.psi.search.scope.packageSet

Class NamedScopesHolder

java.lang.Object

com.intellij.psi.search.scope.packageSet.NamedScopesHolder

All Implemented Interfaces:

PersistentStateComponent<Element>

Direct Known Subclasses:

DependencyValidationManager, NamedScopeManager

public abstract class NamedScopesHolder
extends java.lang.Object
implements PersistentStateComponent<Element>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	NamedScopesHolder.ScopeListener

Field Summary

Fields

Modifier and Type	Field and Description
protected Project	myProject

Constructor Summary

Constructors

Constructor and Description
NamedScopesHolder(Project project)

Method Summary

Modifier and Type	Method and Description
void	addScope(NamedScope scope)
void	addScopeListener(NamedScopesHolder.ScopeListener scopeListener) Deprecated. use addScopeListener(ScopeListener, Disposable) instead
void	addScopeListener(NamedScopesHolder.ScopeListener scopeListener, Disposable parentDisposable)
NamedScope	createScope(java.lang.String name, PackageSet value)
void	fireScopeListeners()
static NamedScopesHolder []	getAllNamedScopeHolders(Project project)
abstract java.lang.String	getDisplayName()
NamedScope []	getEditableScopes()
static NamedScopesHolder	getHolder(Project project, java.lang.String scopeName, NamedScopesHolder defaultHolder)
abstract javax.swing.Icon	getIcon()
NamedScope	getPredefinedScope(java.lang.String name)
java.util.List<NamedScope>	getPredefinedScopes()
Project	getProject()
VirtualFile	getProjectBaseDir()
static NamedScope	getScope(Project project, java.lang.String scopeName)
NamedScope	getScope(java.lang.String name)
NamedScope []	getScopes()
Element	getState()
void	loadState(Element state) This method is called when new component state is loaded.
void	removeAllSets()
void	setScopes(NamedScope [] scopes)

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

Field Detail

myProject

protected final Project myProject

Constructor Detail

NamedScopesHolder

public NamedScopesHolder(Project project)

Method Detail

getDisplayName

public abstract java.lang.String getDisplayName()

getIcon

public abstract javax.swing.Icon getIcon()

getProjectBaseDir

public VirtualFile getProjectBaseDir()

addScopeListener

@Deprecated
public void addScopeListener(NamedScopesHolder.ScopeListener scopeListener)

Deprecated. use addScopeListener(ScopeListener, Disposable) instead

addScopeListener

public void addScopeListener(NamedScopesHolder.ScopeListener scopeListener,
                             Disposable parentDisposable)

fireScopeListeners

public void fireScopeListeners()

getScopes

public NamedScope [] getScopes()

getEditableScopes

public NamedScope [] getEditableScopes()

removeAllSets

public void removeAllSets()

setScopes

public void setScopes(NamedScope [] scopes)

addScope

public void addScope(NamedScope scope)

getScope

public static NamedScope getScope(Project project,
                                  java.lang.String scopeName)

getAllNamedScopeHolders

public static NamedScopesHolder [] getAllNamedScopeHolders(Project project)

getHolder

public static NamedScopesHolder getHolder(Project project,
                                          java.lang.String scopeName,
                                          NamedScopesHolder defaultHolder)

loadState

public void loadState(Element state)

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:

state - loaded component state

See Also:

XmlSerializerUtil.copyBean(Object, Object)

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

getScope

public NamedScope getScope(java.lang.String name)

getPredefinedScopes

public java.util.List<NamedScope> getPredefinedScopes()

getPredefinedScope

public NamedScope getPredefinedScope(java.lang.String name)

getProject

public Project getProject()

createScope

public final NamedScope createScope(java.lang.String name,
                                    PackageSet value)