Package com.intellij.openapi.roots.impl

Class ModuleLibraryOrderEntryImpl

java.lang.Object

com.intellij.openapi.roots.impl.ModuleLibraryOrderEntryImpl

All Implemented Interfaces:

Disposable, ExportableOrderEntry, ClonableOrderEntry, LibraryOrderEntry, LibraryOrSdkOrderEntry, OrderEntry, Synthetic, java.lang.Comparable<OrderEntry>

public class ModuleLibraryOrderEntryImpl
extends java.lang.Object
implements LibraryOrderEntry, ClonableOrderEntry

Library entry for module ("in-place") libraries. This class isn't supposed to be used from plugins. Use OrderEntryUtil.isModuleLibraryOrderEntry(OrderEntry) to check whether an entry corresponds to a module-level library.

Nested Class Summary

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

Disposable.Parent

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ENTRY_TYPE
protected DependencyScope	myScope

Fields inherited from interface com.intellij.openapi.roots.OrderEntry

EMPTY_ARRAY

Method Summary

Modifier and Type	Method and Description
<R> R	accept(RootPolicy<R> policy, R initialValue) Accepts the specified order entries visitor.
OrderEntry	cloneEntry(ModifiableRootModel rootModel, ProjectRootManagerImpl projectRootManager, VirtualFilePointerManager filePointerManager)
int	compareTo(OrderEntry orderEntry)
void	dispose() Usually not invoked directly, see class javadoc.
boolean	equals(java.lang.Object obj)
VirtualFile []	getFiles(OrderRootType type) Returns list of root VirtualFiles of given type for this entry.
Library	getLibrary()
java.lang.String	getLibraryLevel()
java.lang.String	getLibraryName()
Module	getOwnerModule() Returns the module to which the entry belongs.
java.lang.String	getPresentableName() Returns the user-visible name of this OrderEntry.
VirtualFile []	getRootFiles(OrderRootType type)
RootModelImpl	getRootModel()
protected RootProvider	getRootProvider()
java.lang.String []	getRootUrls(OrderRootType type)
DependencyScope	getScope()
java.lang.String []	getUrls(OrderRootType type) Returns list of roots of given type for this entry.
int	hashCode()
protected void	init()
boolean	isDisposed()
boolean	isExported()
boolean	isModuleLevel()
boolean	isSynthetic()
boolean	isValid() Checks whether this order entry is invalid for some reason.
void	setExported(boolean value)
void	setScope(DependencyScope scope)
java.lang.String	toString()
void	writeExternal(Element rootElement)

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.intellij.openapi.roots.LibraryOrSdkOrderEntry

getRootFiles, getRootUrls

Methods inherited from interface com.intellij.openapi.roots.OrderEntry

getFiles, getOwnerModule, getUrls

Methods inherited from interface java.lang.Comparable

compareTo

Field Detail

ENTRY_TYPE

public static final java.lang.String ENTRY_TYPE

See Also:

Constant Field Values

myScope

protected DependencyScope myScope

Method Detail

getRootProvider

protected RootProvider getRootProvider()

getLibrary

public Library getLibrary()

Specified by:

getLibrary in interface LibraryOrderEntry

isModuleLevel

public boolean isModuleLevel()

Specified by:

isModuleLevel in interface LibraryOrderEntry

getLibraryName

public java.lang.String getLibraryName()

Specified by:

getLibraryName in interface LibraryOrderEntry

getLibraryLevel

public java.lang.String getLibraryLevel()

Specified by:

getLibraryLevel in interface LibraryOrderEntry

getPresentableName

public java.lang.String getPresentableName()

Description copied from interface: OrderEntry

Returns the user-visible name of this OrderEntry.

Specified by:

getPresentableName in interface OrderEntry

Returns:

name of this OrderEntry to be shown to user.

isValid

public boolean isValid()

Description copied from interface: OrderEntry

Checks whether this order entry is invalid for some reason. Note that entry being valid does not necessarily mean that all its roots are valid.

Specified by:

isValid in interface OrderEntry

Returns:

true if entry is valid, false otherwise.

accept

public <R> R accept(RootPolicy<R> policy,
                    R initialValue)

Description copied from interface: OrderEntry

Accepts the specified order entries visitor.

Specified by:

accept in interface OrderEntry

Parameters:

policy - the visitor to accept.

initialValue - the default value to be returned by the visit process.

Returns:

the value returned by the visitor.

isSynthetic

public boolean isSynthetic()

Specified by:

isSynthetic in interface Synthetic

cloneEntry

public OrderEntry cloneEntry(ModifiableRootModel rootModel,
                             ProjectRootManagerImpl projectRootManager,
                             VirtualFilePointerManager filePointerManager)

Specified by:

cloneEntry in interface ClonableOrderEntry

writeExternal

public void writeExternal(Element rootElement)
                   throws WriteExternalException

Throws:

WriteExternalException

isExported

public boolean isExported()

Specified by:

isExported in interface ExportableOrderEntry

setExported

public void setExported(boolean value)

Specified by:

setExported in interface ExportableOrderEntry

getScope

public DependencyScope getScope()

Specified by:

getScope in interface ExportableOrderEntry

setScope

public void setScope(DependencyScope scope)

Specified by:

setScope in interface ExportableOrderEntry

init

protected final void init()

getFiles

public VirtualFile [] getFiles(OrderRootType type)

Description copied from interface: OrderEntry

Returns list of root VirtualFiles of given type for this entry. Those files should be traversed in order they are returned in. Note that actual OrderEntry (as seen in UI) may also contain invalid roots. If you want to get list of all roots, use OrderEntry.getUrls(OrderRootType) method.
Note that list of roots is project dependent.

Specified by:

getFiles in interface OrderEntry

Parameters:

type - required root type.

Returns:

list of virtual files.

See Also:

OrderEntry.getUrls(OrderRootType)

getUrls

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

Description copied from interface: OrderEntry

Returns list of roots of given type for this entry. To validate returned roots, use VirtualFileManager.findFileByUrl(String)
Note that list of roots is project-dependent.

Specified by:

getUrls in interface OrderEntry

Parameters:

type - the type of roots which should be returned.

Returns:

the list of roots of the specified type.

getRootFiles

public VirtualFile [] getRootFiles(OrderRootType type)

Specified by:

getRootFiles in interface LibraryOrSdkOrderEntry

getRootUrls

public java.lang.String [] getRootUrls(OrderRootType type)

Specified by:

getRootUrls in interface LibraryOrSdkOrderEntry

getOwnerModule

public final Module getOwnerModule()

Description copied from interface: OrderEntry

Returns the module to which the entry belongs.

Specified by:

getOwnerModule in interface OrderEntry

Returns:

the module instance.

dispose

public void dispose()

Description copied from interface: Disposable

Usually not invoked directly, see class javadoc.

Specified by:

dispose in interface Disposable

compareTo

public int compareTo(OrderEntry orderEntry)

Specified by:

compareTo in interface java.lang.Comparable<OrderEntry>

equals

public final boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

hashCode

public final int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getRootModel

public RootModelImpl getRootModel()

isDisposed

public boolean isDisposed()