Package com.intellij.openapi.roots.impl.libraries

Class LibraryTableBase

java.lang.Object

com.intellij.openapi.roots.impl.libraries.LibraryTableBase

All Implemented Interfaces:

PersistentStateComponent<Element>, Disposable, LibraryTable

Direct Known Subclasses:

ApplicationLibraryTable

public abstract class LibraryTableBase
extends java.lang.Object
implements PersistentStateComponent<Element>, LibraryTable, Disposable

Nested Class Summary

Nested classes/interfaces inherited from interface com.intellij.openapi.roots.libraries.LibraryTable

LibraryTable.Listener, LibraryTable.ModifiableModel

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

Disposable.Parent

Constructor Summary

Constructors

Constructor and Description
LibraryTableBase()

Method Summary

Modifier and Type	Method and Description
void	addListener(LibraryTable.Listener listener)
void	addListener(LibraryTable.Listener listener, Disposable parentDisposable)
Library	createLibrary()
Library	createLibrary(java.lang.String name)
void	dispose() Usually not invoked directly, see class javadoc.
Library []	getLibraries()
Library	getLibraryByName(java.lang.String name)
java.util.Iterator<Library>	getLibraryIterator()
LibraryTable.ModifiableModel	getModifiableModel() Returns the interface which allows to create or removed libraries from the table.
Element	getState()
long	getStateModificationCount()
void	loadState(Element element) This method is called when new component state is loaded.
void	noStateLoaded() This method is called when the component is initialized, but no state is persisted.
void	readExternal(Element element)
void	removeLibrary(Library library)
void	removeListener(LibraryTable.Listener listener)
void	writeExternal(Element element)

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

Methods inherited from interface com.intellij.openapi.roots.libraries.LibraryTable

getPresentation, getTableLevel, isEditable

Constructor Detail

LibraryTableBase

public LibraryTableBase()

Method Detail

getModifiableModel

public LibraryTable.ModifiableModel getModifiableModel()

Description copied from interface: LibraryTable

Returns the interface which allows to create or removed libraries from the table. The returned model must be either committed LibraryTable.ModifiableModel.commit() or disposed Disposer.dispose(Disposable)

Specified by:

getModifiableModel in interface LibraryTable

Returns:

the modifiable library table model.

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

noStateLoaded

public void noStateLoaded()

Description copied from interface: PersistentStateComponent

This method is called when the component is initialized, but no state is persisted.

Specified by:

noStateLoaded in interface PersistentStateComponent<Element>

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)

getStateModificationCount

public long getStateModificationCount()

getLibraries

public Library [] getLibraries()

Specified by:

getLibraries in interface LibraryTable

getLibraryIterator

public java.util.Iterator<Library> getLibraryIterator()

Specified by:

getLibraryIterator in interface LibraryTable

getLibraryByName

public Library getLibraryByName(java.lang.String name)

Specified by:

getLibraryByName in interface LibraryTable

addListener

public void addListener(LibraryTable.Listener listener)

Specified by:

addListener in interface LibraryTable

addListener

public void addListener(LibraryTable.Listener listener,
                        Disposable parentDisposable)

Specified by:

addListener in interface LibraryTable

removeListener

public void removeListener(LibraryTable.Listener listener)

Specified by:

removeListener in interface LibraryTable

dispose

public void dispose()

Description copied from interface: Disposable

Usually not invoked directly, see class javadoc.

Specified by:

dispose in interface Disposable

createLibrary

public Library createLibrary()

Specified by:

createLibrary in interface LibraryTable

createLibrary

public Library createLibrary(java.lang.String name)

Specified by:

createLibrary in interface LibraryTable

removeLibrary

public void removeLibrary(Library library)

Specified by:

removeLibrary in interface LibraryTable

readExternal

public void readExternal(Element element)
                  throws InvalidDataException

Throws:

InvalidDataException

writeExternal

public void writeExternal(Element element)
                   throws WriteExternalException

Throws:

WriteExternalException