Package com.intellij.openapi.roots

Class OrderRootType

java.lang.Object

com.intellij.openapi.roots.OrderRootType

Direct Known Subclasses:

OrderRootType.DocumentationRootType, PersistentOrderRootType

public class OrderRootType
extends java.lang.Object

Root types that can be queried from OrderEntry.

See Also:

OrderEntry

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	OrderRootType.DocumentationRootType A temporary solution to exclude DOCUMENTATION from getAllTypes() and handle it only in special cases if supported by LibraryType.

Field Summary

Fields

Modifier and Type	Field and Description
static OrderRootType	CLASSES Classpath without output directories for modules.
static OrderRootType	DOCUMENTATION Generic documentation order root type
static ExtensionPointName<OrderRootType>	EP_NAME
static OrderRootType	SOURCES Sources.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	OrderRootType(java.lang.String name)

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
static PersistentOrderRootType []	getAllPersistentTypes()
static OrderRootType []	getAllTypes()
protected static <T> T	getOrderRootType(java.lang.Class<? extends T> orderRootTypeClass)
static java.util.List<PersistentOrderRootType>	getSortedRootTypes()
int	hashCode()
java.lang.String	name()
boolean	skipWriteIfEmpty() Whether this root type should be skipped when writing a Library if the root type doesn't contain any roots.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

EP_NAME

public static final ExtensionPointName<OrderRootType> EP_NAME

CLASSES

public static final OrderRootType CLASSES

Classpath without output directories for modules. Includes:

• classes roots for libraries and jdk
• recursively for module dependencies: only exported items

SOURCES

public static final OrderRootType SOURCES

Sources. Includes:

• production and test source roots for modules
• source roots for libraries and jdk
• recursively for module dependencies: only exported items

DOCUMENTATION

public static final OrderRootType DOCUMENTATION

Generic documentation order root type

Constructor Detail

OrderRootType

protected OrderRootType(java.lang.String name)

Method Detail

name

public java.lang.String name()

skipWriteIfEmpty

public boolean skipWriteIfEmpty()

Whether this root type should be skipped when writing a Library if the root type doesn't contain any roots.

Returns:

true if empty root type should be skipped, false otherwise.

getAllTypes

public static OrderRootType [] getAllTypes()

getAllPersistentTypes

public static PersistentOrderRootType [] getAllPersistentTypes()

getSortedRootTypes

public static java.util.List<PersistentOrderRootType> getSortedRootTypes()

getOrderRootType

protected static <T> T getOrderRootType(java.lang.Class<? extends T> orderRootTypeClass)

hashCode

public final int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

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

Overrides:

equals in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object