org.springframework.roo.classpath.operations
Interface ClasspathOperations

All Known Implementing Classes:

ClasspathOperationsImpl

public interface ClasspathOperations

Classpath-related operations

Since:

1.2.0

Author:

Andrew Swan

Method Summary

void	createClass(org.springframework.roo.model.JavaType name, boolean rooAnnotations, org.springframework.roo.project.LogicalPath path, org.springframework.roo.model.JavaType superclass, org.springframework.roo.model.JavaType implementsType, boolean createAbstract, boolean permitReservedWords) Creates a new Java class source file in any project path.
void	createConstructor(org.springframework.roo.model.JavaType name, Set<String> fields) Creates a new constructor in the specified class with the fields provided.
void	createEnum(org.springframework.roo.model.JavaType name, org.springframework.roo.project.LogicalPath path, boolean permitReservedWords) Creates a new Java enum source file in any project path.
void	createInterface(org.springframework.roo.model.JavaType name, org.springframework.roo.project.LogicalPath path, boolean permitReservedWords) Creates a new Java interface source file in any project path.
void	enumConstant(org.springframework.roo.model.JavaType name, org.springframework.roo.model.JavaSymbolName fieldName, boolean permitReservedWords) Inserts a new enum constant into an enum.
void	focus(org.springframework.roo.model.JavaType type) Changes the focus to the given type.
boolean	isProjectAvailable()

Method Detail

createClass

void createClass(org.springframework.roo.model.JavaType name,
                 boolean rooAnnotations,
                 org.springframework.roo.project.LogicalPath path,
                 org.springframework.roo.model.JavaType superclass,
                 org.springframework.roo.model.JavaType implementsType,
                 boolean createAbstract,
                 boolean permitReservedWords)

Creates a new Java class source file in any project path.

Parameters:

name - the name of the class to create

rooAnnotations - whether the generated class should have common Roo annotations

path - the source directory in which to create the class

superclass - the superclass (defaults to Object)

implementsType - the interface to implement

createAbstract - whether the generated class should be marked as abstract

permitReservedWords - whether reserved words are ignored by Roo

createConstructor

void createConstructor(org.springframework.roo.model.JavaType name,
                       Set<String> fields)

Creates a new constructor in the specified class with the fields provided.

If the set of fields is null, a public no-arg constructor will be created if not already present. If fields is not null but empty or if all of the supplied fields do not exist in the class, the method returns silently.

Parameters:

name - the name of the class (required).

fields - the fields to include in the constructor.

createEnum

void createEnum(org.springframework.roo.model.JavaType name,
                org.springframework.roo.project.LogicalPath path,
                boolean permitReservedWords)

Creates a new Java enum source file in any project path.

Parameters:

name - the name of the enum to create

path - the source directory in which to create the enum

permitReservedWords - whether reserved words are ignored by Roo

createInterface

void createInterface(org.springframework.roo.model.JavaType name,
                     org.springframework.roo.project.LogicalPath path,
                     boolean permitReservedWords)

Creates a new Java interface source file in any project path.

Parameters:

name - the name of the interface to create

path - the source directory in which to create the interface

permitReservedWords - whether reserved words are ignored by Roo

enumConstant

void enumConstant(org.springframework.roo.model.JavaType name,
                  org.springframework.roo.model.JavaSymbolName fieldName,
                  boolean permitReservedWords)

Inserts a new enum constant into an enum.

Parameters:

name - the enum class to receive this field

fieldName - the name of the constant

permitReservedWords - whether reserved words are ignored by Roo

focus

void focus(org.springframework.roo.model.JavaType type)

Changes the focus to the given type.

Parameters:

type - the type to focus on (required)

isProjectAvailable

boolean isProjectAvailable()