Package com.intellij.openapi.roots.libraries

Class LibraryType<P extends LibraryProperties>

java.lang.Object

com.intellij.openapi.roots.libraries.LibraryPresentationProvider<P>

com.intellij.openapi.roots.libraries.LibraryType<P>

Direct Known Subclasses:

DownloadableLibraryType, PythonLibraryType, RepositoryLibraryType, UnknownLibraryType

public abstract class LibraryType<P extends LibraryProperties>
extends LibraryPresentationProvider<P>

Override this class to provide custom library type. Type and properties for custom libraries are stored in project configuration files. If they can be detected automatically it's better to use LibraryPresentationProvider extension point instead.
The implementation should be registered in plugin.xml:

<extensions defaultExtensionNs="com.intellij">
<library.type implementation="qualified-class-name"/>
</extensions>

See Also:

LibraryPresentationProvider

Field Summary

Fields

Modifier and Type	Field and Description
static OrderRootType[]	DEFAULT_EXTERNAL_ROOT_TYPES
static ExtensionPointName<LibraryType<?>>	EP_NAME

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	LibraryType(PersistentLibraryKind<P> libraryKind)

Method Summary

Modifier and Type	Method and Description
LibraryRootsComponentDescriptor	createLibraryRootsComponentDescriptor() Override this method to customize the library roots editor
abstract NewLibraryConfiguration	createNewLibrary(javax.swing.JComponent parentComponent, VirtualFile contextDirectory, Project project) Called when a new library of this type is created in Project Structure dialog
abstract LibraryPropertiesEditor	createPropertiesEditor(LibraryEditorComponent<P> editorComponent)
P	detect(java.util.List<VirtualFile> classesRoots) Returns non-null value if a library with classes roots classesRoots is of a kind described by this provider.
static LibraryType	findByKind(LibraryKind kind)
abstract java.lang.String	getCreateActionName()
OrderRootType []	getExternalRootTypes()
PersistentLibraryKind<P>	getKind()
boolean	isSuitableModule(Module module, FacetsProvider facetsProvider)

Methods inherited from class com.intellij.openapi.roots.libraries.LibraryPresentationProvider

getDescription, getIcon, getIcon

Methods inherited from class java.lang.Object

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

Field Detail

EP_NAME

public static final ExtensionPointName<LibraryType<?>> EP_NAME

DEFAULT_EXTERNAL_ROOT_TYPES

public static final OrderRootType[] DEFAULT_EXTERNAL_ROOT_TYPES

Constructor Detail

LibraryType

protected LibraryType(PersistentLibraryKind<P> libraryKind)

Method Detail

getKind

public PersistentLibraryKind<P> getKind()

Overrides:

getKind in class LibraryPresentationProvider<P extends LibraryProperties>

getCreateActionName

public abstract java.lang.String getCreateActionName()

Returns:

text to show in 'New Library' popup. Return null if the type should not be shown in the 'New Library' popup

createNewLibrary

public abstract NewLibraryConfiguration createNewLibrary(javax.swing.JComponent parentComponent,
                                                         VirtualFile contextDirectory,
                                                         Project project)

Called when a new library of this type is created in Project Structure dialog

isSuitableModule

public boolean isSuitableModule(Module module,
                                FacetsProvider facetsProvider)

Returns:

true if library of this type can be added as a dependency to module

createLibraryRootsComponentDescriptor

public LibraryRootsComponentDescriptor createLibraryRootsComponentDescriptor()

Override this method to customize the library roots editor

Returns:

LibraryRootsComponentDescriptor instance

createPropertiesEditor

public abstract LibraryPropertiesEditor createPropertiesEditor(LibraryEditorComponent<P> editorComponent)

detect

public P detect(java.util.List<VirtualFile> classesRoots)

Description copied from class: LibraryPresentationProvider

Returns non-null value if a library with classes roots classesRoots is of a kind described by this provider.

Specified by:

detect in class LibraryPresentationProvider<P extends LibraryProperties>

getExternalRootTypes

public OrderRootType [] getExternalRootTypes()

Returns:

Root types to collect library files which do not belong to the project and therefore indicate that the library is external.

findByKind

public static LibraryType findByKind(LibraryKind kind)