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

Class LibraryImpl

java.lang.Object

com.intellij.openapi.util.TraceableDisposable

com.intellij.openapi.roots.impl.libraries.LibraryImpl

All Implemented Interfaces:

Disposable, LibraryEx, LibraryEx.ModifiableModelEx, Library, Library.ModifiableModel, ProjectModelElement, RootProvider, JDOMExternalizable

public class LibraryImpl
extends TraceableDisposable
implements LibraryEx.ModifiableModelEx, LibraryEx, RootProvider

Nested Class Summary

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

LibraryEx.ModifiableModelEx

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

Library.ModifiableModel

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

Disposable.Parent

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

RootProvider.RootSetChangedListener

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ELEMENT
static java.lang.String	EXCLUDED_ROOTS_TAG
static java.lang.String	LIBRARY_NAME_ATTR
static java.lang.String	LIBRARY_TYPE_ATTR
static java.lang.String	PROPERTIES_ELEMENT
static java.lang.String	ROOT_PATH_ELEMENT
static java.lang.String	ROOT_TYPE_ATTR

Fields inherited from interface com.intellij.openapi.roots.libraries.Library

EMPTY_ARRAY

Method Summary

Modifier and Type	Method and Description
void	addExcludedRoot(java.lang.String url) Add a URL to list of directories excluded from the library.
void	addJarDirectory(java.lang.String url, boolean recursive)
void	addJarDirectory(java.lang.String url, boolean recursive, OrderRootType rootType)
void	addJarDirectory(VirtualFile file, boolean recursive)
void	addJarDirectory(VirtualFile file, boolean recursive, OrderRootType rootType)
void	addRoot(java.lang.String url, OrderRootType rootType)
void	addRoot(VirtualFile file, OrderRootType rootType)
void	addRootSetChangedListener(RootProvider.RootSetChangedListener listener)
void	addRootSetChangedListener(RootProvider.RootSetChangedListener listener, Disposable parentDisposable)
Library	cloneLibrary(RootModelImpl rootModel)
void	commit()
void	dispose() Usually not invoked directly, see class javadoc.
boolean	equals(java.lang.Object o)
void	forgetKind() Removes custom library kind and associated properties if any
VirtualFile []	getExcludedRoots()
java.lang.String []	getExcludedRootUrls() Returns URLs of directories under the library roots which are excluded from the library.
ProjectModelExternalSource	getExternalSource() Return non-null value if this element was automatically created by the IDE during importing from some external project system rather than created by user manually via UI.
VirtualFile []	getFiles(OrderRootType rootType)
java.util.List<java.lang.String>	getInvalidRootUrls(OrderRootType type)
PersistentLibraryKind<?>	getKind()
LibraryEx.ModifiableModelEx	getModifiableModel() As soon as you obtaining modifiable model you will have to commit it or call Disposer.dispose(model)!
Module	getModule()
java.lang.String	getName()
LibraryProperties	getProperties()
RootProvider	getRootProvider()
Library	getSource() In case of modifiable library returns origin library it was created from
LibraryTable	getTable()
java.lang.String []	getUrls(OrderRootType rootType)
int	hashCode()
boolean	isChanged()
boolean	isDisposed()
boolean	isJarDirectory(java.lang.String url)
boolean	isJarDirectory(java.lang.String url, OrderRootType rootType)
boolean	isValid(java.lang.String url, OrderRootType rootType)
void	moveRootDown(java.lang.String url, OrderRootType rootType)
void	moveRootUp(java.lang.String url, OrderRootType rootType)
void	readExternal(Element element)
boolean	removeExcludedRoot(java.lang.String url)
boolean	removeRoot(java.lang.String url, OrderRootType rootType)
void	removeRootSetChangedListener(RootProvider.RootSetChangedListener listener)
void	restoreKind()
void	setKind(PersistentLibraryKind<?> kind)
void	setName(java.lang.String name)
void	setProperties(LibraryProperties properties)
java.lang.String	toString()
void	writeExternal(Element rootElement)

Methods inherited from class com.intellij.openapi.util.TraceableDisposable

getStackTrace, kill, killExceptionally, throwDisposalError, throwObjectNotDisposedError

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

LIBRARY_NAME_ATTR

public static final java.lang.String LIBRARY_NAME_ATTR

See Also:

Constant Field Values

LIBRARY_TYPE_ATTR

public static final java.lang.String LIBRARY_TYPE_ATTR

See Also:

Constant Field Values

ROOT_PATH_ELEMENT

public static final java.lang.String ROOT_PATH_ELEMENT

See Also:

Constant Field Values

ELEMENT

public static final java.lang.String ELEMENT

See Also:

Constant Field Values

PROPERTIES_ELEMENT

public static final java.lang.String PROPERTIES_ELEMENT

See Also:

Constant Field Values

EXCLUDED_ROOTS_TAG

public static final java.lang.String EXCLUDED_ROOTS_TAG

See Also:

Constant Field Values

ROOT_TYPE_ATTR

public static final java.lang.String ROOT_TYPE_ATTR

See Also:

Constant Field Values

Method Detail

dispose

public void dispose()

Description copied from interface: Disposable

Usually not invoked directly, see class javadoc.

Specified by:

dispose in interface Disposable

isDisposed

public boolean isDisposed()

Specified by:

isDisposed in interface LibraryEx

getName

public java.lang.String getName()

Specified by:

getName in interface Library

Specified by:

getName in interface Library.ModifiableModel

getUrls

public java.lang.String [] getUrls(OrderRootType rootType)

Specified by:

getUrls in interface Library

Specified by:

getUrls in interface Library.ModifiableModel

Specified by:

getUrls in interface RootProvider

getFiles

public VirtualFile [] getFiles(OrderRootType rootType)

Specified by:

getFiles in interface Library

Specified by:

getFiles in interface Library.ModifiableModel

Specified by:

getFiles in interface RootProvider

setName

public void setName(java.lang.String name)

Specified by:

setName in interface Library.ModifiableModel

getModifiableModel

public LibraryEx.ModifiableModelEx getModifiableModel()

Description copied from interface: Library

As soon as you obtaining modifiable model you will have to commit it or call Disposer.dispose(model)!

Specified by:

getModifiableModel in interface LibraryEx

Specified by:

getModifiableModel in interface Library

cloneLibrary

public Library cloneLibrary(RootModelImpl rootModel)

getInvalidRootUrls

public java.util.List<java.lang.String> getInvalidRootUrls(OrderRootType type)

Specified by:

getInvalidRootUrls in interface LibraryEx

setProperties

public void setProperties(LibraryProperties properties)

Specified by:

setProperties in interface LibraryEx.ModifiableModelEx

getRootProvider

public RootProvider getRootProvider()

Specified by:

getRootProvider in interface Library

getExternalSource

public ProjectModelExternalSource getExternalSource()

Description copied from interface: ProjectModelElement

Return non-null value if this element was automatically created by the IDE during importing from some external project system rather than created by user manually via UI. Configuration files corresponding to such elements will be stored separately so they won't pollute project directories. Also IDEs will show a warning if user tries to modify settings of such element because these changes may be lost after reimporting from the external model.

Specified by:

getExternalSource in interface ProjectModelElement

readExternal

public void readExternal(Element element)
                  throws InvalidDataException

Specified by:

readExternal in interface JDOMExternalizable

Throws:

InvalidDataException

writeExternal

public void writeExternal(Element rootElement)

Specified by:

writeExternal in interface JDOMExternalizable

getKind

public PersistentLibraryKind<?> getKind()

Specified by:

getKind in interface LibraryEx

Specified by:

getKind in interface LibraryEx.ModifiableModelEx

forgetKind

public void forgetKind()

Description copied from interface: LibraryEx.ModifiableModelEx

Removes custom library kind and associated properties if any

Specified by:

forgetKind in interface LibraryEx.ModifiableModelEx

restoreKind

public void restoreKind()

Specified by:

restoreKind in interface LibraryEx.ModifiableModelEx

addExcludedRoot

public void addExcludedRoot(java.lang.String url)

Description copied from interface: LibraryEx.ModifiableModelEx

Add a URL to list of directories excluded from the library. The directory specified by url must be located under some of the library roots.

Specified by:

addExcludedRoot in interface LibraryEx.ModifiableModelEx

Parameters:

url - URL of a directory to be excluded

See Also:

LibraryEx.getExcludedRootUrls()

removeExcludedRoot

public boolean removeExcludedRoot(java.lang.String url)

Specified by:

removeExcludedRoot in interface LibraryEx.ModifiableModelEx

getExcludedRootUrls

public java.lang.String [] getExcludedRootUrls()

Description copied from interface: LibraryEx

Returns URLs of directories under the library roots which are excluded from the library. Files under these directories won't be counted as belonging to this library so they won't be indexed.

Specified by:

getExcludedRootUrls in interface LibraryEx

Specified by:

getExcludedRootUrls in interface LibraryEx.ModifiableModelEx

Returns:

URLs of excluded directories

getExcludedRoots

public VirtualFile [] getExcludedRoots()

Specified by:

getExcludedRoots in interface LibraryEx

Returns:

excluded directories

See Also:

LibraryEx.getExcludedRootUrls()

getProperties

public LibraryProperties getProperties()

Specified by:

getProperties in interface LibraryEx

Specified by:

getProperties in interface LibraryEx.ModifiableModelEx

setKind

public void setKind(PersistentLibraryKind<?> kind)

Specified by:

setKind in interface LibraryEx.ModifiableModelEx

addRoot

public void addRoot(java.lang.String url,
                    OrderRootType rootType)

Specified by:

addRoot in interface Library.ModifiableModel

addRoot

public void addRoot(VirtualFile file,
                    OrderRootType rootType)

Specified by:

addRoot in interface Library.ModifiableModel

addJarDirectory

public void addJarDirectory(java.lang.String url,
                            boolean recursive)

Specified by:

addJarDirectory in interface Library.ModifiableModel

addJarDirectory

public void addJarDirectory(VirtualFile file,
                            boolean recursive)

Specified by:

addJarDirectory in interface Library.ModifiableModel

addJarDirectory

public void addJarDirectory(java.lang.String url,
                            boolean recursive,
                            OrderRootType rootType)

Specified by:

addJarDirectory in interface Library.ModifiableModel

addJarDirectory

public void addJarDirectory(VirtualFile file,
                            boolean recursive,
                            OrderRootType rootType)

Specified by:

addJarDirectory in interface Library.ModifiableModel

isJarDirectory

public boolean isJarDirectory(java.lang.String url)

Specified by:

isJarDirectory in interface Library

Specified by:

isJarDirectory in interface Library.ModifiableModel

isJarDirectory

public boolean isJarDirectory(java.lang.String url,
                              OrderRootType rootType)

Specified by:

isJarDirectory in interface Library

Specified by:

isJarDirectory in interface Library.ModifiableModel

isValid

public boolean isValid(java.lang.String url,
                       OrderRootType rootType)

Specified by:

isValid in interface Library

Specified by:

isValid in interface Library.ModifiableModel

removeRoot

public boolean removeRoot(java.lang.String url,
                          OrderRootType rootType)

Specified by:

removeRoot in interface Library.ModifiableModel

moveRootUp

public void moveRootUp(java.lang.String url,
                       OrderRootType rootType)

Specified by:

moveRootUp in interface Library.ModifiableModel

moveRootDown

public void moveRootDown(java.lang.String url,
                         OrderRootType rootType)

Specified by:

moveRootDown in interface Library.ModifiableModel

isChanged

public boolean isChanged()

Specified by:

isChanged in interface Library.ModifiableModel

getSource

public Library getSource()

Description copied from interface: LibraryEx

In case of modifiable library returns origin library it was created from

Specified by:

getSource in interface LibraryEx

commit

public void commit()

Specified by:

commit in interface Library.ModifiableModel

getTable

public LibraryTable getTable()

Specified by:

getTable in interface Library

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getModule

public Module getModule()

Specified by:

getModule in interface LibraryEx

addRootSetChangedListener

public void addRootSetChangedListener(RootProvider.RootSetChangedListener listener)

Specified by:

addRootSetChangedListener in interface RootProvider

removeRootSetChangedListener

public void removeRootSetChangedListener(RootProvider.RootSetChangedListener listener)

Specified by:

removeRootSetChangedListener in interface RootProvider

addRootSetChangedListener

public void addRootSetChangedListener(RootProvider.RootSetChangedListener listener,
                                      Disposable parentDisposable)

Specified by:

addRootSetChangedListener in interface RootProvider