Package com.intellij.openapi.roots.libraries

Class LibraryTablesRegistrar

java.lang.Object

com.intellij.openapi.roots.libraries.LibraryTablesRegistrar

public abstract class LibraryTablesRegistrar
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	APPLICATION_LEVEL
static java.lang.String	PROJECT_LEVEL

Constructor Summary

Constructors

Constructor and Description
LibraryTablesRegistrar()

Method Summary

Modifier and Type	Method and Description
abstract java.util.List<LibraryTable>	getCustomLibraryTables()
static LibraryTablesRegistrar	getInstance()
abstract LibraryTable	getLibraryTable() Returns the table containing application-level libraries.
abstract LibraryTable	getLibraryTable(Project project) Returns the table containing project-level libraries for given project.
abstract LibraryTable	getLibraryTableByLevel(java.lang.String level, Project project) Returns a custom library table registered by registerLibraryTable(LibraryTable).
abstract void	registerLibraryTable(LibraryTable libraryTable) Register a custom library table.

Methods inherited from class java.lang.Object

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

Field Detail

PROJECT_LEVEL

public static final java.lang.String PROJECT_LEVEL

See Also:

Constant Field Values

APPLICATION_LEVEL

public static final java.lang.String APPLICATION_LEVEL

See Also:

Constant Field Values

Constructor Detail

LibraryTablesRegistrar

public LibraryTablesRegistrar()

Method Detail

getInstance

public static LibraryTablesRegistrar getInstance()

getLibraryTable

public abstract LibraryTable getLibraryTable()

Returns the table containing application-level libraries. These libraries are shown in 'Project Structure' | 'Platform Settings' | 'Global Libraries' and may be added to dependencies of modules in any project.

getLibraryTable

public abstract LibraryTable getLibraryTable(Project project)

Returns the table containing project-level libraries for given project. These libraries are shown in 'Project Structure' | 'Project Settings' | 'Libraries' and may be added to dependencies of the corresponding project's modules only.

getLibraryTableByLevel

public abstract LibraryTable getLibraryTableByLevel(java.lang.String level,
                                                    Project project)

Returns a custom library table registered by registerLibraryTable(LibraryTable).

registerLibraryTable

public abstract void registerLibraryTable(LibraryTable libraryTable)

Register a custom library table. The platform doesn't provide editors for libraries from custom tables and doesn't save their configurations automatically, so a plugin providing such a table must implement this functionality on its own. Modules from custom tables may be added to dependencies of modules in any project in 'Project Structure' dialog.

getCustomLibraryTables

public abstract java.util.List<LibraryTable> getCustomLibraryTables()