fr.ifremer.isisfish.datastore
Class JavaSourceStorage

java.lang.Object
  fr.ifremer.isisfish.datastore.VersionStorage
      fr.ifremer.isisfish.datastore.CodeSourceStorage
          fr.ifremer.isisfish.datastore.JavaSourceStorage

Direct Known Subclasses:

AnalysePlanStorage, ExportStorage, RuleStorage, ScriptStorage, SensitivityStorage, SimulatorStorage

public abstract class JavaSourceStorage
extends CodeSourceStorage

Classes abstraite permettant la gestion des fichiers de code source. Exemple : AnalysePlanStorage ExportStorage, RuleStorage, ScriptStorage, SensitivityStorage, SimulatorStorage

Version:

$Revision: 3124 $ Last update: $Date: 2010-11-29 19:14:09 +0100 (lun., 29 nov. 2010) $ by : $Author: chatellier $

Author:

poussin

Field Summary

protected static String

PARAM_PREFIX

Fields inherited from class fr.ifremer.isisfish.datastore.CodeSourceStorage

content, lastContentLength, lastContentUpdate, name

Fields inherited from class fr.ifremer.isisfish.datastore.VersionStorage

changeListeners, file, root

Constructor Summary

protected

JavaSourceStorage(File rootSrc, File directory, String name) Build a new java source storage.

Method Summary

int	compile(boolean force, PrintWriter out) Compile cette classe dans le répertoire par defaut de compilation (IsisConfig.getCompileDirectory())
int	doJavadoc(boolean force, PrintWriter out) Build class javadoc.
Class<?>	getCodeClass() Retourne la classe compilée.
String	getFQN() Return class fully qualified name.
static String	getName(Object instance) Retourne le nom de la classe (sans le package) a partir d'un objet.
Object	getNewInstance() Retourne une nouvelle instance de la class.
static Doc	getParameterDoc(Object object, String paramName) Get doc of parameter.

Methods inherited from class fr.ifremer.isisfish.datastore.CodeSourceStorage

diff, exists, getContent, getFiles, getName, prepare, reload, setContent

Methods inherited from class fr.ifremer.isisfish.datastore.VersionStorage

add, addStorageChangeListener, checkout, commit, delete, fireDataChanged, getContextDatabaseCacheKey, getContextDatabaseDirectory, getFile, getFiles, getRemoteStorageNames, getRoot, getStorageNames, getVCS, isOnRemote, isUpToDate, isVersionnableFile, removeStorageChangeListener, update

Methods inherited from class java.lang.Object

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

Field Detail

PARAM_PREFIX

protected static final String PARAM_PREFIX

See Also:

Constant Field Values

Constructor Detail

JavaSourceStorage

protected JavaSourceStorage(File rootSrc,
                            File directory,
                            String name)

Build a new java source storage.

Parameters:

rootSrc - sources root directory

directory - class location directory (rootSrc subdirectory)

name - class name

Method Detail

getFQN

public String getFQN()

Return class fully qualified name.

Returns:

class name including package name

getName

public static String getName(Object instance)

Retourne le nom de la classe (sans le package) a partir d'un objet.

Parameters:

instance - l'instance dont on veut le nom

Returns:

le nom de la classe ou null si instance est null

compile

public int compile(boolean force,
                   PrintWriter out)

Compile cette classe dans le répertoire par defaut de compilation (IsisConfig.getCompileDirectory())

Parameters:

force - si vrai alors meme si le fichier destination est plus recent la compilation aura lieu

out - le flux sur lequel le resultat de la compilation doit apparaitre. Peut-etre null, dans ce cas les sorties standards sont utilisées.

Returns:

0 si la compilation a reussi, une autre valeur sinon

doJavadoc

public int doJavadoc(boolean force,
                     PrintWriter out)

Build class javadoc. Ouput javadoc will be stored in default javadoc directory : IsisConfig.getJavadocDirectory()

Parameters:

force - force javadoc build even if destination file is never

out - output print stream. if nullReturns:

0 si la generation a reussi, une autre valeur sinon

getCodeClass

public Class<?> getCodeClass()
                      throws IsisFishException

Retourne la classe compilée. Compile le fichier si besoin.

Returns:

la class

Throws:

IsisFishException

getNewInstance

public Object getNewInstance()
                      throws IsisFishException

Retourne une nouvelle instance de la class. Compile le fichier si besoin.

Returns:

une nouvelle instance de la class

Throws:

IsisFishException - if can't make new instance

getParameterDoc

public static Doc getParameterDoc(Object object,
                                  String paramName)

Get doc of parameter.

Parameters:

object - object containing parameter

paramName - parameter name

Returns:

Doc annotation