Package caseine.project

Interface CaseineProject

All Known Implementing Classes:

CaseineCommonProject, CaseineCppProject, CaseineJavaProject, CaseinePythonProject

public interface CaseineProject

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	CaseineProject.ProjectType

Method Summary

Modifier and Type	Method	Description
void	clean()	Cleans the local templates.
boolean	documentation()	Synchronize the documentation of the VPL
void	generate(boolean mvn, int template)	Generates the project template.
CaseineProject.ProjectType	getType()
String	getVplId()
boolean	isCaseine()
boolean	isGenerated()
void	local(ClassLoader cl)	Generates the local caseine templates into caseine-output.
void	nature()	Set the caseine nature to the project
void	push(ClassLoader cl)	Publishes the templates to the remote caseine server.
boolean	updateSettings()	Update the settings of the VPL

Method Details

isCaseine

boolean isCaseine()

Returns:

True if it is a Caseine project

getType

CaseineProject.ProjectType getType()

getVplId

String getVplId()

generate

void generate(boolean mvn,
 int template)
       throws CaseineProjectAlreadyExistingException,
BadIDEException,
IOException,
TestDirectoryMissingException,
FileMissingException,
UnitTestsFileMissingException

Generates the project template.

Parameters:

mvn - True if we must generate the maven pom.xml

template - a number to define a kind of template

Throws:

CaseineProjectAlreadyExistingException

BadIDEException

IOException

TestDirectoryMissingException

UnitTestsFileMissingException

FileMissingException

local

void local(ClassLoader cl)
    throws IOException,
ClassNotFoundException,
MavenProjectException

Generates the local caseine templates into caseine-output.

Parameters:

cl - an optional classloader to provide dependencies

Throws:

IOException - if ioException

ClassNotFoundException - if the class is not found

MavenProjectException

push

void push(ClassLoader cl)
   throws IOException,
ClassNotFoundException,
vplwsclient.exception.VplException,
VPLIDMissingException,
MavenProjectException,
NothingPushedException

Publishes the templates to the remote caseine server.

Parameters:

cl - an optional classloader to provide dependencies

Throws:

IOException - if something wrong

ClassNotFoundException - if something wrong

vplwsclient.exception.VplException - if something wrong

VPLIDMissingException

MavenProjectException

NothingPushedException

clean

void clean()
    throws IOException

Cleans the local templates.

Throws:

IOException - if an error occurs with the deleted files

isGenerated

boolean isGenerated()

nature

void nature()
     throws CaseineProjectAlreadyExistingException,
IOException

Set the caseine nature to the project

Throws:

CaseineProjectAlreadyExistingException

IOException

documentation

boolean documentation()
               throws vplwsclient.exception.VplConnectionException,
vplwsclient.exception.MoodleWebServiceException,
IOException

Synchronize the documentation of the VPL

Returns:

true if something is published on the server

Throws:

vplwsclient.exception.VplConnectionException

vplwsclient.exception.MoodleWebServiceException

IOException

updateSettings

boolean updateSettings()
                throws vplwsclient.exception.VplConnectionException,
vplwsclient.exception.MoodleWebServiceException,
IOException

Update the settings of the VPL

Returns:

true if something is published on the server

Throws:

vplwsclient.exception.VplConnectionException

vplwsclient.exception.MoodleWebServiceException

IOException