org.jboss.forge.addon.parser.java.facets

Interface JavaSourceFacet

All Superinterfaces:

Facet<Project>, ProjectFacet

public interface JavaSourceFacet
extends ProjectFacet

Author:

Lincoln Baxter, III

Method Summary

Modifier and Type	Method and Description
String	calculateName(JavaResource resource) Return the class name for the given JavaResource whether it exists or not.
String	calculatePackage(JavaResource resource) Return the package for the given JavaResource whether it exists or not.
String	getBasePackage() Return the base Java Package for this project, returned as a String
DirectoryResource	getBasePackageDirectory() Return the base Java Package for this project, returned as a DirectoryResource
JavaResource	getJavaResource(org.jboss.forge.roaster.model.source.JavaSource<?> javaClass) Attempt to locate and re-parse the given JavaSource from its location on disk, relative to getSourceDirectory().
JavaResource	getJavaResource(String relativePath) Return the JavaClass at the given path relative to getSourceDirectory().
DirectoryResource	getPackage(String packageName) Return the package in the specified path under the DirectoryResource returned in getSourceDirectory()
List<DirectoryResource>	getSourceDirectories() Get a list of DirectoryResources this project uses to contain Project source documents (such as .java files.)
DirectoryResource	getSourceDirectory() Get the DirectoryResource this Project uses to store package-able source documents (such as .java files.)
JavaResource	getTestJavaResource(org.jboss.forge.roaster.model.source.JavaSource<?> javaClass) Attempt to locate and re-parse the given JavaClass from its location on disk, relative to getTestSourceDirectory().
JavaResource	getTestJavaResource(String relativePath) Return the JavaClass at the given path relative to getTestSourceDirectory().
DirectoryResource	getTestPackage(String packageName) Returns the package in the specified path under the DirectoryResource returned in getTestSourceDirectory()
DirectoryResource	getTestSourceDirectory() Get the DirectoryResource this Project uses to store test-scoped source documents (such as .java files.) Files in this directory will never be packaged or deployed except when running Unit Tests.
JavaResource	saveJavaSource(org.jboss.forge.roaster.model.source.JavaSource<?> source) Create or update a Java file in the primary source directory: getSourceDirectory() - use information in the given JavaSource to determine the appropriate package; packages will be created if necessary.
default JavaResource	saveJavaSourceUnformatted(org.jboss.forge.roaster.model.source.JavaSource<?> source) Create or update a Java file without formatting in the primary source directory: getSourceDirectory() - use information in the given JavaSource to determine the appropriate package; packages will be created if necessary.
DirectoryResource	savePackage(String packageName, boolean createPackageInfo) Create a package in the specified path under the DirectoryResource returned in getSourceDirectory()
JavaResource	saveTestJavaSource(org.jboss.forge.roaster.model.source.JavaSource<?> source) Create or update a Java file in the primary test source directory: getTestSourceDirectory() - use information in the given JavaSource to determine the appropriate package; packages will be created if necessary.
default JavaResource	saveTestJavaSourceUnformatted(org.jboss.forge.roaster.model.source.JavaSource<?> source) Create or update a Java file without formatting in the primary test source directory: getTestSourceDirectory() - use information in the given JavaSource to determine the appropriate package; packages will be created if necessary.
DirectoryResource	saveTestPackage(String packageName, boolean createPackageInfo) Create a package in the specified path under the DirectoryResource returned in getTestSourceDirectory()
void	visitJavaSources(JavaResourceVisitor visitor) Recursively loops over all the source directories and for each java file it finds, calls the visitor.
void	visitJavaTestSources(JavaResourceVisitor visitor) Recursively loops over all the test source directories and for each java file it finds, calls the visitor.

Methods inherited from interface org.jboss.forge.addon.facets.Facet

getFaceted, install, isInstalled, uninstall

Method Detail

calculateName

String calculateName(JavaResource resource)

Return the class name for the given JavaResource whether it exists or not.

calculatePackage

String calculatePackage(JavaResource resource)

Return the package for the given JavaResource whether it exists or not.

getBasePackage

String getBasePackage()

Return the base Java Package for this project, returned as a String

getBasePackageDirectory

DirectoryResource getBasePackageDirectory()

Return the base Java Package for this project, returned as a DirectoryResource

getSourceDirectories

List<DirectoryResource> getSourceDirectories()

Get a list of DirectoryResources this project uses to contain Project source documents (such as .java files.)

getSourceDirectory

DirectoryResource getSourceDirectory()

Get the DirectoryResource this Project uses to store package-able source documents (such as .java files.)

getTestSourceDirectory

DirectoryResource getTestSourceDirectory()

Get the DirectoryResource this Project uses to store test-scoped source documents (such as .java files.) Files in this directory will never be packaged or deployed except when running Unit Tests.

saveJavaSource

JavaResource saveJavaSource(org.jboss.forge.roaster.model.source.JavaSource<?> source)

Create or update a Java file in the primary source directory: getSourceDirectory() - use information in the given JavaSource to determine the appropriate package; packages will be created if necessary.

Parameters:

source - The java class to create

Returns:

The created or updated JavaResource

Throws:

FileNotFoundException

saveJavaSourceUnformatted

default JavaResource saveJavaSourceUnformatted(org.jboss.forge.roaster.model.source.JavaSource<?> source)

Create or update a Java file without formatting in the primary source directory: getSourceDirectory() - use information in the given JavaSource to determine the appropriate package; packages will be created if necessary.

Parameters:

source -

Returns:

saveTestJavaSource

JavaResource saveTestJavaSource(org.jboss.forge.roaster.model.source.JavaSource<?> source)

Create or update a Java file in the primary test source directory: getTestSourceDirectory() - use information in the given JavaSource to determine the appropriate package; packages will be created if necessary.

Parameters:

source - The java class to create

Returns:

The created or updated JavaResource

saveTestJavaSourceUnformatted

default JavaResource saveTestJavaSourceUnformatted(org.jboss.forge.roaster.model.source.JavaSource<?> source)

Create or update a Java file without formatting in the primary test source directory: getTestSourceDirectory() - use information in the given JavaSource to determine the appropriate package; packages will be created if necessary.

Parameters:

source - The java class to create

Returns:

The created or updated JavaResource

getJavaResource

JavaResource getJavaResource(String relativePath)

Return the JavaClass at the given path relative to getSourceDirectory().

Parameters:

relativePath - The file or package path of the target Java source file.

Throws:

FileNotFoundException - if the target JavaResource does not exist

getJavaResource

JavaResource getJavaResource(org.jboss.forge.roaster.model.source.JavaSource<?> javaClass)

Attempt to locate and re-parse the given JavaSource from its location on disk, relative to getSourceDirectory(). The given instance will not be modified, and a new instance will be returned.

Parameters:

javaClass - The JavaClass to re-parse.

Throws:

FileNotFoundException - if the target JavaResource does not exist

getTestJavaResource

JavaResource getTestJavaResource(String relativePath)

Return the JavaClass at the given path relative to getTestSourceDirectory().

Parameters:

relativePath - The package path of the target Java source JavaResource.

getTestJavaResource

JavaResource getTestJavaResource(org.jboss.forge.roaster.model.source.JavaSource<?> javaClass)

Attempt to locate and re-parse the given JavaClass from its location on disk, relative to getTestSourceDirectory(). The given instance will not be modified, and a new instance will be returned.

Parameters:

javaClass - The JavaClass to re-parse.

Throws:

FileNotFoundException - if the target JavaResource does not exist

visitJavaSources

void visitJavaSources(JavaResourceVisitor visitor)

Recursively loops over all the source directories and for each java file it finds, calls the visitor.

Parameters:

visitor - The JavaResourceVisitor that processes all the found java files. Cannot be null.

visitJavaTestSources

void visitJavaTestSources(JavaResourceVisitor visitor)

Recursively loops over all the test source directories and for each java file it finds, calls the visitor.

Parameters:

visitor - The JavaResourceVisitor that processes all the found java files. Cannot be null.

savePackage

DirectoryResource savePackage(String packageName,
                              boolean createPackageInfo)

Create a package in the specified path under the DirectoryResource returned in getSourceDirectory()

Parameters:

packageName - the package name to be created

createPackageInfo - create a package-info.java file under this package?

Returns:

a DirectoryResource with the path for the new package

saveTestPackage

DirectoryResource saveTestPackage(String packageName,
                                  boolean createPackageInfo)

Create a package in the specified path under the DirectoryResource returned in getTestSourceDirectory()

Parameters:

packageName - the package name to be created

createPackageInfo - create a package-info.java file under this package?

Returns:

a DirectoryResource with the path for the new package

getPackage

DirectoryResource getPackage(String packageName)

Return the package in the specified path under the DirectoryResource returned in getSourceDirectory()

Parameters:

packageName - the package name to be created

Returns:

a DirectoryResource with the package path

getTestPackage

DirectoryResource getTestPackage(String packageName)

Returns the package in the specified path under the DirectoryResource returned in getTestSourceDirectory()

Parameters:

packageName - the package name to be created

Returns:

a DirectoryResource with the package path