Author: tchemit
Date: 2010-02-20 14:39:12 +0100 (Sat, 20 Feb 2010)
New Revision: 1806
Modified:
trunk/topia-persistence/src/main/java/org/nuiton/topia/TopiaContext.java
Log:
reformat TopiaContext contract + fix checkstyle
Modified: trunk/topia-persistence/src/main/java/org/nuiton/topia/TopiaContext.java
===================================================================
--- trunk/topia-persistence/src/main/java/org/nuiton/topia/TopiaContext.java 2010-02-20 13:38:35 UTC (rev 1805)
+++ trunk/topia-persistence/src/main/java/org/nuiton/topia/TopiaContext.java 2010-02-20 13:39:12 UTC (rev 1806)
@@ -53,132 +53,132 @@
public interface TopiaContext {
/* Adders */
- public void addTopiaEntityListener(TopiaEntityListener listener);
+ void addTopiaEntityListener(TopiaEntityListener listener);
- public void addTopiaEntityListener(
+ void addTopiaEntityListener(
Class<? extends TopiaEntity> entityClass,
TopiaEntityListener listener);
- public void addTopiaEntityVetoable(TopiaEntityVetoable vetoable);
+ void addTopiaEntityVetoable(TopiaEntityVetoable vetoable);
- public void addTopiaEntityVetoable(
+ void addTopiaEntityVetoable(
Class<? extends TopiaEntity> entityClass,
TopiaEntityVetoable vetoable);
- public void addTopiaTransactionListener(TopiaTransactionListener listener);
+ void addTopiaTransactionListener(TopiaTransactionListener listener);
- public void addTopiaTransactionVetoable(TopiaTransactionVetoable vetoable);
+ void addTopiaTransactionVetoable(TopiaTransactionVetoable vetoable);
- public void addPropertyChangeListener(PropertyChangeListener listener);
+ void addPropertyChangeListener(PropertyChangeListener listener);
- public void addTopiaContextListener(TopiaContextListener listener);
+ void addTopiaContextListener(TopiaContextListener listener);
- public void addTopiaEntitiesVetoable(TopiaEntitiesVetoable vetoable);
+ void addTopiaEntitiesVetoable(TopiaEntitiesVetoable vetoable);
/* Removers */
- public void removeTopiaEntityListener(TopiaEntityListener listener);
+ void removeTopiaEntityListener(TopiaEntityListener listener);
- public void removeTopiaEntityListener(
+ void removeTopiaEntityListener(
Class<? extends TopiaEntity> entityClass,
TopiaEntityListener listener);
- public void removeTopiaEntityVetoable(TopiaEntityVetoable vetoable);
+ void removeTopiaEntityVetoable(TopiaEntityVetoable vetoable);
- public void removeTopiaEntityVetoable(
+ void removeTopiaEntityVetoable(
Class<? extends TopiaEntity> entityClass,
TopiaEntityVetoable vetoable);
- public void removeTopiaTransactionListener(TopiaTransactionListener listener);
+ void removeTopiaTransactionListener(TopiaTransactionListener listener);
- public void removeTopiaTransactionVetoable(TopiaTransactionVetoable vetoable);
+ void removeTopiaTransactionVetoable(TopiaTransactionVetoable vetoable);
- public void removePropertyChangeListener(PropertyChangeListener listener);
+ void removePropertyChangeListener(PropertyChangeListener listener);
- public void removeTopiaContextListener(TopiaContextListener listener);
+ void removeTopiaContextListener(TopiaContextListener listener);
- public void removeTopiaEntitiesVetoable(TopiaEntitiesVetoable vetoable);
+ void removeTopiaEntitiesVetoable(TopiaEntitiesVetoable vetoable);
/**
- * Return true if specific service is available
+ * Return true if specific service is available.
*
* @param <E> type of service
* @param interfaceService fqn of the service
* @return the service
*/
- public <E extends TopiaService> boolean serviceEnabled(
+ <E extends TopiaService> boolean serviceEnabled(
Class<E> interfaceService);
/**
- * Return the service
+ * Return the service.
*
* @param <E> type of service
* @param interfaceService fqn of the service
* @return the service
* @throws TopiaNotFoundException if service is can't be retrieved
*/
- public <E extends TopiaService> E getService(Class<E> interfaceService)
+ <E extends TopiaService> E getService(Class<E> interfaceService)
throws TopiaNotFoundException;
/**
- * Permet de créer le schema de la base de données
+ * Permet de créer le schema de la base de données.
*
* @throws TopiaException if any exception
*/
- public void createSchema() throws TopiaException;
+ void createSchema() throws TopiaException;
/**
- * Permet d'afficher les requetes SQL de creation de base
+ * Permet d'afficher les requetes SQL de creation de base.
*
* @throws TopiaException if any exception
*/
- public void showCreateSchema() throws TopiaException;
+ void showCreateSchema() throws TopiaException;
/**
- * Permet de mettre à jour le schema de la base de données
+ * Permet de mettre à jour le schema de la base de données.
*
* @throws TopiaException if any exception
*/
- public void updateSchema() throws TopiaException;
+ void updateSchema() throws TopiaException;
- public TopiaContext beginTransaction() throws TopiaException;
+ TopiaContext beginTransaction() throws TopiaException;
/**
* applique les modifications apporté a ce context sur la base de données.
*
* @throws TopiaException if any exception
*/
- public void commitTransaction() throws TopiaException;
+ void commitTransaction() throws TopiaException;
/**
- * annule les modifications apporté a ce context
+ * annule les modifications apporté a ce context.
*
* @throws TopiaException if any exception
*/
- public void rollbackTransaction() throws TopiaException;
+ void rollbackTransaction() throws TopiaException;
/**
- * Permet de rechercher un entite directement par son TopiaId
+ * Permet de rechercher un entite directement par son TopiaId.
*
* @param topiaId l'id de l'entite recherche
* @return l'entite trouvee (ou null si non trouve)
* @throws TopiaException if any exception
*/
- public TopiaEntity findByTopiaId(String topiaId) throws TopiaException;
+ TopiaEntity findByTopiaId(String topiaId) throws TopiaException;
/**
- * Permet de faire une requete HQL hibernate directement sur la base
+ * Permet de faire une requete HQL hibernate directement sur la base.
*
* @param hql la requete a faire
* @param args les arguments de la requete
* @return La liste des resultats
* @throws TopiaException si une erreur survient durant la requete
*/
- public List find(String hql, Object... args) throws TopiaException;
+ List find(String hql, Object... args) throws TopiaException;
/**
* Permet de faire une requete HQL hibernate directement sur la base
- * en precisant la fenetre des elements a remonter avec les parametres <code>startIndex</code>
- * et <code>endIndex</code>.
+ * en precisant la fenetre des elements a remonter avec les parametres
+ * {@code startIndex} et {@code endIndex}.
*
* @param hql la requete a faire
* @param startIndex la position du premier element a remonter
@@ -187,18 +187,18 @@
* @return La liste des resultats
* @throws TopiaException si une erreur survient durant la requete
*/
- public List find(String hql, int startIndex, int endIndex, Object... args)
+ List find(String hql, int startIndex, int endIndex, Object... args)
throws TopiaException;
/**
- * Execute HQL operation on data (Update, Delete)
+ * Execute HQL operation on data (Update, Delete).
*
* @param hql la requete a faire
* @param args les arguments de la requete
* @return The number of entities updated or deleted.
* @throws TopiaException if any exception
*/
- public int execute(String hql, Object... args) throws TopiaException;
+ int execute(String hql, Object... args) throws TopiaException;
/**
* Permet d'ajouter dans le TopiaContext une TopiaEntity créé par un
@@ -207,53 +207,56 @@
* @param e l'entity a ajouter
* @throws TopiaException if any exception
*/
- public void add(TopiaEntity e) throws TopiaException;
+ void add(TopiaEntity e) throws TopiaException;
/**
- * Permet d'importer des données en XML
+ * Permet d'importer des données en XML.
*
* @param xml le flux XML
* @throws TopiaException si une erreur survient durant l'import
*/
- public void importXML(Reader xml) throws TopiaException;
+ void importXML(Reader xml) throws TopiaException;
/**
- * Permet d'exporter certaines données en XML
+ * Permet d'exporter certaines données en XML.
* <p/>
- * <b>Note:</b> Si le parametre <code>entityAndCondition</code> est vide, alors on duplique
- * toutes les entités de la base.
+ * <b>Note:</b> Si le parametre <code>entityAndCondition</code> est vide,
+ * alors on duplique toutes les entités de la base.
*
* @param xml le flux XML dans lequel il faut ecrire
* @param entityAndCondition paramètre qui vont par deux, qui represente
- * la classe de l'entity a exporter et la condition where que doit
- * respecter l'objet pour etre exporter
- * (entityClass, condition)
+ * la classe de l'entity a exporter et la
+ * condition where que doit respecter l'objet
+ * pour etre exporter (entityClass, condition)
* @throws TopiaException si une erreur survient durant l'export
*/
- public void exportXML(Writer xml, Object... entityAndCondition)
+ void exportXML(Writer xml, Object... entityAndCondition)
throws TopiaException;
/**
* Permet de dupliquer de ce context vers un context d'une autre base des
* données sans modification des entites.
* <p/>
- * <b>Note:</b> Si le parametre <code>entityAndCondition</code> est vide, alors on duplique
- * toutes les entités de la base.
+ * <b>Note:</b> Si le parametre <code>entityAndCondition</code> est vide,
+ * alors on duplique toutes les entités de la base.
* <p/>
- * <b>Note 2:</b> Il se peut que la replication simple ne soit pas suffisante (par example
- * si l'on veut repliquer q'une partie d'une entité), on utilisera donc la seconde méthode
+ * <b>Note 2:</b> Il se peut que la replication simple ne soit pas
+ * suffisante (par example si l'on veut repliquer q'une partie d'une
+ * entité), on utilisera donc la seconde méthode
* {@link #replicateEntities(TopiaContext, List)}.
*
* @param dstCtxt le context de la base destination
* @param entityAndCondition paramètre qui vont par deux, qui represente
- * la classe de l'entity a exporter et la condition where que doit
+ * la classe de l'entity a exporter et la
+ * condition where que doit
* respecter l'objet pour etre exporter
* (entityClass, condition)
* @throws TopiaException si une erreur pendant la duplication
- * @throws IllegalArgumentException si l'un des context n'est pas ouvert, ou si on essaye de
- * dupliquer dans la même base.
+ * @throws IllegalArgumentException si l'un des context n'est pas ouvert,
+ * ou si on essaye de dupliquer dans la
+ * même base.
*/
- public void replicate(TopiaContext dstCtxt, Object... entityAndCondition)
+ void replicate(TopiaContext dstCtxt, Object... entityAndCondition)
throws TopiaException, IllegalArgumentException;
/**
@@ -263,10 +266,11 @@
* @param entity l'entité à répliquer
* @param <T> le type des entités à répliquer
* @throws TopiaException si une erreur pendant la duplication
- * @throws IllegalArgumentException si l'un des context n'est pas ouvert, ou si on essaye de
- * dupliquer dans la même base.
+ * @throws IllegalArgumentException si l'un des context n'est pas ouvert,
+ * ou si on essaye de dupliquer dans la
+ * même base.
*/
- public <T extends TopiaEntity> void replicateEntity(TopiaContext dstCtxt, T entity)
+ <T extends TopiaEntity> void replicateEntity(TopiaContext dstCtxt, T entity)
throws TopiaException, IllegalArgumentException;
/**
@@ -276,55 +280,58 @@
* @param entities les entités à répliquer
* @param <T> le type des entités à répliquer
* @throws TopiaException si une erreur pendant la duplication
- * @throws IllegalArgumentException si l'un des context n'est pas ouvert, ou si on essaye de
- * dupliquer dans la même base.
+ * @throws IllegalArgumentException si l'un des context n'est pas ouvert,
+ * ou si on essaye de dupliquer dans
+ * la même base.
*/
- public <T extends TopiaEntity> void replicateEntities(TopiaContext dstCtxt, List<T> entities)
+ <T extends TopiaEntity> void replicateEntities(TopiaContext dstCtxt,
+ List<T> entities)
throws TopiaException, IllegalArgumentException;
/**
* Sauve la base de données dans un format natif a la base, la
* representation n'est pas portable d'une base a l'autre. Cette methode
* ne doit être utilisé que pour un stockage temporaire utile à une
- * application
+ * application.
*
* @param file le nom du fichier ou stocker les informations
* @param compress si vrai compress le fichier avec gzip
* @throws TopiaException if any exception
*/
- public void backup(File file, boolean compress) throws TopiaException;
+ void backup(File file, boolean compress) throws TopiaException;
/**
* Supprime toutes les tables et autres elements de la database.
*
* @param dropDatabase si vrai alors supprime aussi la base de données
- * si la base utilise des fichiers les fichiers seront supprimé (ex: h2)
- * ou sera fait sur la base (pastgresql)
+ * si la base utilise des fichiers les fichiers seront
+ * supprimé (ex: h2) ou sera fait sur la base
+ * (postgresql)
* @throws TopiaException if any exception
*/
- public void clear(boolean dropDatabase) throws TopiaException;
+ void clear(boolean dropDatabase) throws TopiaException;
/**
- * l'inverse de la methode {@link #backup(File,boolean)}
+ * l'inverse de la methode {@link #backup(File,boolean)}.
*
* @param file le fichier ou prendre les informations, il peut-etre
* compressé avec gzip ou non.
* @throws TopiaException if any exception
*/
- public void restore(File file) throws TopiaException;
+ void restore(File file) throws TopiaException;
/**
- * Ferme le contexte
+ * Ferme le contexte.
*
* @throws TopiaException if any exception
*/
- public void closeContext() throws TopiaException;
+ void closeContext() throws TopiaException;
/**
- * Indique si le contexte a ete ferme
+ * Indique si le contexte a ete ferme.
*
- * @return <code>true</code> si le context est ferme, <code>false</code> autrement
+ * @return {@code true} si le context est ferme, {@code false} autrement
*/
- public boolean isClosed();
+ boolean isClosed();
} //TopiaContext