Package com.intellij.openapi.roots

Interface OrderEntry

All Superinterfaces:

java.lang.Comparable<OrderEntry>, Synthetic

All Known Subinterfaces:

ExportableOrderEntry, InheritedJdkOrderEntry, JdkOrderEntry, LibraryOrderEntry, LibraryOrSdkOrderEntry, ModuleJdkOrderEntry, ModuleOrderEntry, ModuleSourceOrderEntry

All Known Implementing Classes:

ModuleLibraryOrderEntryImpl, ModuleOrderEntryImpl

public interface OrderEntry
extends Synthetic, java.lang.Comparable<OrderEntry>

Represents an entry in the classpath of a module (as shown in the "Order/Export" page of the module configuration dialog).

Field Summary

Fields

Modifier and Type	Field and Description
static OrderEntry[]	EMPTY_ARRAY The empty array of order entries which can be reused to avoid unnecessary allocations.

Method Summary

Modifier and Type	Method and Description
<R> R	accept(RootPolicy<R> policy, R initialValue) Accepts the specified order entries visitor.
VirtualFile []	getFiles(OrderRootType type) Returns list of root VirtualFiles of given type for this entry.
Module	getOwnerModule() Returns the module to which the entry belongs.
java.lang.String	getPresentableName() Returns the user-visible name of this OrderEntry.
java.lang.String []	getUrls(OrderRootType rootType) Returns list of roots of given type for this entry.
boolean	isValid() Checks whether this order entry is invalid for some reason.

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

isSynthetic

Methods inherited from interface java.lang.Comparable

compareTo

Field Detail

EMPTY_ARRAY

static final OrderEntry[] EMPTY_ARRAY

The empty array of order entries which can be reused to avoid unnecessary allocations.

Method Detail

getFiles

VirtualFile [] getFiles(OrderRootType type)

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 getUrls(OrderRootType) method.
Note that list of roots is project dependent.

Parameters:

type - required root type.

Returns:

list of virtual files.

See Also:

getUrls(OrderRootType)

getUrls

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

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.

Parameters:

rootType - the type of roots which should be returned.

Returns:

the list of roots of the specified type.

getPresentableName

java.lang.String getPresentableName()

Returns the user-visible name of this OrderEntry.

Returns:

name of this OrderEntry to be shown to user.

isValid

boolean isValid()

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.

Returns:

true if entry is valid, false otherwise.

getOwnerModule

Module getOwnerModule()

Returns the module to which the entry belongs.

Returns:

the module instance.

accept

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

Accepts the specified order entries visitor.

Parameters:

policy - the visitor to accept.

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

Returns:

the value returned by the visitor.