Author: tchemit Date: 2009-12-16 22:31:36 +0100 (Wed, 16 Dec 2009) New Revision: 1718 Modified: trunk/topia-persistence/pom.xml trunk/topia-persistence/src/main/java/org/nuiton/topia/TopiaContext.java trunk/topia-persistence/src/main/java/org/nuiton/topia/TopiaContextFactory.java trunk/topia-persistence/src/main/java/org/nuiton/topia/framework/TopiaFiresSupport.java trunk/topia-persistence/src/main/java/org/nuiton/topia/framework/TopiaService.java Log: fix javadocs + use only plexus components tagglets (no need of mojo ones) Modified: trunk/topia-persistence/pom.xml =================================================================== --- trunk/topia-persistence/pom.xml 2009-12-16 20:33:53 UTC (rev 1717) +++ trunk/topia-persistence/pom.xml 2009-12-16 21:31:36 UTC (rev 1718) @@ -122,7 +122,7 @@ <entry> <basedir>${maven.src.dir}/main/java</basedir> <includes> - <include>org\/nuiton\/topia\/framework\/*.java</include> + <include>org/nuiton/topia/framework/*.java</include> </includes> </entry> </entries> Modified: trunk/topia-persistence/src/main/java/org/nuiton/topia/TopiaContext.java =================================================================== --- trunk/topia-persistence/src/main/java/org/nuiton/topia/TopiaContext.java 2009-12-16 20:33:53 UTC (rev 1717) +++ trunk/topia-persistence/src/main/java/org/nuiton/topia/TopiaContext.java 2009-12-16 21:31:36 UTC (rev 1718) @@ -46,7 +46,9 @@ import java.io.Writer; import java.util.List; -/** @author poussin */ +/** + * @author poussin + */ public interface TopiaContext { @@ -99,9 +101,9 @@ /** * Return true if specific service is available * - * @param <E> - * @param interfaceService - * @return + * @param <E> type of service + * @param interfaceService fqn of the service + * @return the service */ public <E extends TopiaService> boolean serviceEnabled( Class<E> interfaceService); @@ -109,9 +111,9 @@ /** * Return the service * - * @param <E> - * @param interfaceService - * @return + * @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) @@ -240,7 +242,7 @@ * <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 - * {@link #replicateEntities(TopiaContext, List<TopiaEntity>)}. + * {@link #replicateEntities(TopiaContext, List)}. * * @param dstCtxt le context de la base destination * @param entityAndCondition paramètre qui vont par deux, qui represente @@ -254,12 +256,12 @@ public void replicate(TopiaContext dstCtxt, Object... entityAndCondition) throws TopiaException, IllegalArgumentException; - /** + /** * Permet de dupliquer une entité du type donné vers un autre context. * - * @param dstCtxt le context de la base destination - * @param entity l'entité à répliquer - * @param <T> le type des entités à répliquer + * @param dstCtxt le context de la base destination + * @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. Modified: trunk/topia-persistence/src/main/java/org/nuiton/topia/TopiaContextFactory.java =================================================================== --- trunk/topia-persistence/src/main/java/org/nuiton/topia/TopiaContextFactory.java 2009-12-16 20:33:53 UTC (rev 1717) +++ trunk/topia-persistence/src/main/java/org/nuiton/topia/TopiaContextFactory.java 2009-12-16 21:31:36 UTC (rev 1718) @@ -93,7 +93,7 @@ /** * Utilise par defaut le fichier de propriete TopiaContextImpl.properties * - * @return + * @return the context using the default configuration file * @throws TopiaNotFoundException Si le fichier de configuration par defaut * n'est pas retrouvé. */ @@ -109,9 +109,9 @@ * Si le context qui devrait etre retourné est ferme, alors un nouveau est * creer et retourné * - * @param config + * @param config the configuration of the context * @return Un TopiaContext ouvert - * @throws TopiaNotFoundException + * @throws TopiaNotFoundException if any pb */ static public TopiaContext getContext(Properties config) throws TopiaNotFoundException { Modified: trunk/topia-persistence/src/main/java/org/nuiton/topia/framework/TopiaFiresSupport.java =================================================================== --- trunk/topia-persistence/src/main/java/org/nuiton/topia/framework/TopiaFiresSupport.java 2009-12-16 20:33:53 UTC (rev 1717) +++ trunk/topia-persistence/src/main/java/org/nuiton/topia/framework/TopiaFiresSupport.java 2009-12-16 21:31:36 UTC (rev 1718) @@ -102,7 +102,7 @@ /** * used to register objects loaded during transaction. - * @param entity + * @param entity the loaded entity */ public void warnOnLoadEntity(TopiaEntity entity) { if (log.isDebugEnabled()) { @@ -118,7 +118,7 @@ /** * used to register objects created during transaction. - * @param entity + * @param entity the created entity */ public void warnOnCreateEntity(TopiaEntity entity) { if (log.isDebugEnabled()) { @@ -134,7 +134,7 @@ /** * used to register objects loaded during transaction. - * @param entity + * @param entity the read entity */ public void warnOnReadEntity(TopiaEntity entity) { if (log.isDebugEnabled()) { @@ -150,7 +150,7 @@ /** * used to register objects modified during transaction. - * @param entity + * @param entity the updated entity */ public void warnOnUpdateEntity(TopiaEntity entity) { if (log.isDebugEnabled()) { @@ -167,7 +167,7 @@ /** * used to register objects deleted during transaction. - * @param entity + * @param entity the deleted entity */ public void warnOnDeleteEntity(TopiaEntity entity) { if (log.isDebugEnabled()) { @@ -529,7 +529,7 @@ // on copie la liste pour evite les acces concurrent (parcours durant la // creation d'un sous context) - Set<TopiaContextImplementor> contextChilds = new HashSet(parent.getChildContext()); + Set<TopiaContextImplementor> contextChilds = new HashSet<TopiaContextImplementor>(parent.getChildContext()); for (TopiaContextImplementor context : contextChilds) { // by sletellier 24/09/09 : Fix concurent acces error @@ -791,10 +791,10 @@ /** * Notify entities listeners for load operation - * @param <E> - * @param context + * @param <E> type of entities + * @param context context used * @param entities entities loaded - * @return + * @return the list of entities loaded */ public <E extends TopiaEntity> List<E> fireEntitiesLoad( TopiaContextImplementor context, List<E> entities) { Modified: trunk/topia-persistence/src/main/java/org/nuiton/topia/framework/TopiaService.java =================================================================== --- trunk/topia-persistence/src/main/java/org/nuiton/topia/framework/TopiaService.java 2009-12-16 20:33:53 UTC (rev 1717) +++ trunk/topia-persistence/src/main/java/org/nuiton/topia/framework/TopiaService.java 2009-12-16 21:31:36 UTC (rev 1718) @@ -50,7 +50,7 @@ * d'indexation on doit avoir: topia.service.index et cette methode doit * retourner index * - * @return + * @return le nom du service */ public String getServiceName();