Package com.intellij.psi

Class JavaDirectoryService

java.lang.Object

com.intellij.psi.JavaDirectoryService

Direct Known Subclasses:

CoreJavaDirectoryService

public abstract class JavaDirectoryService
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
JavaDirectoryService()

Method Summary

Modifier and Type	Method and Description
abstract void	checkCreateClass(PsiDirectory dir, java.lang.String name) Checks if it's possible to create a class with the specified name in the directory, and throws an exception if the creation is not possible.
abstract PsiClass	createAnnotationType(PsiDirectory dir, java.lang.String name) Creates an annotation class with the specified name in the directory.
abstract PsiClass	createClass(PsiDirectory dir, java.lang.String name) Creates a class with the specified name in the directory.
abstract PsiClass	createClass(PsiDirectory dir, java.lang.String name, java.lang.String templateName) Creates a class with the specified name in the directory.
abstract PsiClass	createClass(PsiDirectory dir, java.lang.String name, java.lang.String templateName, boolean askForUndefinedVariables)
abstract PsiClass	createClass(PsiDirectory dir, java.lang.String name, java.lang.String templateName, boolean askForUndefinedVariables, java.util.Map<java.lang.String,java.lang.String> additionalProperties)
abstract PsiClass	createEnum(PsiDirectory dir, java.lang.String name) Creates an enumeration class with the specified name in the directory.
abstract PsiClass	createInterface(PsiDirectory dir, java.lang.String name) Creates an interface class with the specified name in the directory.
abstract PsiClass	createRecord(PsiDirectory dir, java.lang.String name) Creates a record class with the specified name in the directory.
abstract PsiClass []	getClasses(PsiDirectory dir) Returns the list of Java classes contained in the directory.
static JavaDirectoryService	getInstance()
abstract LanguageLevel	getLanguageLevel(PsiDirectory dir)
abstract PsiPackage	getPackage(PsiDirectory dir) Returns the package corresponding to the directory.
abstract PsiPackage	getPackageInSources(PsiDirectory dir) Returns the package corresponding to the directory.
abstract boolean	isSourceRoot(PsiDirectory dir) Checks if the directory is a source root for the project to which it belongs.

Methods inherited from class java.lang.Object

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

Constructor Detail

JavaDirectoryService

public JavaDirectoryService()

Method Detail

getInstance

public static JavaDirectoryService getInstance()

getPackage

public abstract PsiPackage getPackage(PsiDirectory dir)

Returns the package corresponding to the directory.

Returns:

the package instance, or null if the directory does not correspond to any package.

getPackageInSources

public abstract PsiPackage getPackageInSources(PsiDirectory dir)

Returns the package corresponding to the directory.

Returns:

the package instance, or null if the directory does not correspond to any package or package is under resource roots

getClasses

public abstract PsiClass [] getClasses(PsiDirectory dir)

Returns the list of Java classes contained in the directory.

Returns:

the array of classes.

createClass

public abstract PsiClass createClass(PsiDirectory dir,
                                     java.lang.String name)
                              throws IncorrectOperationException

Creates a class with the specified name in the directory.

Parameters:

name - the name of the class to create (not including the file extension).

Returns:

the created class instance.

Throws:

IncorrectOperationException - if the operation failed for some reason.

createClass

public abstract PsiClass createClass(PsiDirectory dir,
                                     java.lang.String name,
                                     java.lang.String templateName)
                              throws IncorrectOperationException

Creates a class with the specified name in the directory.

Parameters:

name - the name of the class to create (not including the file extension).

templateName - custom file template to create class text based on.

Returns:

the created class instance.

Throws:

IncorrectOperationException - if the operation failed for some reason.

createClass

public abstract PsiClass createClass(PsiDirectory dir,
                                     java.lang.String name,
                                     java.lang.String templateName,
                                     boolean askForUndefinedVariables)
                              throws IncorrectOperationException

Parameters:

askForUndefinedVariables - true show dialog asking for undefined variables false leave them blank

Throws:

IncorrectOperationException

createClass

public abstract PsiClass createClass(PsiDirectory dir,
                                     java.lang.String name,
                                     java.lang.String templateName,
                                     boolean askForUndefinedVariables,
                                     java.util.Map<java.lang.String,java.lang.String> additionalProperties)
                              throws IncorrectOperationException

Parameters:

additionalProperties - additional properties to be substituted in the template

Throws:

IncorrectOperationException

checkCreateClass

public abstract void checkCreateClass(PsiDirectory dir,
                                      java.lang.String name)
                               throws IncorrectOperationException

Checks if it's possible to create a class with the specified name in the directory, and throws an exception if the creation is not possible. Does not actually modify anything.

Parameters:

name - the name of the class to check creation possibility (not including the file extension).

Throws:

IncorrectOperationException - if the creation is not possible.

createInterface

public abstract PsiClass createInterface(PsiDirectory dir,
                                         java.lang.String name)
                                  throws IncorrectOperationException

Creates an interface class with the specified name in the directory.

Parameters:

name - the name of the interface to create (not including the file extension).

Returns:

the created interface instance.

Throws:

IncorrectOperationException - if the operation failed for some reason.

createEnum

public abstract PsiClass createEnum(PsiDirectory dir,
                                    java.lang.String name)
                             throws IncorrectOperationException

Creates an enumeration class with the specified name in the directory.

Parameters:

name - the name of the enumeration class to create (not including the file extension).

Returns:

the created class instance.

Throws:

IncorrectOperationException - if the operation failed for some reason.

createRecord

public abstract PsiClass createRecord(PsiDirectory dir,
                                      java.lang.String name)
                               throws IncorrectOperationException

Creates a record class with the specified name in the directory.

Parameters:

name - the name of the record class to create (not including the file extension).

Returns:

the created record instance.

Throws:

IncorrectOperationException - if the operation failed for some reason.

createAnnotationType

public abstract PsiClass createAnnotationType(PsiDirectory dir,
                                              java.lang.String name)
                                       throws IncorrectOperationException

Creates an annotation class with the specified name in the directory.

Parameters:

name - the name of the annotation class to create (not including the file extension).

Returns:

the created class instance.

Throws:

IncorrectOperationException - if the operation failed for some reason.

isSourceRoot

public abstract boolean isSourceRoot(PsiDirectory dir)

Checks if the directory is a source root for the project to which it belongs.

Returns:

true if the directory is a source root, false otherwise

getLanguageLevel

public abstract LanguageLevel getLanguageLevel(PsiDirectory dir)