branch feature/3858_javadoc_jdk8 created (now 2545932)
This is an automated email from the git hooks/post-receive script. New change to branch feature/3858_javadoc_jdk8 in repository topia. See http://git.nuiton.org/topia.git at 2545932 Fix javadoc in tests (See #3858) This branch includes the following new commits: new c4426e9 Fix javadoc in persistence module (See #3858) new 7e60561 Fix javadoc in templates module (See #3858) new d73ad89 Fix javadoc in service replication module (See #3858) new b099508 Fix javadoc in service migration module (See #3858) new 9d864dd Fix javadoc in service csv module (See #3858) new 2e7869a Fix javadoc in it module (See #3858) new d3fd806 Fix javadoc junit module (See #3858) new 2545932 Fix javadoc in tests (See #3858) The 8 revisions listed above as "new" are entirely new to this repository and will be described in separate emails. The revisions listed as "adds" were already present in the repository and have only been added to this reference. Detailed log of new commits: commit 2545932c6abc9203254e9212bfe1ee0120b3c3bf Author: Tony CHEMIT <chemit@codelutin.com> Date: Wed Dec 30 16:45:05 2015 +0100 Fix javadoc in tests (See #3858) commit d3fd8060851c6c61b0adc1dc3d8c1b4e730ac4a7 Author: Tony CHEMIT <chemit@codelutin.com> Date: Wed Dec 30 16:37:36 2015 +0100 Fix javadoc junit module (See #3858) commit 2e7869a7eb144107f783135f5e1d019f55cbc7ab Author: Tony CHEMIT <chemit@codelutin.com> Date: Wed Dec 30 16:37:28 2015 +0100 Fix javadoc in it module (See #3858) commit 9d864dd6eeac25cd73711c93d52114ce6873a961 Author: Tony CHEMIT <chemit@codelutin.com> Date: Wed Dec 30 16:37:14 2015 +0100 Fix javadoc in service csv module (See #3858) commit b09950839d578f5024606f89fe6e0409218c73dd Author: Tony CHEMIT <chemit@codelutin.com> Date: Wed Dec 30 16:37:03 2015 +0100 Fix javadoc in service migration module (See #3858) commit d73ad89cf96f5802a0293117d6c13c85fa35acfc Author: Tony CHEMIT <chemit@codelutin.com> Date: Wed Dec 30 16:36:52 2015 +0100 Fix javadoc in service replication module (See #3858) commit 7e60561901a6b4e61a97b2271470a978b61a7802 Author: Tony CHEMIT <chemit@codelutin.com> Date: Wed Dec 30 16:29:09 2015 +0100 Fix javadoc in templates module (See #3858) commit c4426e96bab77ba680c672c33a13a004b26501e6 Author: Tony CHEMIT <chemit@codelutin.com> Date: Wed Dec 30 16:12:22 2015 +0100 Fix javadoc in persistence module (See #3858) -- To stop receiving notification emails like this one, please contact nuiton.org SCM administrator <admin+scm@nuiton.org>.
This is an automated email from the git hooks/post-receive script. New commit to branch feature/3858_javadoc_jdk8 in repository topia. See http://git.nuiton.org/topia.git commit c4426e96bab77ba680c672c33a13a004b26501e6 Author: Tony CHEMIT <chemit@codelutin.com> Date: Wed Dec 30 16:12:22 2015 +0100 Fix javadoc in persistence module (See #3858) --- .../topia/persistence/DepthEntityVisitor.java | 10 ++-- .../topia/persistence/HorizontalEntityVisitor.java | 4 +- .../topia/persistence/HqlAndParametersBuilder.java | 31 +++++++---- .../persistence/QueryMissingOrderException.java | 2 +- .../SchemaValidationTopiaException.java | 1 + .../topia/persistence/TopiaApplicationContext.java | 29 +++++----- .../persistence/TopiaApplicationContextCache.java | 4 +- .../topia/persistence/TopiaConfiguration.java | 8 +-- .../persistence/TopiaConfigurationBuilder.java | 4 +- .../persistence/TopiaConfigurationConstants.java | 12 ++--- .../org/nuiton/topia/persistence/TopiaDao.java | 50 +++++++++++++---- .../nuiton/topia/persistence/TopiaDaoSupplier.java | 3 ++ .../nuiton/topia/persistence/TopiaEntities.java | 6 ++- .../org/nuiton/topia/persistence/TopiaEntity.java | 10 ++-- .../topia/persistence/TopiaEntityContextable.java | 2 +- .../nuiton/topia/persistence/TopiaEntityEnum.java | 18 +++---- .../topia/persistence/TopiaEntityEnumProvider.java | 4 +- .../topia/persistence/TopiaEntityVisitor.java | 14 ++--- .../nuiton/topia/persistence/TopiaException.java | 6 +-- .../nuiton/topia/persistence/TopiaIdFactory.java | 9 ++-- .../topia/persistence/TopiaMigrationService.java | 2 +- .../topia/persistence/TopiaNotFoundException.java | 4 +- .../topia/persistence/TopiaPersistenceContext.java | 25 ++++----- .../TopiaQueryBuilderAddCriteriaStep.java | 2 +- .../persistence/TopiaQueryBuilderRunQueryStep.java | 42 +++++++-------- ...iaQueryBuilderRunQueryWithUniqueResultStep.java | 4 +- .../topia/persistence/TopiaQueryException.java | 2 +- .../nuiton/topia/persistence/TopiaTransaction.java | 4 +- .../topia/persistence/TopiaTransactionAware.java | 6 +-- .../topia/persistence/TopiaVetoException.java | 4 +- .../topia/persistence/event/EntityState.java | 14 ++--- .../topia/persistence/event/ListenableBean.java | 10 ++-- .../persistence/event/ListenableTopiaEntity.java | 2 +- .../persistence/event/TopiaContextAdapter.java | 2 +- .../topia/persistence/event/TopiaContextEvent.java | 9 ++-- .../persistence/event/TopiaEntitiesEvent.java | 2 +- .../persistence/event/TopiaEntitiesVetoable.java | 2 +- .../topia/persistence/event/TopiaEntityEvent.java | 2 +- .../persistence/event/TopiaEntityListener.java | 4 +- .../persistence/event/TopiaEntityVetoable.java | 4 +- .../persistence/event/TopiaSchemaListener.java | 2 +- .../persistence/event/TopiaTransactionEvent.java | 2 +- .../event/TopiaTransactionListener.java | 10 ++-- .../event/TopiaTransactionVetoable.java | 4 +- .../internal/AbstractTopiaApplicationContext.java | 5 +- .../persistence/internal/AbstractTopiaDao.java | 49 ++++++++++------- .../persistence/internal/AbstractTopiaEntity.java | 8 +-- ...opiaPersistenceContextConstructorParameter.java | 1 + .../FullyQualifiedNamePlusUuidTopiaIdFactory.java | 2 +- .../persistence/internal/HibernateProvider.java | 54 ++++++++++--------- .../persistence/internal/ShortTopiaIdFactory.java | 3 +- .../internal/TopiaConnectionProvider.java | 20 ++++--- .../internal/TopiaHibernateSessionRegistry.java | 4 +- .../support/HibernateTopiaReplicationSupport.java | 4 +- .../internal/support/TopiaFiresSupport.java | 4 +- .../internal/support/TopiaServiceSupportImpl.java | 4 +- .../topia/persistence/jdbc/JdbcConfiguration.java | 2 +- .../topia/persistence/jdbc/JdbcH2Helper.java | 8 ++- .../nuiton/topia/persistence/legacy/Collector.java | 4 +- .../nuiton/topia/persistence/legacy/DBMapping.java | 2 +- .../persistence/legacy/EntityListUpdator.java | 4 +- .../topia/persistence/legacy/ListUpdator.java | 6 +-- .../nuiton/topia/persistence/legacy/Loador.java | 6 +-- .../topia/persistence/support/TopiaJpaSupport.java | 45 ++++++++-------- .../support/TopiaListenableSupport.java | 18 +++---- .../support/TopiaReplicationSupport.java | 20 +++---- .../persistence/support/TopiaServiceSupport.java | 6 ++- .../topia/persistence/support/TopiaSqlQuery.java | 2 +- .../topia/persistence/support/TopiaSqlSupport.java | 2 + .../nuiton/topia/persistence/util/DiffState.java | 6 +-- .../topia/persistence/util/EntityOperator.java | 62 +++++++++++----------- .../persistence/util/EntityOperatorStore.java | 2 +- .../topia/persistence/util/TopiaEntityBinder.java | 7 +-- .../topia/persistence/util/TopiaEntityHelper.java | 24 ++++----- .../topia/persistence/util/TopiaEntityMap.java | 2 +- .../topia/persistence/util/TopiaEntityRef.java | 4 +- .../nuiton/topia/persistence/util/TopiaH2Util.java | 2 +- .../nuiton/topia/persistence/util/TopiaUtil.java | 8 +-- 78 files changed, 439 insertions(+), 352 deletions(-) diff --git a/topia-persistence/src/main/java/org/nuiton/topia/persistence/DepthEntityVisitor.java b/topia-persistence/src/main/java/org/nuiton/topia/persistence/DepthEntityVisitor.java index 8ff2763..5695039 100644 --- a/topia-persistence/src/main/java/org/nuiton/topia/persistence/DepthEntityVisitor.java +++ b/topia-persistence/src/main/java/org/nuiton/topia/persistence/DepthEntityVisitor.java @@ -24,17 +24,17 @@ package org.nuiton.topia.persistence; * #L% */ -import java.util.ArrayList; -import java.util.Collection; - import org.apache.commons.logging.Log; import org.apache.commons.logging.LogFactory; +import java.util.ArrayList; +import java.util.Collection; + /** * Visitor to run through the entity graph by depth. * - * @author echatellier <chatellier@codelutin.com> - * @author tchemit <tchemit@codelutin.com> + * @author Éric Chatellier - chatellier@codelutin.com + * @author Tony Chemit - tchemit@codelutin.com */ public class DepthEntityVisitor implements TopiaEntityVisitor { diff --git a/topia-persistence/src/main/java/org/nuiton/topia/persistence/HorizontalEntityVisitor.java b/topia-persistence/src/main/java/org/nuiton/topia/persistence/HorizontalEntityVisitor.java index 5d3664c..40d0ae9 100644 --- a/topia-persistence/src/main/java/org/nuiton/topia/persistence/HorizontalEntityVisitor.java +++ b/topia-persistence/src/main/java/org/nuiton/topia/persistence/HorizontalEntityVisitor.java @@ -34,8 +34,8 @@ import org.apache.commons.logging.LogFactory; /** * Visitor to run through entities horizontally, then delegate visiting to another visitor. * - * @author echatellier <chatellier@codelutin.com> - * @author tchemit <tchemit@codelutin.com> + * @author Éric Chatellier - chatellier@codelutin.com + * @author Tony Chemit - tchemit@codelutin.com */ public class HorizontalEntityVisitor implements TopiaEntityVisitor { diff --git a/topia-persistence/src/main/java/org/nuiton/topia/persistence/HqlAndParametersBuilder.java b/topia-persistence/src/main/java/org/nuiton/topia/persistence/HqlAndParametersBuilder.java index 137218d..2edf1a7 100644 --- a/topia-persistence/src/main/java/org/nuiton/topia/persistence/HqlAndParametersBuilder.java +++ b/topia-persistence/src/main/java/org/nuiton/topia/persistence/HqlAndParametersBuilder.java @@ -50,7 +50,7 @@ import java.util.Set; /** * A builder to create syntactically correct HQL and associated parameters given properties or after various constraint * adds. - * <p/> + * * It may be used in a Dao to ease dynamic construction of queries. * * @since 3.0 @@ -85,6 +85,7 @@ public class HqlAndParametersBuilder<E extends TopiaEntity> { } /** + * @param alias FIXME * @deprecated use constructor, alias should not be changed */ @Deprecated @@ -149,7 +150,9 @@ public class HqlAndParametersBuilder<E extends TopiaEntity> { } /** - * @param in true if property value must be in given collection, false if value must not be in given collection + * @param property FIXME + * @param values FIXME + * @param in true if property value must be in given collection, false if value must not be in given collection */ protected void addInOrNotIn(String property, Collection<?> values, boolean in) { Preconditions.checkArgument(StringUtils.isNotEmpty(property)); @@ -198,7 +201,9 @@ public class HqlAndParametersBuilder<E extends TopiaEntity> { } /** - * @see {@link org.nuiton.topia.persistence.TopiaQueryBuilderAddCriteriaStep#addTopiaIdEquals(String, String)} + * @param property FIXME + * @param topiaId FIXME + * @see org.nuiton.topia.persistence.TopiaQueryBuilderAddCriteriaStep#addTopiaIdEquals(String, String) */ public void addTopiaIdEquals(String property, String topiaId) { Preconditions.checkNotNull(topiaId); @@ -206,14 +211,18 @@ public class HqlAndParametersBuilder<E extends TopiaEntity> { } /** - * @see {@link org.nuiton.topia.persistence.TopiaQueryBuilderAddCriteriaStep#addTopiaIdIn(String, java.util.Collection)} + * @param property FIXME + * @param topiaIds FIXME + * @see org.nuiton.topia.persistence.TopiaQueryBuilderAddCriteriaStep#addTopiaIdIn(String, java.util.Collection) */ public void addTopiaIdIn(String property, Collection<String> topiaIds) { addIn(property + "." + TopiaEntity.PROPERTY_TOPIA_ID, topiaIds); } /** - * @see {@link org.nuiton.topia.persistence.TopiaQueryBuilderAddCriteriaStep#addTopiaIdNotEquals(String, String)} + * @param property FIXME + * @param topiaId FIXME + * @see org.nuiton.topia.persistence.TopiaQueryBuilderAddCriteriaStep#addTopiaIdNotEquals(String, String) */ public void addTopiaIdNotEquals(String property, String topiaId) { Preconditions.checkNotNull(topiaId); @@ -221,7 +230,9 @@ public class HqlAndParametersBuilder<E extends TopiaEntity> { } /** - * @see {@link org.nuiton.topia.persistence.TopiaQueryBuilderAddCriteriaStep#addTopiaIdNotIn(String, java.util.Collection)} + * @param property FIXME + * @param topiaIds FIXME + * @see org.nuiton.topia.persistence.TopiaQueryBuilderAddCriteriaStep#addTopiaIdNotIn(String, java.util.Collection) */ public void addTopiaIdNotIn(String property, Collection<String> topiaIds) { addNotIn(property + "." + TopiaEntity.PROPERTY_TOPIA_ID, (Collection) topiaIds); @@ -329,11 +340,11 @@ public class HqlAndParametersBuilder<E extends TopiaEntity> { } public void addCollectionIsEmpty(String property) { - whereClauses.add(alias + "." + property + " is empty" ); + whereClauses.add(alias + "." + property + " is empty"); } public void addCollectionIsNotEmpty(String property) { - whereClauses.add(alias + "." + property + " is not empty" ); + whereClauses.add(alias + "." + property + " is not empty"); } public void addWhereClause(String whereClause, Map<String, Object> hqlParameters) { @@ -527,7 +538,7 @@ public class HqlAndParametersBuilder<E extends TopiaEntity> { /** * Converts a (nested) property name to an HQL argument name. - * <p/> + * * For example getParameterName("yearlyDeclaration.survey.topiaId") → "yearlyDeclarationSurveyTopiaId" * * @param propertyName the name of a property, can be a path to a nested property @@ -544,6 +555,8 @@ public class HqlAndParametersBuilder<E extends TopiaEntity> { /** * Add a parameter in the parameters map searching with the suitable parameter name in order to prevent conflicts. * + * @param propertyName FIXME + * @param value FIXME * @return the found key where the parameter has been added, suitable to use in the where clause */ protected String putHqlParameterWithAvailableName(String propertyName, Object value) { diff --git a/topia-persistence/src/main/java/org/nuiton/topia/persistence/QueryMissingOrderException.java b/topia-persistence/src/main/java/org/nuiton/topia/persistence/QueryMissingOrderException.java index b6a4bb8..b7517f9 100644 --- a/topia-persistence/src/main/java/org/nuiton/topia/persistence/QueryMissingOrderException.java +++ b/topia-persistence/src/main/java/org/nuiton/topia/persistence/QueryMissingOrderException.java @@ -31,7 +31,7 @@ import org.nuiton.util.pagination.PaginationParameter; /** * If you get this exception, it means that you asked ToPIA to make an operation that needs a deterministic way to sort * the result but you didn't defined such query. - * <p/> + * * To fix you issue, you may use another API call (maybe user findAny instead of findFirst) or change your query by * adding an order by clause. A quick and easy fix would be to just use "order by topiaId". * diff --git a/topia-persistence/src/main/java/org/nuiton/topia/persistence/SchemaValidationTopiaException.java b/topia-persistence/src/main/java/org/nuiton/topia/persistence/SchemaValidationTopiaException.java index dc41656..65a3f2c 100644 --- a/topia-persistence/src/main/java/org/nuiton/topia/persistence/SchemaValidationTopiaException.java +++ b/topia-persistence/src/main/java/org/nuiton/topia/persistence/SchemaValidationTopiaException.java @@ -57,6 +57,7 @@ public class SchemaValidationTopiaException extends TopiaException { /** * If given {@link HibernateException} is about schema validation, throw a SchemaValidationTopiaException. + * @param hibernateException FIXME */ public static void throwIfHibernateExceptionIsAboutSchemaValidation(HibernateException hibernateException) { // XXX brendan 06/05/15 dirty hack to know if e is about schema validation since Hibernate exception management sucks diff --git a/topia-persistence/src/main/java/org/nuiton/topia/persistence/TopiaApplicationContext.java b/topia-persistence/src/main/java/org/nuiton/topia/persistence/TopiaApplicationContext.java index d1655ff..62f2107 100644 --- a/topia-persistence/src/main/java/org/nuiton/topia/persistence/TopiaApplicationContext.java +++ b/topia-persistence/src/main/java/org/nuiton/topia/persistence/TopiaApplicationContext.java @@ -35,39 +35,38 @@ import java.util.List; * * <p>Most of the time, there is only one instance of this context during the entire lifecycle of a application.</p> * - * <p>This contract provides facility to : - * <ul> - * <li>create a new {@link org.nuiton.topia.persistence.TopiaPersistenceContext};</li> - * <li>get meta information about the application (model name, version);</li> - * <li>get meta information about the entities;</li> - * <li>do schema related operations;</li> - * <li>shutdown the application</li> - * </ul> - * </p> + * <p>This contract provides facility to :</p> + * <ul> + * <li>create a new {@link org.nuiton.topia.persistence.TopiaPersistenceContext};</li> + * <li>get meta information about the application (model name, version);</li> + * <li>get meta information about the entities;</li> + * <li>do schema related operations;</li> + * <li>shutdown the application</li> + * </ul> * * <p>This contract has an abstract implementation * ({@link org.nuiton.topia.persistence.internal.AbstractTopiaApplicationContext}) which is itself extended by a - * generated <code>AbstractXxxTopiaApplicationContext</code> (where <code>Xxx</code> is the project name), itself - * extended by <code>XxxTopiaApplicationContext</code>.</p> + * generated {@code AbstractXxxTopiaApplicationContext} (where {@code Xxx} is the project name), itself + * extended by {@code XxxTopiaApplicationContext}.</p> * - * <p>The full hierarchy is : <pre> + * <p>The full hierarchy is :</p> <pre> * TopiaApplicationContext (this contract) * \--AbstractTopiaApplicationContext * \--AbstractXxxTopiaApplicationContext (generated) * \--XxxTopiaApplicationContext (generated) * </pre> - * (where <code>Xxx</code> is the project name)</p> + * <p>(where {@code Xxx} is the project name)</p> * * <p>Created on 12/20/13.</p> * - * @author Tony Chemit : chemit@codelutin.com + * @author Tony Chemit - tchemit@codelutin.com * @since 3.0 */ public interface TopiaApplicationContext<K extends TopiaPersistenceContext> extends TopiaListenableSupport, TopiaServiceSupport, Closeable { /** - * Creates a new instance of XxxTopiaPersistenceContext (where <code>Xxx</code> is the project name). This is the + * Creates a new instance of XxxTopiaPersistenceContext (where {@code Xxx} is the project name). This is the * method to use in order to start a new transaction. * * @return a newly created instance of your project's specific diff --git a/topia-persistence/src/main/java/org/nuiton/topia/persistence/TopiaApplicationContextCache.java b/topia-persistence/src/main/java/org/nuiton/topia/persistence/TopiaApplicationContextCache.java index 931a5cc..436087e 100644 --- a/topia-persistence/src/main/java/org/nuiton/topia/persistence/TopiaApplicationContextCache.java +++ b/topia-persistence/src/main/java/org/nuiton/topia/persistence/TopiaApplicationContextCache.java @@ -58,7 +58,7 @@ public class TopiaApplicationContextCache { /** * Static method that can provide an ApplicationContext. If the found context is closed, or if it does not exist, a - * new one is created using the given Function<Properties, C>. + * new one is created using the given {@code Function<Properties, C>}. * * @param <C> the type of TopiaApplicationContext you expect * @param config the configuration of the context @@ -96,7 +96,7 @@ public class TopiaApplicationContextCache { /** * Method to get the list of contexts in memory (each context is identified by its URL). - * <p/> + * * To be used for debugging purpose only. * * @return a list of contexts URLs diff --git a/topia-persistence/src/main/java/org/nuiton/topia/persistence/TopiaConfiguration.java b/topia-persistence/src/main/java/org/nuiton/topia/persistence/TopiaConfiguration.java index b2eb019..82408f6 100644 --- a/topia-persistence/src/main/java/org/nuiton/topia/persistence/TopiaConfiguration.java +++ b/topia-persistence/src/main/java/org/nuiton/topia/persistence/TopiaConfiguration.java @@ -28,7 +28,7 @@ import java.util.Map; /** * Configuration needed to instantiate a {@link org.nuiton.topia.persistence.TopiaApplicationContext}. - * <p/> + * * Please use an instance of {@link org.nuiton.topia.persistence.TopiaConfigurationBuilder} to build a new * TopiaConfiguration. * @@ -52,6 +52,7 @@ public interface TopiaConfiguration extends JdbcConfiguration { * {@link SchemaValidationTopiaException} if the schema is not suitable for ToPIA to run * fine. * + * @return FIXME * @since 3.0 */ boolean isValidateSchema(); @@ -59,6 +60,7 @@ public interface TopiaConfiguration extends JdbcConfiguration { /** * Configuration directive to change topia Ids generation strategy. * + * @return FIXME * @since 3.0 */ TopiaIdFactory getTopiaIdFactory(); @@ -69,10 +71,10 @@ public interface TopiaConfiguration extends JdbcConfiguration { * Topia will automatically generate an Hibernate configuration for you based * on the different element of this TopiaConfiguration. However, you can tune Hibernate * by adding Hibernate configuration directive to this Map. - * <p/> + * * We highly recommend you to use constants in {@link org.nuiton.topia.persistence.HibernateAvailableSettings} * as keys of the map. - * <p/> + * * You <strong>MUST NOT</strong> pass {@link HibernateAvailableSettings#HBM2DDL_AUTO} since * ToPIA will use validate. If you want use it, have a look at {@link org.nuiton.topia.persistence.HibernateTopiaMigrationService} * diff --git a/topia-persistence/src/main/java/org/nuiton/topia/persistence/TopiaConfigurationBuilder.java b/topia-persistence/src/main/java/org/nuiton/topia/persistence/TopiaConfigurationBuilder.java index a793392..e6cce6e 100644 --- a/topia-persistence/src/main/java/org/nuiton/topia/persistence/TopiaConfigurationBuilder.java +++ b/topia-persistence/src/main/java/org/nuiton/topia/persistence/TopiaConfigurationBuilder.java @@ -45,7 +45,7 @@ import java.util.Properties; /** * Builder to create a {@link org.nuiton.topia.persistence.TopiaConfiguration} instance. - * <p/> + * * A few methods from {@link org.nuiton.topia.persistence.jdbc.JdbcConfiguration} are delegated here. */ public class TopiaConfigurationBuilder { @@ -82,6 +82,8 @@ public class TopiaConfigurationBuilder { /** * Do nothing but throws {@link TopiaMisconfigurationException} if there is a problem in * given configuration. + * @param topiaConfiguration FIXME + * @throws TopiaMisconfigurationException FIXME */ public void check(TopiaConfiguration topiaConfiguration) throws TopiaMisconfigurationException { if (StringUtils.isBlank(topiaConfiguration.getJdbcConnectionUrl())) { diff --git a/topia-persistence/src/main/java/org/nuiton/topia/persistence/TopiaConfigurationConstants.java b/topia-persistence/src/main/java/org/nuiton/topia/persistence/TopiaConfigurationConstants.java index 473ed2f..99184cf 100644 --- a/topia-persistence/src/main/java/org/nuiton/topia/persistence/TopiaConfigurationConstants.java +++ b/topia-persistence/src/main/java/org/nuiton/topia/persistence/TopiaConfigurationConstants.java @@ -26,7 +26,7 @@ package org.nuiton.topia.persistence; /** * This class lists the configuration variables that ToPIA expects - * <p/> + * * Created on 12/20/13. * * @author Tony Chemit - chemit@codelutin.com @@ -38,13 +38,13 @@ package org.nuiton.topia.persistence; public interface TopiaConfigurationConstants { /** - * @deprecated use {@link org.nuiton.topia.persistence.TopiaConfiguration#getSchemaName()} + * @deprecated use {@link TopiaConfiguration#getSchemaName()} */ @Deprecated String CONFIG_DEFAULT_SCHEMA = TopiaConfigurationBuilder.CONFIG_DEFAULT_SCHEMA; /** - * @deprecated use {@link org.nuiton.topia.persistence.TopiaConfiguration#getJdbcConnectionUser()} + * @deprecated use {@link TopiaConfiguration#getJdbcConnectionUser()} */ @Deprecated String CONFIG_USER = TopiaConfigurationBuilder.CONFIG_USER; @@ -117,20 +117,20 @@ public interface TopiaConfigurationConstants { String CONFIG_SHOW_SQL = HibernateAvailableSettings.SHOW_SQL; /** - * @deprecated use {@link org.nuiton.topia.persistence.TopiaConfiguration#getJdbcConnectionUrl()} + * @deprecated use {@link TopiaConfiguration#getJdbcConnectionUrl()} */ @Deprecated String CONFIG_URL = TopiaConfigurationBuilder.CONFIG_URL; /** - * @deprecated use {@link TopiaConfiguration#getTopiaIdFactoryClassName()} + * @deprecated use {@link TopiaConfiguration#getTopiaIdFactory()} */ @Deprecated String CONFIG_PERSISTENCE_TOPIA_ID_FACTORY_CLASS_NAME = TopiaConfigurationBuilder.CONFIG_PERSISTENCE_TOPIA_ID_FACTORY_CLASS_NAME; /** - * @deprecated use {@link org.nuiton.topia.persistence.TopiaConfiguration#isInitSchema()} + * @deprecated use {@link TopiaConfiguration#isInitSchema()} */ @Deprecated String CONFIG_PERSISTENCE_INIT_SCHEMA = TopiaConfigurationBuilder.CONFIG_PERSISTENCE_INIT_SCHEMA; diff --git a/topia-persistence/src/main/java/org/nuiton/topia/persistence/TopiaDao.java b/topia-persistence/src/main/java/org/nuiton/topia/persistence/TopiaDao.java index 89b0020..b20181f 100644 --- a/topia-persistence/src/main/java/org/nuiton/topia/persistence/TopiaDao.java +++ b/topia-persistence/src/main/java/org/nuiton/topia/persistence/TopiaDao.java @@ -50,7 +50,7 @@ public interface TopiaDao<E extends TopiaEntity> extends Iterable<E> { /** * Obtains the batch size used to load data. - * <p/> + * * Default value if 1000. * * @return the batch size. @@ -67,15 +67,14 @@ public interface TopiaDao<E extends TopiaEntity> extends Iterable<E> { void setBatchSize(int batchSize); /** - * Create a new instance of managed entity <strong>not persisted</strong>. - * + * @return Create a new instance of managed entity <strong>not persisted</strong>. * @since 2.3.1 */ E newInstance(); /** * Creates a new pager initialized for the first page of all data of the dao. - * <p/> + * * <strong>Note:</strong> This method will execute a count query to init * the pager. * @@ -88,7 +87,7 @@ public interface TopiaDao<E extends TopiaEntity> extends Iterable<E> { /** * Creates a new pager initialized for the first page of data of the given * query. - * <p/> + * * <strong>Note:</strong> This method will execute a count query to init * the pager. * @@ -111,6 +110,10 @@ public interface TopiaDao<E extends TopiaEntity> extends Iterable<E> { E create(E entity); /** + * @param propertyName FIXME + * @param propertyValue FIXME + * @param otherPropertyNamesAndValues FIXME + * @return FIXME * @since 3.0 */ E create(String propertyName, Object propertyValue, Object... otherPropertyNamesAndValues); @@ -120,12 +123,12 @@ public interface TopiaDao<E extends TopiaEntity> extends Iterable<E> { * * @param properties the key-value list of properties that the created entity will have. * @return the newly created entity - * @throws IllegalArgumentException if some property type is not the - * expected one + * @throws IllegalArgumentException if some property type is not the expected one */ E create(Map<String, Object> properties); /** + * @return FIXME * @since 3.0 */ E create(); @@ -156,22 +159,26 @@ public interface TopiaDao<E extends TopiaEntity> extends Iterable<E> { /** * Finds all the entities managed by this DAO. * - * @return the full list of entities in no particular - * (non-determinisic) order + * @return the full list of entities in no particular (non-determinisic) order */ List<E> findAll(); /** + * @return FIXME * @since 3.0 */ Iterable<E> findAllLazy(); /** + * @param entities FIXME + * @return FIXME * @since 3.0 */ Iterable<E> createAll(Iterable<E> entities); /** + * @param entities FIXME + * @return FIXME * @since 3.0 */ Iterable<E> updateAll(Iterable<E> entities); @@ -195,16 +202,23 @@ public interface TopiaDao<E extends TopiaEntity> extends Iterable<E> { /** * Creates a QueryBuilder without restriction * + * @return FIXME * @since 3.0 */ TopiaQueryBuilderAddCriteriaOrRunQueryStep<E> forAll(); /** + * @param properties FIXME + * @return FIXME * @since 3.0 */ TopiaQueryBuilderAddCriteriaOrRunQueryStep<E> forProperties(Map<String, Object> properties); /** + * @param propertyName FIXME + * @param propertyValue FIXME + * @param otherPropertyNamesAndValues FIXME + * @return FIXME * @since 3.0 */ TopiaQueryBuilderAddCriteriaOrRunQueryStep<E> forProperties(String propertyName, @@ -212,33 +226,45 @@ public interface TopiaDao<E extends TopiaEntity> extends Iterable<E> { Object... otherPropertyNamesAndValues); /** + * @return FIXME * @since 3.0 */ TopiaQueryBuilderAddCriteriaStep<E> newQueryBuilder(); /** + * @param propertyName FIXME + * @param propertyValue FIXME + * @return FIXME * @since 3.0 */ TopiaQueryBuilderRunQueryStep<E> forContains(String propertyName, Object propertyValue); /** + * @param propertyName FIXME + * @param propertyValue FIXME + * @return FIXME * @since 3.0 */ TopiaQueryBuilderRunQueryStep<E> forEquals(String propertyName, Object propertyValue); /** + * @param propertyName FIXME + * @param propertyValues FIXME + * @return FIXME * @since 3.0 */ TopiaQueryBuilderRunQueryStep<E> forIn(String propertyName, Collection<?> propertyValues); /** + * @param topiaId FIXME + * @return FIXME * @since 3.0 */ TopiaQueryBuilderRunQueryWithUniqueResultStep<E> forTopiaIdEquals(String topiaId); /** * Tries to find the entity with the given topiaId. If not found, an exception will be thrown. - * <p/> + * * IMPORTANT : The behavior of the method changes in ToPIA 3.0 because an exception is thrown if no entity found. * * @param topiaId the identifier of the entity to look for @@ -253,7 +279,7 @@ public interface TopiaDao<E extends TopiaEntity> extends Iterable<E> { /** * Tries to find the entity with the given topiaId. - * If not found, the result.isPresent() will be <code>false</code>. + * If not found, the result.isPresent() will be {@code false}. * * @param topiaId the identifier of the entity to look for * @return The entity found wrapped by an Optional @@ -263,6 +289,8 @@ public interface TopiaDao<E extends TopiaEntity> extends Iterable<E> { Optional<E> tryFindByTopiaId(String topiaId); /** + * @param topiaIds FIXME + * @return FIXME * @since 3.0 */ TopiaQueryBuilderRunQueryStep<E> forTopiaIdIn(Collection<String> topiaIds); diff --git a/topia-persistence/src/main/java/org/nuiton/topia/persistence/TopiaDaoSupplier.java b/topia-persistence/src/main/java/org/nuiton/topia/persistence/TopiaDaoSupplier.java index 5fe5304..0636952 100644 --- a/topia-persistence/src/main/java/org/nuiton/topia/persistence/TopiaDaoSupplier.java +++ b/topia-persistence/src/main/java/org/nuiton/topia/persistence/TopiaDaoSupplier.java @@ -36,6 +36,7 @@ public interface TopiaDaoSupplier { * Get Dao for specified class. If the specialized Dao exists then it is returned otherwise a TopiaException will * be thrown. * + * @param <E> type of entity * @param entityClass type of entity * @return the expected dao */ @@ -45,6 +46,8 @@ public interface TopiaDaoSupplier { * Get Dao for specified class. If the specialized Dao exists then it is returned otherwise a TopiaException will be * thrown. * + * @param <E> type of entity + * @param <D> type of dao * @param entityClass type of entity * @param daoClass the concrete dao class to use * @return the expected dao diff --git a/topia-persistence/src/main/java/org/nuiton/topia/persistence/TopiaEntities.java b/topia-persistence/src/main/java/org/nuiton/topia/persistence/TopiaEntities.java index 54cf720..1f8dc55 100644 --- a/topia-persistence/src/main/java/org/nuiton/topia/persistence/TopiaEntities.java +++ b/topia-persistence/src/main/java/org/nuiton/topia/persistence/TopiaEntities.java @@ -43,7 +43,8 @@ public class TopiaEntities { * Creates a Guava's {@link com.google.common.base.Predicate} which tests if a * {@link org.nuiton.topia.persistence.TopiaEntity} has the given {@code topiaId} * - * @param id the expected topiaId + * @param <E> type of entity + * @param id the expected topiaId * @return the created Predicate */ public static <E extends TopiaEntity> Predicate<E> entityHasId(String id) { @@ -75,10 +76,13 @@ public class TopiaEntities { /** * Function to obtain {@link org.nuiton.topia.persistence.TopiaEntity#getTopiaId()} from any entity. * + * @param <E> type of entity + * @return FIXME * @since 2.6.12 */ public static <E extends TopiaEntity> Function<E, String> getTopiaIdFunction() { return new Function<E, String>() { + @Override public String apply(TopiaEntity input) { return input == null ? null : input.getTopiaId(); diff --git a/topia-persistence/src/main/java/org/nuiton/topia/persistence/TopiaEntity.java b/topia-persistence/src/main/java/org/nuiton/topia/persistence/TopiaEntity.java index a6b070e..ef24b7a 100644 --- a/topia-persistence/src/main/java/org/nuiton/topia/persistence/TopiaEntity.java +++ b/topia-persistence/src/main/java/org/nuiton/topia/persistence/TopiaEntity.java @@ -28,15 +28,17 @@ import java.io.Serializable; import java.util.Date; /** + * <p> * The TopiaEntity is the main interface for each generated entity. - * <p/> + * </p> + * <p> * An entity is just a persistent bean mapped with Hibernate. The manipulation on entities (create, update, delete, * find) is made by the associated {@link org.nuiton.topia.persistence.TopiaDao}. - * <p/> + * </p> * Setter methods have to be used only in internal. They are in the interface to make easier their usages in internal. * - * @author poussin <poussin@codelutin.com> - * @author fdesbois <fdesbois@codelutin.com> + * @author Benjamin Poussin - poussin@codelutin.com + * @author Florian Desbois- fdebois@codelutin.com */ public interface TopiaEntity extends Serializable { diff --git a/topia-persistence/src/main/java/org/nuiton/topia/persistence/TopiaEntityContextable.java b/topia-persistence/src/main/java/org/nuiton/topia/persistence/TopiaEntityContextable.java index 912b06f..d574803 100644 --- a/topia-persistence/src/main/java/org/nuiton/topia/persistence/TopiaEntityContextable.java +++ b/topia-persistence/src/main/java/org/nuiton/topia/persistence/TopiaEntityContextable.java @@ -29,7 +29,7 @@ import java.util.List; /** * {@link TopiaEntity} with {@link TopiaDaoSupplier} support (injected by * {@link org.nuiton.topia.persistence.internal.AbstractTopiaDao} into entities). - * <p/> + * * WARNING, it is not recommended to use this mechanism as it breaks the POJO's Hibernate approach. * * @author chatellier diff --git a/topia-persistence/src/main/java/org/nuiton/topia/persistence/TopiaEntityEnum.java b/topia-persistence/src/main/java/org/nuiton/topia/persistence/TopiaEntityEnum.java index b9339ba..841cb8e 100644 --- a/topia-persistence/src/main/java/org/nuiton/topia/persistence/TopiaEntityEnum.java +++ b/topia-persistence/src/main/java/org/nuiton/topia/persistence/TopiaEntityEnum.java @@ -36,7 +36,7 @@ import java.io.Serializable; * implementation at runtime.</li> * <li>- a method to accept any TopiaEntity class for this entity description</li> * </ul> - * <p/> + * * For each entity of the model, a realisation of this contract is generated in an enum named XxxEntityEnum (where * Xxx is the name of your project). * @@ -107,7 +107,7 @@ public interface TopiaEntityEnum extends Serializable { /** * Change the implementation class of the entity. - * <p/> + * * Note : this method should reset all states of the object (implementation class, operators,...). * * @param implementationFQN the new fully qualified name of the new implementation class of the entity. @@ -116,16 +116,16 @@ public interface TopiaEntityEnum extends Serializable { /** * Test if a given type of entity is matching the contract of this entity. - * <p/> + * * Note : make sure to accept type only on the given contract class of this entity, can not accept an ancestor type, * since there is a specific contract for this. - * <p/> - * Example : A -> B + * + * Example : A → B * <pre> - * XxxEntityEnum.A.accept(Class<A>) -> true - * XxxEntityEnum.A.accept(Class<B>) -> false - * XxxEntityEnum.B.accept(Class<B>) -> true - * XxxEntityEnum.B.accept(Class<A>) -> false + * XxxEntityEnum.A.accept(Class<A>) → true + * XxxEntityEnum.A.accept(Class<B>) → false + * XxxEntityEnum.B.accept(Class<B>) → true + * XxxEntityEnum.B.accept(Class<A>) → false * </pre> * * @param klass the type of an entity to test. diff --git a/topia-persistence/src/main/java/org/nuiton/topia/persistence/TopiaEntityEnumProvider.java b/topia-persistence/src/main/java/org/nuiton/topia/persistence/TopiaEntityEnumProvider.java index 9f73520..165c593 100644 --- a/topia-persistence/src/main/java/org/nuiton/topia/persistence/TopiaEntityEnumProvider.java +++ b/topia-persistence/src/main/java/org/nuiton/topia/persistence/TopiaEntityEnumProvider.java @@ -26,7 +26,7 @@ package org.nuiton.topia.persistence; /** * Object which helps to wrap some static generated code (entityEnum). - * <p/> + * * This contract used to be named TopiaPersistenceHelper. * * @author Tony Chemit - chemit@codelutin.com @@ -38,7 +38,7 @@ public interface TopiaEntityEnumProvider<T extends TopiaEntityEnum> { * Method that returns the TopiaEntityEnum corresponding to the given entity's class. * * @param type the entity's class - * @param <E> works only for TopiaEntity, thus E must extend TopiaEntity + * @param <E> works only for TopiaEntity, thus E must extend TopiaEntity * @return the found TopiaEntityEnum. Should not be null. */ <E extends TopiaEntity> T getEntityEnum(Class<E> type); diff --git a/topia-persistence/src/main/java/org/nuiton/topia/persistence/TopiaEntityVisitor.java b/topia-persistence/src/main/java/org/nuiton/topia/persistence/TopiaEntityVisitor.java index b763c0a..1ad92fe 100644 --- a/topia-persistence/src/main/java/org/nuiton/topia/persistence/TopiaEntityVisitor.java +++ b/topia-persistence/src/main/java/org/nuiton/topia/persistence/TopiaEntityVisitor.java @@ -26,10 +26,10 @@ package org.nuiton.topia.persistence; /** * Visitor contract for any {@link TopiaEntity}. - * <p/> + * * Created: 28 janv. 2009 18:10:34 * - * @author bpoussin <poussin@codelutin.com> + * @author Benjamin Poussin - poussin@codelutin.com * @author Tony Chemit - chemit@codelutin.com */ public interface TopiaEntityVisitor { @@ -50,7 +50,7 @@ public interface TopiaEntityVisitor { /** * Visit a none indexed property for the given entity. - * <p/> + * * The property visited is defined by the other parameters. * * @param entity the visited entity @@ -65,7 +65,7 @@ public interface TopiaEntityVisitor { /** * Visit a collection property for the given entity. - * <p/> + * * The property visited is defined by the other parameters. * * @param entity the visited entity @@ -82,7 +82,7 @@ public interface TopiaEntityVisitor { /** * Visit a indexed value from a collection property for the given entity. - * <p/> + * * The property visited is defined by the other parameters. * * @param entity the visited entity @@ -101,10 +101,10 @@ public interface TopiaEntityVisitor { /** * Reset all states of the visitor. - * <p/> + * * If you use internal states inside the visitor, this method should clean * all of them. - * <p/> + * * This method should be invoked after usage of the visitor. */ void clear(); diff --git a/topia-persistence/src/main/java/org/nuiton/topia/persistence/TopiaException.java b/topia-persistence/src/main/java/org/nuiton/topia/persistence/TopiaException.java index 64967a3..b835185 100644 --- a/topia-persistence/src/main/java/org/nuiton/topia/persistence/TopiaException.java +++ b/topia-persistence/src/main/java/org/nuiton/topia/persistence/TopiaException.java @@ -26,12 +26,12 @@ package org.nuiton.topia.persistence; /** * Main exception for any ToPIA exception - * <p/> + * * Created: 23 déc. 2005 23:03:36 - * <p/> + * * Since version 3.0, this exception is now a RuntimeException has it represents only technical issues. * - * @author poussin <poussin@codelutin.com> + * @author Benjamin Poussin - poussin@codelutin.com */ public class TopiaException extends RuntimeException { diff --git a/topia-persistence/src/main/java/org/nuiton/topia/persistence/TopiaIdFactory.java b/topia-persistence/src/main/java/org/nuiton/topia/persistence/TopiaIdFactory.java index b601a85..6023395 100644 --- a/topia-persistence/src/main/java/org/nuiton/topia/persistence/TopiaIdFactory.java +++ b/topia-persistence/src/main/java/org/nuiton/topia/persistence/TopiaIdFactory.java @@ -28,7 +28,7 @@ import java.io.Serializable; /** * This contract represents a topiaId generation strategy. - * <p/> + * * It can be used in both ways : * <ul> * <li>generate a new topiaId from a given class;</li> @@ -40,9 +40,9 @@ import java.io.Serializable; * {@link java.io.Serializable} must be implemented because * {@link org.nuiton.topia.persistence.TopiaConfiguration} may hold some references. * + * @author Brendan Le Ny - bleny@codelutin.com + * @author Tony Chemit - tchemit@codelutin.com * @see org.nuiton.topia.persistence.TopiaConfiguration#getTopiaIdFactory() - * @author bleny <leny@codelutin.com/> - * @author tchemit <chemit@codelutin.com/> * @since 3.0 */ public interface TopiaIdFactory extends Serializable { @@ -61,7 +61,7 @@ public interface TopiaIdFactory extends Serializable { * Builds a new topiaId for the given entity type and the given random part. * * @param entityClass type of entity (must be a not null interface) - * @param randomPart the random part of the topiaId + * @param randomPart the random part of the topiaId * @param <E> type of entity * @return the new topiaId */ @@ -87,6 +87,7 @@ public interface TopiaIdFactory extends Serializable { String getSeparator(); /** + * @param str FIXME * @return true if given argument is a well formatted topiaId */ boolean isTopiaId(String str); diff --git a/topia-persistence/src/main/java/org/nuiton/topia/persistence/TopiaMigrationService.java b/topia-persistence/src/main/java/org/nuiton/topia/persistence/TopiaMigrationService.java index b8ca941..ace8617 100644 --- a/topia-persistence/src/main/java/org/nuiton/topia/persistence/TopiaMigrationService.java +++ b/topia-persistence/src/main/java/org/nuiton/topia/persistence/TopiaMigrationService.java @@ -34,7 +34,7 @@ package org.nuiton.topia.persistence; public interface TopiaMigrationService extends TopiaService { /** - * Get the schema version according to the meta-data information about + * @return the schema version according to the meta-data information about * the actual current state of the schema in the database. */ String getSchemaVersion() throws TopiaMigrationServiceException; diff --git a/topia-persistence/src/main/java/org/nuiton/topia/persistence/TopiaNotFoundException.java b/topia-persistence/src/main/java/org/nuiton/topia/persistence/TopiaNotFoundException.java index b608eeb..bfa548a 100644 --- a/topia-persistence/src/main/java/org/nuiton/topia/persistence/TopiaNotFoundException.java +++ b/topia-persistence/src/main/java/org/nuiton/topia/persistence/TopiaNotFoundException.java @@ -26,10 +26,10 @@ package org.nuiton.topia.persistence; /** * Exception thrown if one of the expected configuration entries is missing at runtime - * <p/> + * * Created: 23 déc. 2005 23:04:28 * - * @author poussin <poussin@codelutin.com> + * @author Benjamin Poussin - poussin@codelutin.com */ public class TopiaNotFoundException extends TopiaException { diff --git a/topia-persistence/src/main/java/org/nuiton/topia/persistence/TopiaPersistenceContext.java b/topia-persistence/src/main/java/org/nuiton/topia/persistence/TopiaPersistenceContext.java index 220d37f..8e1a9c6 100644 --- a/topia-persistence/src/main/java/org/nuiton/topia/persistence/TopiaPersistenceContext.java +++ b/topia-persistence/src/main/java/org/nuiton/topia/persistence/TopiaPersistenceContext.java @@ -32,22 +32,21 @@ import java.io.Closeable; /** * This contract represents a persistence context, which lifecycle is linked to the transaction lifecycle. * - * <p>It extends contracts such as : + * <p>It extends contracts such as :</p> * <ul> - * <li>{@link org.nuiton.topia.persistence.TopiaTransaction} - to deal with transaction lifecycle</li> - * <li>{@link org.nuiton.topia.persistence.TopiaDaoSupplier} - to let user get any Dao instance</li> - * <li>{@link org.nuiton.topia.persistence.support.TopiaReplicationSupport} - to use context to context replication - * facility</li> - * <li>{@link org.nuiton.topia.persistence.TopiaReplicationDestination} - can receive replicated entities</li> - * </ul></p> + * <li>{@link org.nuiton.topia.persistence.TopiaTransaction} - to deal with transaction lifecycle</li> + * <li>{@link org.nuiton.topia.persistence.TopiaDaoSupplier} - to let user get any Dao instance</li> + * <li>{@link org.nuiton.topia.persistence.support.TopiaReplicationSupport} - to use context to context replication + * facility</li> + * <li>{@link org.nuiton.topia.persistence.TopiaReplicationDestination} - can receive replicated entities</li> + * </ul> * - * <p>In addition to these contracts, there is some other methods : + * <p>In addition to these contracts, there is some other methods :</p> * <ul> - * <li>Generic entity find</li> - * <li>DAO factory</li> - * <li>Schema management</li> + * <li>Generic entity find</li> + * <li>DAO factory</li> + * <li>Schema management</li> * </ul> - * </p> * * @author Arnaud Thimel (Code Lutin) * @since 3.0 @@ -59,6 +58,7 @@ public interface TopiaPersistenceContext extends TopiaReplicationSupport, TopiaR * Retrieve {@link org.nuiton.topia.persistence.TopiaEntity} using its unique {@code topiaId}. * * @param topiaId unique identifier of the entity in all the application. + * @param <E> type of entity * @return the entity found or null */ <E extends TopiaEntity> E findByTopiaId(String topiaId); @@ -81,6 +81,7 @@ public interface TopiaPersistenceContext extends TopiaReplicationSupport, TopiaR * Delete into this TopiaContext an entities created by another TopiaContext * * @param entities the entities to delete + * @param <E> type of entity */ <E extends TopiaEntity> void deleteAll(Iterable<E> entities); diff --git a/topia-persistence/src/main/java/org/nuiton/topia/persistence/TopiaQueryBuilderAddCriteriaStep.java b/topia-persistence/src/main/java/org/nuiton/topia/persistence/TopiaQueryBuilderAddCriteriaStep.java index af4c045..f521f6d 100644 --- a/topia-persistence/src/main/java/org/nuiton/topia/persistence/TopiaQueryBuilderAddCriteriaStep.java +++ b/topia-persistence/src/main/java/org/nuiton/topia/persistence/TopiaQueryBuilderAddCriteriaStep.java @@ -31,7 +31,7 @@ import java.util.LinkedHashSet; /** * Represents a step when building a query to add a constraint. - * <p/> + * * The builder implements the fluent interface DP, so you can add multiple constraints by chaining calls. * * @author bleny diff --git a/topia-persistence/src/main/java/org/nuiton/topia/persistence/TopiaQueryBuilderRunQueryStep.java b/topia-persistence/src/main/java/org/nuiton/topia/persistence/TopiaQueryBuilderRunQueryStep.java index 2e48c2f..26aef9c 100644 --- a/topia-persistence/src/main/java/org/nuiton/topia/persistence/TopiaQueryBuilderRunQueryStep.java +++ b/topia-persistence/src/main/java/org/nuiton/topia/persistence/TopiaQueryBuilderRunQueryStep.java @@ -33,10 +33,10 @@ import java.util.List; /** * This interface represents different common operations that a user may do after a query is defined (using the * {@link org.nuiton.topia.persistence.TopiaQueryBuilderAddCriteriaStep}) - * <p/> + * * There are different methods according to the supposed existence or uniqueness of the result. Also some methods may be * used only if order is defined in query. - * <p/> + * * Some methods return an {@link Optional}, but since it's not yet available in JDK, we use Guava's. If you don't want * your project to require Guava dependency, we provide equivalent method named XXXOrNull() for the same purpose. * @@ -66,7 +66,7 @@ public interface TopiaQueryBuilderRunQueryStep<E extends TopiaEntity> /** * Get the first element of the result set or null if query result is empty. - * <p/> + * * This method duplicates {@link #tryFindFirst()} but allows you to prevent using Guava in you project. * * @return the first value from the set of result, according to given order, or null of result set for given query @@ -77,7 +77,7 @@ public interface TopiaQueryBuilderRunQueryStep<E extends TopiaEntity> /** * Get the first element of the result set. - * <p/> + * * If the call must return a result, prefer {@link #findFirst()} * * @return the first value from the set of result, according to given order. It's an optional because the query may @@ -88,7 +88,7 @@ public interface TopiaQueryBuilderRunQueryStep<E extends TopiaEntity> /** * Get the an element of the non-empty result set. - * <p/> + * * This method does not guarantee any order as no ordering clause is mandatory * * @return the first value from the set of result, without any order guarantee. Returned value can't be null @@ -98,9 +98,9 @@ public interface TopiaQueryBuilderRunQueryStep<E extends TopiaEntity> /** * Get the an element of the result set or null if query result is empty. - * <p/> + * * This method does not guarantee any order as no ordering clause is mandatory. - * <p/> + * * This method duplicates {@link #tryFindAny()} but allows you to prevent using Guava in you project. * * @return the first value from the set of result, without any order guarantee. Returned value can be null @@ -109,9 +109,9 @@ public interface TopiaQueryBuilderRunQueryStep<E extends TopiaEntity> /** * Get the an element of the result set. - * <p/> + * * This method does not guarantee any order as no ordering clause is mandatory. - * <p/> + * * If the call must return a result, prefer {@link #findAny()} * * @return the first value from the set of result, without any order guarantee. It's an optional because the query @@ -129,7 +129,7 @@ public interface TopiaQueryBuilderRunQueryStep<E extends TopiaEntity> /** * Get all the elements in a lazy loading list. The entities will be loaded gradually when the returned Iterable is * iterated. - * <p/> + * * If you wish to specify a batch size, use {@link #findAllLazy(int)} * * @return the full list of results which will be loaded gradually. @@ -139,7 +139,7 @@ public interface TopiaQueryBuilderRunQueryStep<E extends TopiaEntity> /** * Get all the elements in a lazy loading list. The entities will be loaded gradually when the returned Iterable is * iterated. - * <p/> + * * If you do not need to specify a batch size, use {@link #findAllLazy()} * * @param batchSize the number of elements to load per request @@ -158,7 +158,7 @@ public interface TopiaQueryBuilderRunQueryStep<E extends TopiaEntity> /** * Get the elements according to the given {@link PaginationParameter}. - * <p/> + * * Use {@link #findPage(PaginationParameter)} to get a {@link PaginationResult} instead of a list. * * @param page information about the page to load. @@ -169,9 +169,9 @@ public interface TopiaQueryBuilderRunQueryStep<E extends TopiaEntity> /** * Get the elements according to the given {@link PaginationParameter}. - * <p/> + * * Use {@link #find(PaginationParameter)} to get a list instead of {@link PaginationResult}. - * <p/> + * * Note: compared to {@link #find(PaginationParameter)}, this method performs an additional statement to get the * total elements count. * @@ -184,7 +184,7 @@ public interface TopiaQueryBuilderRunQueryStep<E extends TopiaEntity> /** * Get all the elements identifiers of the result set. - * <p/> + * * Note: compared to {@link #findAll()}, this method will not load entities, only its identifier. * * @return the full list of results ids. @@ -193,7 +193,7 @@ public interface TopiaQueryBuilderRunQueryStep<E extends TopiaEntity> /** * Get the elements identifiers with the given bounds. - * <p/> + * * Note: compared to {@link #find(int, int)}, this method will not load entities, only its identifier. * * @param startIndex inclusive index of the first element to return. This value is 0-based @@ -204,9 +204,9 @@ public interface TopiaQueryBuilderRunQueryStep<E extends TopiaEntity> /** * Get the elements identifiers according to the given {@link PaginationParameter}. - * <p/> + * * Use {@link #findIdsPage(PaginationParameter)} to get a {@link PaginationResult} instead of a list. - * <p/> + * * Note: compared to {@link #find(PaginationParameter)}, this method will not load entities, only its identifier. * * @param page information about the page to load. @@ -217,12 +217,12 @@ public interface TopiaQueryBuilderRunQueryStep<E extends TopiaEntity> /** * Get the elements identifiers according to the given {@link PaginationParameter}. - * <p/> + * * Use {@link #findIds(PaginationParameter)} to get a list instead of {@link PaginationResult}. - * <p/> + * * Note: compared to {@link #findIds(PaginationParameter)}, this method performs an additional statement to get the * total elements identifiers count. - * <p/> + * * Note: compared to {@link #findPage(PaginationParameter)}, this method will not load entities, only its identifier * * @param page information about the page to load. diff --git a/topia-persistence/src/main/java/org/nuiton/topia/persistence/TopiaQueryBuilderRunQueryWithUniqueResultStep.java b/topia-persistence/src/main/java/org/nuiton/topia/persistence/TopiaQueryBuilderRunQueryWithUniqueResultStep.java index 8a31d85..2967d83 100644 --- a/topia-persistence/src/main/java/org/nuiton/topia/persistence/TopiaQueryBuilderRunQueryWithUniqueResultStep.java +++ b/topia-persistence/src/main/java/org/nuiton/topia/persistence/TopiaQueryBuilderRunQueryWithUniqueResultStep.java @@ -50,7 +50,7 @@ public interface TopiaQueryBuilderRunQueryWithUniqueResultStep<E extends TopiaEn /** * Get the first element of a single-element result set or null if query result is empty. - * <p/> + * * This method duplicates {@link #tryFindUnique()} but allows you to prevent using Guava in you project. * * @return the first value from the set of result, or null of result set for given query is empty. @@ -60,7 +60,7 @@ public interface TopiaQueryBuilderRunQueryWithUniqueResultStep<E extends TopiaEn /** * Get the first element of a single-element result set. - * <p/> + * * If the call must return a result, prefer {@link #findUnique()} * * @return the first value from the set of result. It's an optional because the query may return no result. diff --git a/topia-persistence/src/main/java/org/nuiton/topia/persistence/TopiaQueryException.java b/topia-persistence/src/main/java/org/nuiton/topia/persistence/TopiaQueryException.java index 72672ed..0fd7fe2 100644 --- a/topia-persistence/src/main/java/org/nuiton/topia/persistence/TopiaQueryException.java +++ b/topia-persistence/src/main/java/org/nuiton/topia/persistence/TopiaQueryException.java @@ -29,7 +29,7 @@ import java.util.Map; /** * Exception raised when an error occur in the context of a particular query. Catching this exception class allow you * to get the buggy request and its parameters. - * <p/> + * * When catching such an exception you may ease development by logging all the provided information given by * {@link #getHql()} and {@link #getHqlParameters()} but it's considered dangerous since parameters can contain sensible * data (such as passwords) that should not be printed anywhere. diff --git a/topia-persistence/src/main/java/org/nuiton/topia/persistence/TopiaTransaction.java b/topia-persistence/src/main/java/org/nuiton/topia/persistence/TopiaTransaction.java index ab525af..23fcbfe 100644 --- a/topia-persistence/src/main/java/org/nuiton/topia/persistence/TopiaTransaction.java +++ b/topia-persistence/src/main/java/org/nuiton/topia/persistence/TopiaTransaction.java @@ -34,7 +34,7 @@ public interface TopiaTransaction { /** * Applies all the modifications made to this context on the persistence device. - * <p/> + * * Once commit is done, a new internal transaction is started, but you do not have to get a new instance of * {@link TopiaTransaction}. */ @@ -44,7 +44,7 @@ public interface TopiaTransaction { * Cancels all the modifications made to this context, coming back to the state when this transaction has been * created (using {@link TopiaApplicationContext#newPersistenceContext()}) or previously rollbacked (using the * current method). - * <p/> + * * Once rollback is done, a new internal transaction is started, but you do not have to get a new instance of * {@link TopiaTransaction}. */ diff --git a/topia-persistence/src/main/java/org/nuiton/topia/persistence/TopiaTransactionAware.java b/topia-persistence/src/main/java/org/nuiton/topia/persistence/TopiaTransactionAware.java index fe4ce0a..6756566 100644 --- a/topia-persistence/src/main/java/org/nuiton/topia/persistence/TopiaTransactionAware.java +++ b/topia-persistence/src/main/java/org/nuiton/topia/persistence/TopiaTransactionAware.java @@ -27,9 +27,9 @@ package org.nuiton.topia.persistence; /** * Use this contract on a object which use a {@code TopiaContext} as a * transaction. - * <p/> + * * The method {@link #getTransaction()} returns the internal transaction used. - * <p/> + * * the method {@link #setTransaction(TopiaTransaction)} put the internal * transaction. * @@ -41,7 +41,7 @@ public interface TopiaTransactionAware { /** * Obtains the internal transaction. - * <p/> + * * If no transaction was opened, can return the {@code null} object. * * @return the current transaction (can be null or closed...). diff --git a/topia-persistence/src/main/java/org/nuiton/topia/persistence/TopiaVetoException.java b/topia-persistence/src/main/java/org/nuiton/topia/persistence/TopiaVetoException.java index c8779d5..b2fd195 100644 --- a/topia-persistence/src/main/java/org/nuiton/topia/persistence/TopiaVetoException.java +++ b/topia-persistence/src/main/java/org/nuiton/topia/persistence/TopiaVetoException.java @@ -26,10 +26,10 @@ package org.nuiton.topia.persistence; /** * Exception thrown when something went wrong during event firing - * <p/> + * * Created: 5 janv. 2006 00:47:51 * - * @author poussin <poussin@codelutin.com> + * @author Benjamin Poussin - poussin@codelutin.com */ public class TopiaVetoException extends TopiaException { diff --git a/topia-persistence/src/main/java/org/nuiton/topia/persistence/event/EntityState.java b/topia-persistence/src/main/java/org/nuiton/topia/persistence/event/EntityState.java index 08f3487..ce00e4a 100644 --- a/topia-persistence/src/main/java/org/nuiton/topia/persistence/event/EntityState.java +++ b/topia-persistence/src/main/java/org/nuiton/topia/persistence/event/EntityState.java @@ -27,7 +27,7 @@ package org.nuiton.topia.persistence.event; /** * Used to know the state of an entity during transaction. * - * @author poussin <poussin@codelutin.com> + * @author Benjamin Poussin - poussin@codelutin.com * @author Arnaud Thimel (Code Lutin) */ public class EntityState implements Comparable<EntityState> { @@ -53,7 +53,7 @@ public class EntityState implements Comparable<EntityState> { /** * Add loaded state. - * <p/> + * * After the invocation, method {@link #isLoaded()} will always return {@code true}. */ public void addLoaded() { @@ -62,7 +62,7 @@ public class EntityState implements Comparable<EntityState> { /** * Add read state - * <p/> + * * After the invocation, method {@link #isRead()} will always return {@code true}. */ public void addRead() { @@ -71,7 +71,7 @@ public class EntityState implements Comparable<EntityState> { /** * Add created state. - * <p/> + * * After the invocation, method {@link #isCreated()} will always return {@code true}. */ public void addCreated() { @@ -80,7 +80,7 @@ public class EntityState implements Comparable<EntityState> { /** * Add updated state. - * <p/> + * * After the invocation, method {@link #isUpdated()} will always return {@code true}. */ public void addUpdated() { @@ -89,7 +89,7 @@ public class EntityState implements Comparable<EntityState> { /** * Add written state. - * <p/> + * * After the invocation, method {@link #isWritten()} will always return {@code true}. */ public void addWritten() { @@ -98,7 +98,7 @@ public class EntityState implements Comparable<EntityState> { /** * Add deleted state. - * <p/> + * * After the invocation, method {@link #isDeleted()} will always return {@code true}. */ public void addDeleted() { diff --git a/topia-persistence/src/main/java/org/nuiton/topia/persistence/event/ListenableBean.java b/topia-persistence/src/main/java/org/nuiton/topia/persistence/event/ListenableBean.java index 16947f3..e4df306 100644 --- a/topia-persistence/src/main/java/org/nuiton/topia/persistence/event/ListenableBean.java +++ b/topia-persistence/src/main/java/org/nuiton/topia/persistence/event/ListenableBean.java @@ -27,7 +27,7 @@ import java.beans.PropertyChangeListener; /** * Contract to centralize usable methods to register/unregister PropertyChangeListener. This contract respects the * java beans expectations. - * <p/> + * * If you do not need to match the java beans expectations, prefer using * {@link org.nuiton.topia.persistence.event.ListenableTopiaEntity}. * @@ -42,7 +42,7 @@ public interface ListenableBean { /** * Adds a {@link java.beans.PropertyChangeListener} on any property writing. - * <p/> + * * This method does the same than {@link ListenableTopiaEntity#addPostWriteListener(java.beans.PropertyChangeListener)} * and respects the java beans expectations. * @@ -54,7 +54,7 @@ public interface ListenableBean { /** * Adds a {@link java.beans.PropertyChangeListener} on the given property writing. - * <p/> + * * This method does the same than {@link ListenableTopiaEntity#addPostWriteListener(String, java.beans.PropertyChangeListener)} * and respects the java beans expectations. * @@ -67,7 +67,7 @@ public interface ListenableBean { /** * Remove the given {@link java.beans.PropertyChangeListener} registered for any property writing. - * <p/> + * * This method does the same than {@link ListenableTopiaEntity#removePostWriteListener(java.beans.PropertyChangeListener)} * and respects the java beans expectations. * @@ -79,7 +79,7 @@ public interface ListenableBean { /** * Remove the given {@link java.beans.PropertyChangeListener} registered the given property writing. - * <p/> + * * This method does the same than {@link ListenableTopiaEntity#removePostWriteListener(String, java.beans.PropertyChangeListener)} * and respects the java beans expectations. * diff --git a/topia-persistence/src/main/java/org/nuiton/topia/persistence/event/ListenableTopiaEntity.java b/topia-persistence/src/main/java/org/nuiton/topia/persistence/event/ListenableTopiaEntity.java index 5738b9f..501246c 100644 --- a/topia-persistence/src/main/java/org/nuiton/topia/persistence/event/ListenableTopiaEntity.java +++ b/topia-persistence/src/main/java/org/nuiton/topia/persistence/event/ListenableTopiaEntity.java @@ -27,7 +27,7 @@ import java.beans.VetoableChangeListener; /** * Contract to centralize usable methods to register/unregister pre/post read/write listeners. - * <p/> + * * If you need to match the java beans expectations, prefer using * {@link org.nuiton.topia.persistence.event.ListenableBean}. * diff --git a/topia-persistence/src/main/java/org/nuiton/topia/persistence/event/TopiaContextAdapter.java b/topia-persistence/src/main/java/org/nuiton/topia/persistence/event/TopiaContextAdapter.java index 6f56342..4a79b41 100644 --- a/topia-persistence/src/main/java/org/nuiton/topia/persistence/event/TopiaContextAdapter.java +++ b/topia-persistence/src/main/java/org/nuiton/topia/persistence/event/TopiaContextAdapter.java @@ -26,7 +26,7 @@ package org.nuiton.topia.persistence.event; /** * Adapter pattern of {@link TopiaSchemaListener}. - * <p/> + * * This implementation does nothing but permits developpers to use this adapater * without to have to implements all methods. * diff --git a/topia-persistence/src/main/java/org/nuiton/topia/persistence/event/TopiaContextEvent.java b/topia-persistence/src/main/java/org/nuiton/topia/persistence/event/TopiaContextEvent.java index 8db1534..24f73e8 100644 --- a/topia-persistence/src/main/java/org/nuiton/topia/persistence/event/TopiaContextEvent.java +++ b/topia-persistence/src/main/java/org/nuiton/topia/persistence/event/TopiaContextEvent.java @@ -24,16 +24,15 @@ package org.nuiton.topia.persistence.event; * #L% */ -import java.util.EventObject; - import org.nuiton.topia.persistence.TopiaApplicationContext; -import org.nuiton.topia.persistence.TopiaPersistenceContext; + +import java.util.EventObject; /** * TODO-fdesbois-20100507 : Need javadoc. * Used for Migration service. * - * @author chatellier <chatellier@codelutin.com> + * @author Éric Chatellier - chatellier@codelutin.com */ public class TopiaContextEvent extends EventObject { @@ -43,7 +42,7 @@ public class TopiaContextEvent extends EventObject { /** * Constructor * - * @param source + * @param source FIXME */ public TopiaContextEvent(TopiaApplicationContext source) { super(source); diff --git a/topia-persistence/src/main/java/org/nuiton/topia/persistence/event/TopiaEntitiesEvent.java b/topia-persistence/src/main/java/org/nuiton/topia/persistence/event/TopiaEntitiesEvent.java index 0846d70..9372a71 100644 --- a/topia-persistence/src/main/java/org/nuiton/topia/persistence/event/TopiaEntitiesEvent.java +++ b/topia-persistence/src/main/java/org/nuiton/topia/persistence/event/TopiaEntitiesEvent.java @@ -33,7 +33,7 @@ import java.util.List; /** * TODO-fdesbois-20100507 : Need javadoc. * - * @author jruchaud <jruchaud@codelutin.com> + * @author Julien Ruchaud - jruchaud@codelutin.com */ public class TopiaEntitiesEvent<E extends TopiaEntity> extends EventObject { diff --git a/topia-persistence/src/main/java/org/nuiton/topia/persistence/event/TopiaEntitiesVetoable.java b/topia-persistence/src/main/java/org/nuiton/topia/persistence/event/TopiaEntitiesVetoable.java index 086b1c2..49d8236 100644 --- a/topia-persistence/src/main/java/org/nuiton/topia/persistence/event/TopiaEntitiesVetoable.java +++ b/topia-persistence/src/main/java/org/nuiton/topia/persistence/event/TopiaEntitiesVetoable.java @@ -32,7 +32,7 @@ import java.util.List; /** * Permet de lancer des événements liés au récupération des données * - * @author jruchaud <jruchaud@codelutin.com> + * @author Julien Ruchaud - jruchaud@codelutin.com */ public interface TopiaEntitiesVetoable extends EventListener { diff --git a/topia-persistence/src/main/java/org/nuiton/topia/persistence/event/TopiaEntityEvent.java b/topia-persistence/src/main/java/org/nuiton/topia/persistence/event/TopiaEntityEvent.java index 17a1b14..c08e1a8 100644 --- a/topia-persistence/src/main/java/org/nuiton/topia/persistence/event/TopiaEntityEvent.java +++ b/topia-persistence/src/main/java/org/nuiton/topia/persistence/event/TopiaEntityEvent.java @@ -33,7 +33,7 @@ import java.util.EventObject; /** * TODO-fdesbois-20100507 : Need javadoc. * - * @author jruchaud <jruchaud@codelutin.com> + * @author Julien Ruchaud - jruchaud@codelutin.com */ public class TopiaEntityEvent extends EventObject { diff --git a/topia-persistence/src/main/java/org/nuiton/topia/persistence/event/TopiaEntityListener.java b/topia-persistence/src/main/java/org/nuiton/topia/persistence/event/TopiaEntityListener.java index 5de892a..a60ef01 100644 --- a/topia-persistence/src/main/java/org/nuiton/topia/persistence/event/TopiaEntityListener.java +++ b/topia-persistence/src/main/java/org/nuiton/topia/persistence/event/TopiaEntityListener.java @@ -29,8 +29,8 @@ import java.util.EventListener; /** * TODO-fdesbois-20100507 : Need javadoc. * - * @author poussin <poussin@codelutin.com> - * @author tchemit <tchemit@codelutin.com> + * @author Benjamin Poussin - poussin@codelutin.com + * @author Tony Chemit - tchemit@codelutin.com */ public interface TopiaEntityListener extends EventListener { diff --git a/topia-persistence/src/main/java/org/nuiton/topia/persistence/event/TopiaEntityVetoable.java b/topia-persistence/src/main/java/org/nuiton/topia/persistence/event/TopiaEntityVetoable.java index f253d02..b3aa319 100644 --- a/topia-persistence/src/main/java/org/nuiton/topia/persistence/event/TopiaEntityVetoable.java +++ b/topia-persistence/src/main/java/org/nuiton/topia/persistence/event/TopiaEntityVetoable.java @@ -29,8 +29,8 @@ import java.util.EventListener; /** * TODO-fdesbois-20100507 : Need javadoc. * - * @author jruchaud <jruchaud@codelutin.com> - * @author tchemit <tchemit@codelutin.com> + * @author Julien Ruchaud - jruchaud@codelutin.com + * @author Tony Chemit - tchemit@codelutin.com */ public interface TopiaEntityVetoable extends EventListener { diff --git a/topia-persistence/src/main/java/org/nuiton/topia/persistence/event/TopiaSchemaListener.java b/topia-persistence/src/main/java/org/nuiton/topia/persistence/event/TopiaSchemaListener.java index 6c1f3e0..d5aafcb 100644 --- a/topia-persistence/src/main/java/org/nuiton/topia/persistence/event/TopiaSchemaListener.java +++ b/topia-persistence/src/main/java/org/nuiton/topia/persistence/event/TopiaSchemaListener.java @@ -28,7 +28,7 @@ import java.util.EventListener; /** * Listener for TopiaContext actions. - * <p/> + * * Listener are notified for action such as : * <ul> * <li>createSchema</li> diff --git a/topia-persistence/src/main/java/org/nuiton/topia/persistence/event/TopiaTransactionEvent.java b/topia-persistence/src/main/java/org/nuiton/topia/persistence/event/TopiaTransactionEvent.java index 3dac71a..195e59b 100644 --- a/topia-persistence/src/main/java/org/nuiton/topia/persistence/event/TopiaTransactionEvent.java +++ b/topia-persistence/src/main/java/org/nuiton/topia/persistence/event/TopiaTransactionEvent.java @@ -35,7 +35,7 @@ import java.util.Set; /** * Event fires for {@link org.nuiton.topia.persistence.event.TopiaTransactionListener}. * - * @author poussin <poussin@codelutin.com> + * @author Benjamin Poussin - poussin@codelutin.com * @see org.nuiton.topia.persistence.event.TopiaTransactionListener */ public class TopiaTransactionEvent extends EventObject { diff --git a/topia-persistence/src/main/java/org/nuiton/topia/persistence/event/TopiaTransactionListener.java b/topia-persistence/src/main/java/org/nuiton/topia/persistence/event/TopiaTransactionListener.java index 2840c2a..6914d10 100644 --- a/topia-persistence/src/main/java/org/nuiton/topia/persistence/event/TopiaTransactionListener.java +++ b/topia-persistence/src/main/java/org/nuiton/topia/persistence/event/TopiaTransactionListener.java @@ -30,16 +30,16 @@ import java.util.EventListener; /** * To listen transaction operations such as commit and rollback. - * <p/> + * * <b>Warning:</b> Must be attached to the current transaction. - * <p/> + * * {@link org.nuiton.topia.persistence.support.TopiaListenableSupport} listens such listeners via javaBeans methods : * <ul> * <li>{@link org.nuiton.topia.persistence.support.TopiaListenableSupport#addTopiaTransactionListener(TopiaTransactionListener)}</li> * <li>{@link org.nuiton.topia.persistence.support.TopiaListenableSupport#removeTopiaTransactionListener(TopiaTransactionListener)}</li> * </ul> * - * @author poussin <poussin@codelutin.com> + * @author Benjamin Poussin - poussin@codelutin.com * @see org.nuiton.topia.persistence.support.TopiaListenableSupport * @see org.nuiton.topia.persistence.event.TopiaTransactionEvent * @see TopiaFiresSupport#fireOnPostCommit(org.nuiton.topia.persistence.TopiaPersistenceContext) @@ -49,7 +49,7 @@ public interface TopiaTransactionListener extends EventListener { /** * Fired by {@link TopiaFiresSupport#fireOnPostCommit(org.nuiton.topia.persistence.TopiaPersistenceContext)}. - * <p/> + * * Says after a commit was performed on listened transaction. * * @param event the transaction event @@ -58,7 +58,7 @@ public interface TopiaTransactionListener extends EventListener { /** * Fired by {@link TopiaFiresSupport#fireOnPostRollback(org.nuiton.topia.persistence.TopiaPersistenceContext)}. - * <p/> + * * Says after a rollback was performed on listened transaction. * * @param event the transaction event diff --git a/topia-persistence/src/main/java/org/nuiton/topia/persistence/event/TopiaTransactionVetoable.java b/topia-persistence/src/main/java/org/nuiton/topia/persistence/event/TopiaTransactionVetoable.java index ebba6cb..fe9e5ac 100644 --- a/topia-persistence/src/main/java/org/nuiton/topia/persistence/event/TopiaTransactionVetoable.java +++ b/topia-persistence/src/main/java/org/nuiton/topia/persistence/event/TopiaTransactionVetoable.java @@ -29,8 +29,8 @@ import java.util.EventListener; /** * TODO-fdesbois-20100507 : Need javadoc. * - * @author jruchaud <jruchaud@codelutin.com> - * @author tchemit <tchemit@codelutin.com> + * @author Julien Ruchaud - jruchaud@codelutin.com + * @author Tony Chemit - tchemit@codelutin.com */ public interface TopiaTransactionVetoable extends EventListener { diff --git a/topia-persistence/src/main/java/org/nuiton/topia/persistence/internal/AbstractTopiaApplicationContext.java b/topia-persistence/src/main/java/org/nuiton/topia/persistence/internal/AbstractTopiaApplicationContext.java index 2b938ac..09e9efb 100644 --- a/topia-persistence/src/main/java/org/nuiton/topia/persistence/internal/AbstractTopiaApplicationContext.java +++ b/topia-persistence/src/main/java/org/nuiton/topia/persistence/internal/AbstractTopiaApplicationContext.java @@ -97,6 +97,7 @@ public abstract class AbstractTopiaApplicationContext<K extends TopiaPersistence new WeakHashMap<TopiaPersistenceContext, Boolean>()); /** + * @param properties FIXME * @deprecated use {@link #AbstractTopiaApplicationContext(org.nuiton.topia.persistence.TopiaConfiguration)} */ @Deprecated @@ -105,6 +106,7 @@ public abstract class AbstractTopiaApplicationContext<K extends TopiaPersistence } /** + * @param map FIXME * @deprecated use {@link #AbstractTopiaApplicationContext(org.nuiton.topia.persistence.TopiaConfiguration)} */ @Deprecated @@ -156,7 +158,8 @@ public abstract class AbstractTopiaApplicationContext<K extends TopiaPersistence * * This simple check is in its own method so it can be overridden. * - * @see {@link org.nuiton.topia.persistence.TopiaConfiguration#isInitSchema()} + * @see org.nuiton.topia.persistence.TopiaConfiguration#isInitSchema() + * @return FIXME */ protected boolean isInitSchema() { boolean initSchema = configuration.isInitSchema(); diff --git a/topia-persistence/src/main/java/org/nuiton/topia/persistence/internal/AbstractTopiaDao.java b/topia-persistence/src/main/java/org/nuiton/topia/persistence/internal/AbstractTopiaDao.java index 4071931..a39c023 100644 --- a/topia-persistence/src/main/java/org/nuiton/topia/persistence/internal/AbstractTopiaDao.java +++ b/topia-persistence/src/main/java/org/nuiton/topia/persistence/internal/AbstractTopiaDao.java @@ -33,7 +33,6 @@ import com.google.common.collect.Iterables; import com.google.common.collect.Iterators; import com.google.common.collect.Lists; import com.google.common.collect.Maps; - import org.apache.commons.beanutils.PropertyUtils; import org.apache.commons.collections4.CollectionUtils; import org.apache.commons.lang3.StringUtils; @@ -75,21 +74,22 @@ import java.util.LinkedHashSet; import java.util.List; import java.util.Map; import java.util.NoSuchElementException; -import java.util.Set; /** + * <p> * This class has the common methods usable for each Dao managed by Topia. It is not JPA implementation dependent, it * only relies on {@link TopiaJpaSupport}. - * <p/> + * </p> + * <p> * This class is directly extended by the GeneratedXyzTopiaDao which groups all the Xyz specific methods. - * <p/> + * </p> * Instances are created bt the model's specific {@link TopiaPersistenceContext}, which implements the * {@link TopiaDaoSupplier} contract. * * @param <E> the managed entity type - * @author bpoussin <poussin@codelutin.com> + * @author Benjamin Poussin - poussin@codelutin.com * @author Arnaud Thimel (Code Lutin) - * @author Tony CHEMIT <chemit@codelutin.com> + * @author Tony Chemit - tchemit@codelutin.com */ public abstract class AbstractTopiaDao<E extends TopiaEntity> implements TopiaDao<E> { @@ -97,6 +97,7 @@ public abstract class AbstractTopiaDao<E extends TopiaEntity> implements TopiaDa protected static final Function<PaginationOrder, String> PAGINATION_ORDER_TO_HQL = new Function<PaginationOrder, String>() { + @Override public String apply(PaginationOrder input) { String result = String.format("%s %s", input.getClause(), input.isDesc() ? "DESC" : "ASC"); @@ -130,6 +131,13 @@ public abstract class AbstractTopiaDao<E extends TopiaEntity> implements TopiaDa /** * When AbstractTopiaContext create the TopiaDAOHibernate, it must call this * method just after. + * + * @param topiaJpaSupport FIXME + * @param topiaHibernateSupport FIXME + * @param topiaSqlSupport FIXME + * @param topiaIdFactory FIXME + * @param topiaFiresSupport FIXME + * @param topiaDaoSupplier FIXME */ public void init( TopiaJpaSupport topiaJpaSupport, @@ -220,18 +228,18 @@ public abstract class AbstractTopiaDao<E extends TopiaEntity> implements TopiaDa int selectIndex = hql.toLowerCase().indexOf("select"); int fromIndex = hql.toLowerCase().indexOf("from"); - // A: select * from ... -> select count(*) from ... - // B: select a from ... -> select count(*) from ... - // C: select a,b from ... -> select count(*) from ... - // D: select distinct a from ... -> select count(distinct a) from ... + // A: select * from ... → select count(*) from ... + // B: select a from ... → select count(*) from ... + // C: select a,b from ... → select count(*) from ... + // D: select distinct a from ... → select count(distinct a) from ... // Here is a fix for case D String selectCondition = hql.toLowerCase().substring(selectIndex + "select".length(), fromIndex); if (selectCondition.contains("distinct")) { // AThimel 18/07/14 Hibernate does not support "select count(distinct(name))", need to use "select count(distinct name)" Preconditions.checkState(!selectCondition.replaceAll(" ", "").toLowerCase().contains("distinct("), - "This method needs to run count(...), but Hibernate does not support " + - "\"select count(distinct(name))\", please use \"select distinct name\" (without brackets)"); + "This method needs to run count(...), but Hibernate does not support " + + "\"select count(distinct(name))\", please use \"select distinct name\" (without brackets)"); countCondition = selectCondition; } @@ -405,8 +413,8 @@ public abstract class AbstractTopiaDao<E extends TopiaEntity> implements TopiaDa } protected InnerTopiaQueryBuilderRunQueryStep<E> forHql(String hql, String parameterName, - Object parameterValue, - Object... otherParameterNamesAndValues) { + Object parameterValue, + Object... otherParameterNamesAndValues) { Map<String, Object> hqlParameters = TopiaUtil.convertPropertiesArrayToMap(parameterName, parameterValue, otherParameterNamesAndValues); InnerTopiaQueryBuilderRunQueryStep<E> result = forHql(hql, hqlParameters); @@ -428,8 +436,8 @@ public abstract class AbstractTopiaDao<E extends TopiaEntity> implements TopiaDa @Override public InnerTopiaQueryBuilderAddCriteriaOrRunQueryStep<E> forProperties(String propertyName, - Object propertyValue, - Object... otherPropertyNamesAndValues) { + Object propertyValue, + Object... otherPropertyNamesAndValues) { HqlAndParametersBuilder<E> hqlAndParametersBuilder = getHqlForProperties(propertyName, propertyValue, otherPropertyNamesAndValues); InnerTopiaQueryBuilderAddCriteriaOrRunQueryStep<E> result = new InnerTopiaQueryBuilderAddCriteriaOrRunQueryStep<E>(this, hqlAndParametersBuilder); return result; @@ -659,6 +667,7 @@ public abstract class AbstractTopiaDao<E extends TopiaEntity> implements TopiaDa hqlParameters); Iterable<O> result = new Iterable<O>() { + @Override public Iterator<O> iterator() { return iterator; @@ -692,7 +701,7 @@ public abstract class AbstractTopiaDao<E extends TopiaEntity> implements TopiaDa } catch (TopiaNoResultException tnre) { if (log.isWarnEnabled()) { String message = String.format("Unexpected behavior : entity '%s' not found with topiaId='%s'", - getEntityClass().getName(), topiaId); + getEntityClass().getName(), topiaId); log.warn(message); } throw tnre; @@ -801,8 +810,8 @@ public abstract class AbstractTopiaDao<E extends TopiaEntity> implements TopiaDa public boolean hasNext() { boolean result = data.hasNext() || // no more data - (!firstPageLoaded && pager.getCount() > 0) || // first page not yet loaded and there is data to load - (firstPageLoaded && pager.hasNextPage()); // the first page has been loaded and there is another page + (!firstPageLoaded && pager.getCount() > 0) || // first page not yet loaded and there is data to load + (firstPageLoaded && pager.hasNextPage()); // the first page has been loaded and there is another page return result; } @@ -1249,12 +1258,14 @@ public abstract class AbstractTopiaDao<E extends TopiaEntity> implements TopiaDa * @param entities the list en entities (unsorted) * @param idsList the list of ids (sorted) * @param <O> must be a TopiaEntity + * @return FIXME */ protected <O extends TopiaEntity> List<O> sortAccordingToIds(List<O> entities, final List<String> idsList) { // Cannot sort on second query, will sort according to the first result list final Map<String, O> entitiesIndex = Maps.uniqueIndex(entities, TopiaEntities.getTopiaIdFunction()); Iterable<O> transformed = Iterables.transform(idsList, new Function<String, O>() { + @Override public O apply(String input) { return entitiesIndex.get(input); diff --git a/topia-persistence/src/main/java/org/nuiton/topia/persistence/internal/AbstractTopiaEntity.java b/topia-persistence/src/main/java/org/nuiton/topia/persistence/internal/AbstractTopiaEntity.java index b2eeb10..527d92f 100644 --- a/topia-persistence/src/main/java/org/nuiton/topia/persistence/internal/AbstractTopiaEntity.java +++ b/topia-persistence/src/main/java/org/nuiton/topia/persistence/internal/AbstractTopiaEntity.java @@ -39,11 +39,11 @@ import com.google.common.base.MoreObjects; /** * Base class of each entity. It contains the common attributes and a part of the entities event support. - * <p/> + * * This class does not realize {@link org.nuiton.topia.persistence.event.ListenableTopiaEntity} but it implements its * methods to lighten base implementation. * - * @author poussin <poussin@codelutin.com> + * @author Benjamin Poussin - poussin@codelutin.com * @author Arnaud Thimel (Code Lutin) */ public abstract class AbstractTopiaEntity implements TopiaEntity { @@ -68,7 +68,7 @@ public abstract class AbstractTopiaEntity implements TopiaEntity { * instance can be linked to the {@link org.nuiton.topia.persistence.TopiaPersistenceContext} instance, thus its * life cycle may be shorter than the entity. This is why it is kept as a {@link java.lang.ref.WeakReference}. * - * If not present, the entity will use the <code>DEFAULT_INSTANCE</code> as a fallback TopiaFiresSupport. + * If not present, the entity will use the {@code DEFAULT_INSTANCE} as a fallback TopiaFiresSupport. */ transient protected WeakReference<TopiaFiresSupport> firesSupport; @@ -207,7 +207,7 @@ public abstract class AbstractTopiaEntity implements TopiaEntity { } /** - * We are using the <code>topiaCreateDate</code> for the hashCode because it does not change through time. + * We are using the {@code topiaCreateDate} for the hashCode because it does not change through time. */ @Override public int hashCode() { diff --git a/topia-persistence/src/main/java/org/nuiton/topia/persistence/internal/AbstractTopiaPersistenceContextConstructorParameter.java b/topia-persistence/src/main/java/org/nuiton/topia/persistence/internal/AbstractTopiaPersistenceContextConstructorParameter.java index 924ea01..e794656 100644 --- a/topia-persistence/src/main/java/org/nuiton/topia/persistence/internal/AbstractTopiaPersistenceContextConstructorParameter.java +++ b/topia-persistence/src/main/java/org/nuiton/topia/persistence/internal/AbstractTopiaPersistenceContextConstructorParameter.java @@ -47,6 +47,7 @@ public class AbstractTopiaPersistenceContextConstructorParameter { * @param hibernateProvider holds the Hibernate configuration and session factory * @param applicationFiresSupport the TopiaFiresSupport from the application context * @param topiaIdFactory the TopiaIdFactory instance created according to the application's configuration + * @param sessionRegistry hibernate session registry */ public AbstractTopiaPersistenceContextConstructorParameter(HibernateProvider hibernateProvider, TopiaFiresSupport applicationFiresSupport, TopiaIdFactory topiaIdFactory, TopiaHibernateSessionRegistry sessionRegistry) { this.hibernateProvider = hibernateProvider; diff --git a/topia-persistence/src/main/java/org/nuiton/topia/persistence/internal/FullyQualifiedNamePlusUuidTopiaIdFactory.java b/topia-persistence/src/main/java/org/nuiton/topia/persistence/internal/FullyQualifiedNamePlusUuidTopiaIdFactory.java index 7857efe..88fff2f 100644 --- a/topia-persistence/src/main/java/org/nuiton/topia/persistence/internal/FullyQualifiedNamePlusUuidTopiaIdFactory.java +++ b/topia-persistence/src/main/java/org/nuiton/topia/persistence/internal/FullyQualifiedNamePlusUuidTopiaIdFactory.java @@ -37,7 +37,7 @@ import java.util.UUID; /** * Default implementation of {@link TopiaIdFactory}. Generates a FQN followed by a random UUID. * - * @author Brendan Le Ny <leny@codelutin.com> + * @author Brendan Le Ny - bleny@codelutin.com * @since 3.0 */ public class FullyQualifiedNamePlusUuidTopiaIdFactory implements TopiaIdFactory { diff --git a/topia-persistence/src/main/java/org/nuiton/topia/persistence/internal/HibernateProvider.java b/topia-persistence/src/main/java/org/nuiton/topia/persistence/internal/HibernateProvider.java index bcabf44..b82fd90 100644 --- a/topia-persistence/src/main/java/org/nuiton/topia/persistence/internal/HibernateProvider.java +++ b/topia-persistence/src/main/java/org/nuiton/topia/persistence/internal/HibernateProvider.java @@ -66,10 +66,13 @@ public class HibernateProvider { private static final Log log = LogFactory.getLog(HibernateProvider.class); protected SessionFactory hibernateSessionFactory; + protected Configuration hibernateConfiguration; protected TopiaConfiguration topiaConfiguration; + protected TopiaServiceSupport topiaServiceSupport; + protected TopiaHibernateSessionRegistry sessionRegistry; /** @@ -172,48 +175,48 @@ public class HibernateProvider { // DB2 if (jdbcConfigurationBuilder.isDb2Url(jdbcConnectionUrl) - || jdbcConfigurationBuilder.isH2Url(jdbcConnectionUrl) && jdbcConnectionUrl.contains("MODE=DB2")) { + || jdbcConfigurationBuilder.isH2Url(jdbcConnectionUrl) && jdbcConnectionUrl.contains("MODE=DB2")) { guessedHibernateDialect = DB2Dialect.class.getName(); - // Derby + // Derby } else if (jdbcConfigurationBuilder.isDerbyUrl(jdbcConnectionUrl) - || jdbcConfigurationBuilder.isH2Url(jdbcConnectionUrl) && jdbcConnectionUrl.contains("MODE=Derby")) { + || jdbcConfigurationBuilder.isH2Url(jdbcConnectionUrl) && jdbcConnectionUrl.contains("MODE=Derby")) { guessedHibernateDialect = DerbyDialect.class.getName(); - // HSQLDB + // HSQLDB } else if (jdbcConfigurationBuilder.isHsqlDbUrl(jdbcConnectionUrl) - || jdbcConfigurationBuilder.isH2Url(jdbcConnectionUrl) && jdbcConnectionUrl.contains("MODE=HSQLDB")) { + || jdbcConfigurationBuilder.isH2Url(jdbcConnectionUrl) && jdbcConnectionUrl.contains("MODE=HSQLDB")) { guessedHibernateDialect = HSQLDialect.class.getName(); - // MySQL + // MySQL } else if (jdbcConfigurationBuilder.isMysqlUrl(jdbcConnectionUrl) - || jdbcConfigurationBuilder.isMariaDbUrl(jdbcConnectionUrl) - || jdbcConfigurationBuilder.isGoogleAppEngineUrl(jdbcConnectionUrl) - || jdbcConfigurationBuilder.isH2Url(jdbcConnectionUrl) && jdbcConnectionUrl.contains("MODE=MySQL")) { + || jdbcConfigurationBuilder.isMariaDbUrl(jdbcConnectionUrl) + || jdbcConfigurationBuilder.isGoogleAppEngineUrl(jdbcConnectionUrl) + || jdbcConfigurationBuilder.isH2Url(jdbcConnectionUrl) && jdbcConnectionUrl.contains("MODE=MySQL")) { guessedHibernateDialect = MySQL5Dialect.class.getName(); - // Oracle + // Oracle } else if (jdbcConfigurationBuilder.isOracleUrl(jdbcConnectionUrl) - || jdbcConfigurationBuilder.isH2Url(jdbcConnectionUrl) && jdbcConnectionUrl.contains("MODE=Oracle")) { + || jdbcConfigurationBuilder.isH2Url(jdbcConnectionUrl) && jdbcConnectionUrl.contains("MODE=Oracle")) { guessedHibernateDialect = Oracle10gDialect.class.getName(); - // PostgreSQL + // PostgreSQL } else if (jdbcConfigurationBuilder.isPostgreSqlUrl(jdbcConnectionUrl) - || jdbcConfigurationBuilder.isH2Url(jdbcConnectionUrl) && jdbcConnectionUrl.contains("MODE=PostgreSQL")) { + || jdbcConfigurationBuilder.isH2Url(jdbcConnectionUrl) && jdbcConnectionUrl.contains("MODE=PostgreSQL")) { guessedHibernateDialect = PostgreSQL9Dialect.class.getName(); - // MS SQLServer + // MS SQLServer } else if (jdbcConfigurationBuilder.isJtdsUrl(jdbcConnectionUrl) - || jdbcConfigurationBuilder.isSqlServerUrl(jdbcConnectionUrl) - || jdbcConfigurationBuilder.isH2Url(jdbcConnectionUrl) && jdbcConnectionUrl.contains("MODE=MSSQLServer")) { + || jdbcConfigurationBuilder.isSqlServerUrl(jdbcConnectionUrl) + || jdbcConfigurationBuilder.isH2Url(jdbcConnectionUrl) && jdbcConnectionUrl.contains("MODE=MSSQLServer")) { guessedHibernateDialect = SQLServer2012Dialect.class.getName(); - // SQLite + // SQLite } else if (jdbcConfigurationBuilder.isSqliteUrl(jdbcConnectionUrl) - || jdbcConfigurationBuilder.isSqlDroidUrl(jdbcConnectionUrl)) { + || jdbcConfigurationBuilder.isSqlDroidUrl(jdbcConnectionUrl)) { guessedHibernateDialect = null; - // H2 + // H2 } else if (jdbcConfigurationBuilder.isH2Url(jdbcConnectionUrl)) { guessedHibernateDialect = H2Dialect.class.getName(); @@ -227,11 +230,11 @@ public class HibernateProvider { /** * Method to extract from the given Hibernate SessionFactory a working instance of StandardServiceRegistry - * <p/> + * * IMPORTANT : As much as possible, prefer using the * {@link #getSessionFactoryServiceRegistry(org.hibernate.SessionFactory)} mthod instead of the current one because * the SessionFactoryServiceRegistry is a child of the StandardServiceRegistry - * <p/> + * * NB: This method is static to make sure it does not depend on the current instance * * @param sessionFactory the Hibernate's SessionFactory instance @@ -248,11 +251,11 @@ public class HibernateProvider { /** * Method to extract from the given Hibernate SessionFactory a working instance of SessionFactoryServiceRegistry - * <p/> + * * IMPORTANT : If possible, prefer using this method instead of * {@link #getStandardServiceRegistry(org.hibernate.SessionFactory)} because the SessionFactoryServiceRegistry is a * child of the StandardServiceRegistry - * <p/> + * * NB: This method is static to make sure it does not depend on the current instance * * @param sessionFactory the Hibernate's SessionFactory instance @@ -262,18 +265,19 @@ public class HibernateProvider { // AThimel 03/04/14 The next two lines are the good way to get the SessionFactoryServiceRegistry in Hibernate 4.3 SessionFactoryImplementor sessionFactoryImplementor = (SessionFactoryImplementor) sessionFactory; - SessionFactoryServiceRegistry result = (SessionFactoryServiceRegistry)sessionFactoryImplementor.getServiceRegistry(); + SessionFactoryServiceRegistry result = (SessionFactoryServiceRegistry) sessionFactoryImplementor.getServiceRegistry(); return result; } /** * Method to get an Hibernate service instance from a given Hibernate SessionFactory - * <p/> + * * NB: This method is static to make sure it does not depend on the current instance * * @param sessionFactory the Hibernate's SessionFactory instance * @param serviceClass the expected service class + * @param <S> type of service * @return the found service instance * @throws org.hibernate.service.UnknownServiceException Indicates the service was not known. * @see org.hibernate.service.ServiceRegistry#getService(Class) diff --git a/topia-persistence/src/main/java/org/nuiton/topia/persistence/internal/ShortTopiaIdFactory.java b/topia-persistence/src/main/java/org/nuiton/topia/persistence/internal/ShortTopiaIdFactory.java index 4748f5a..2ce95bb 100644 --- a/topia-persistence/src/main/java/org/nuiton/topia/persistence/internal/ShortTopiaIdFactory.java +++ b/topia-persistence/src/main/java/org/nuiton/topia/persistence/internal/ShortTopiaIdFactory.java @@ -40,9 +40,10 @@ import java.util.Set; import java.util.UUID; /** + * <p> * Does the same than {@link FullyQualifiedNamePlusUuidTopiaIdFactory} but produces shorter topiaId. The class-name part uses only simple * class names, and the random part is base64 encoded. - * <p/> + * </p> * Note: This TopiaIdFactory requires that you do not have several entities with the same simple class name. * * @author Arnaud Thimel (Code Lutin) diff --git a/topia-persistence/src/main/java/org/nuiton/topia/persistence/internal/TopiaConnectionProvider.java b/topia-persistence/src/main/java/org/nuiton/topia/persistence/internal/TopiaConnectionProvider.java index 0c344b3..e19b8f3 100644 --- a/topia-persistence/src/main/java/org/nuiton/topia/persistence/internal/TopiaConnectionProvider.java +++ b/topia-persistence/src/main/java/org/nuiton/topia/persistence/internal/TopiaConnectionProvider.java @@ -46,19 +46,17 @@ import java.util.Map; import java.util.Properties; /** + * <p> * Customized connection provider. - * <p/> - * This provider fix the following bug : - * http://nuiton.org/issues/show/561 - * <p/> + * </p> + * <p> + * This provider fix the following bug : http://nuiton.org/issues/show/561 + * </p> * To use this connection provider, add this property to topia configuration - * <p/> * <pre> * config.setProperty(Environment.CONNECTION_PROVIDER, TopiaConnectionProvider.class.getName()); * </pre> - * <p/> * or in a properties file : - * <p/> * <pre> * hibernate.connection.provider_class=org.nuiton.topia.persistence.internal.TopiaConnectionProvider * </pre> @@ -76,7 +74,7 @@ public class TopiaConnectionProvider implements ConnectionProvider, Configurable /** * JDBC url of connection. - * <p/> + * This is a mandatory hibernate configuration vi the property * {@link Environment#URL}. */ @@ -87,7 +85,7 @@ public class TopiaConnectionProvider implements ConnectionProvider, Configurable /** * Sql isolation level to use in connection. - * <p/> + * * Can be configured by hibernate property {@link Environment#ISOLATION_LEVELS}. * * @see Connection#getTransactionIsolation() @@ -96,7 +94,7 @@ public class TopiaConnectionProvider implements ConnectionProvider, Configurable /** * auto commit connection state. - * <p/> + * * Can be configured by hibernate property {@link Environment#AUTOCOMMIT}. * * @see Connection#getAutoCommit() @@ -105,7 +103,7 @@ public class TopiaConnectionProvider implements ConnectionProvider, Configurable /** * Size of connection pool. - * <p/> + * * By default use {@code 20}, can be specify by using the hibernate * configuration property {@link Environment#POOL_SIZE}. */ diff --git a/topia-persistence/src/main/java/org/nuiton/topia/persistence/internal/TopiaHibernateSessionRegistry.java b/topia-persistence/src/main/java/org/nuiton/topia/persistence/internal/TopiaHibernateSessionRegistry.java index db0c30e..390b458 100644 --- a/topia-persistence/src/main/java/org/nuiton/topia/persistence/internal/TopiaHibernateSessionRegistry.java +++ b/topia-persistence/src/main/java/org/nuiton/topia/persistence/internal/TopiaHibernateSessionRegistry.java @@ -47,7 +47,7 @@ public class TopiaHibernateSessionRegistry { new WeakHashMap<Session, WeakReference<TopiaPersistenceContext>>(); /** - * Register the Session<->TopiaPersistenceContext couple + * Register the Session ↔ TopiaPersistenceContext couple * * @param session the currently used Session * @param persistenceContext the current TopiaPersistenceContext using this Session @@ -82,7 +82,7 @@ public class TopiaHibernateSessionRegistry { } /** - * Removes the Session<->TopiaPersistenceContext association from the registry + * Removes the Session ↔ TopiaPersistenceContext association from the registry * * @param session the Hibernate Session to remove */ diff --git a/topia-persistence/src/main/java/org/nuiton/topia/persistence/internal/support/HibernateTopiaReplicationSupport.java b/topia-persistence/src/main/java/org/nuiton/topia/persistence/internal/support/HibernateTopiaReplicationSupport.java index 0990a2c..fb61fe0 100644 --- a/topia-persistence/src/main/java/org/nuiton/topia/persistence/internal/support/HibernateTopiaReplicationSupport.java +++ b/topia-persistence/src/main/java/org/nuiton/topia/persistence/internal/support/HibernateTopiaReplicationSupport.java @@ -110,8 +110,8 @@ public class HibernateTopiaReplicationSupport implements TopiaReplicationSupport /** * Build the list of queries from the given parameter - * <code>entityAndCondition</code>. - * <p/> + * {@code entityAndCondition}. + * * If no parameter is given, then build the queries for all entities is db, * with no condition. * diff --git a/topia-persistence/src/main/java/org/nuiton/topia/persistence/internal/support/TopiaFiresSupport.java b/topia-persistence/src/main/java/org/nuiton/topia/persistence/internal/support/TopiaFiresSupport.java index af43d00..53da63c 100644 --- a/topia-persistence/src/main/java/org/nuiton/topia/persistence/internal/support/TopiaFiresSupport.java +++ b/topia-persistence/src/main/java/org/nuiton/topia/persistence/internal/support/TopiaFiresSupport.java @@ -58,7 +58,7 @@ import com.google.common.base.Preconditions; /** * Contains all about event listening and propagation. - * <p/> + * * * @author jruchaud : jruchaud@codelutin.com * @author Arnaud Thimel (Code Lutin) @@ -711,7 +711,7 @@ public class TopiaFiresSupport extends AbstractTopiaListenableSupport implements /** * Notify entities listeners for load operation * - * @param <E> type of entities + * @param <E> type of entities * @param context context used * @param entities entities loaded * @return the list of entities loaded diff --git a/topia-persistence/src/main/java/org/nuiton/topia/persistence/internal/support/TopiaServiceSupportImpl.java b/topia-persistence/src/main/java/org/nuiton/topia/persistence/internal/support/TopiaServiceSupportImpl.java index 72ce9fc..eb3fd31 100644 --- a/topia-persistence/src/main/java/org/nuiton/topia/persistence/internal/support/TopiaServiceSupportImpl.java +++ b/topia-persistence/src/main/java/org/nuiton/topia/persistence/internal/support/TopiaServiceSupportImpl.java @@ -44,7 +44,7 @@ import java.util.Map; * * It will look in {@link org.nuiton.topia.persistence.TopiaApplicationContext#getConfiguration()} * to find services declarations and associated configuration. All of those properties match - * the <code>topia.service.*</code> prefix. + * the {@code topia.service.*} prefix. * * A service is declared by giving it a name and the implementation class FQN by following the * pattern. @@ -53,7 +53,7 @@ import java.util.Map; * topia.service.myServiceName=com.my.company.my.app.MyServiceImpl * </pre> * - * Here, <code>myServiceName</code> is the name of the service, you can choose any String. Value + * Here, {@code myServiceName} is the name of the service, you can choose any String. Value * must be the FQN of class that provide an empty constructor and implements * {@link org.nuiton.topia.persistence.TopiaService}. * diff --git a/topia-persistence/src/main/java/org/nuiton/topia/persistence/jdbc/JdbcConfiguration.java b/topia-persistence/src/main/java/org/nuiton/topia/persistence/jdbc/JdbcConfiguration.java index cd95576..89c9fa9 100644 --- a/topia-persistence/src/main/java/org/nuiton/topia/persistence/jdbc/JdbcConfiguration.java +++ b/topia-persistence/src/main/java/org/nuiton/topia/persistence/jdbc/JdbcConfiguration.java @@ -27,7 +27,7 @@ import java.sql.Driver; /** * Jdbc part of the configuration needed to instantiate a {@link org.nuiton.topia.persistence.TopiaApplicationContext}. - * <p/> + * * Please use an instance of {@link org.nuiton.topia.persistence.jdbc.JdbcConfigurationBuilder} to build a new * JdbcTopiaConfiguration. * diff --git a/topia-persistence/src/main/java/org/nuiton/topia/persistence/jdbc/JdbcH2Helper.java b/topia-persistence/src/main/java/org/nuiton/topia/persistence/jdbc/JdbcH2Helper.java index 1b16caf..1a7137d 100644 --- a/topia-persistence/src/main/java/org/nuiton/topia/persistence/jdbc/JdbcH2Helper.java +++ b/topia-persistence/src/main/java/org/nuiton/topia/persistence/jdbc/JdbcH2Helper.java @@ -46,9 +46,14 @@ public class JdbcH2Helper extends JdbcHelper { } /** + * <p> * Tests if a given table exists. WARNING : this may not work is the tableName is not exactly the same. - * <p/> + * </p> * This method is designed for H2 only. + * + * @param schema schema name filter + * @param tableName table name filter + * @return {@code true} if table exists. */ public boolean isTableExist(String schema, String tableName) { Connection connection = null; @@ -84,6 +89,7 @@ public class JdbcH2Helper extends JdbcHelper { * Read database from gzip compressed file * * @param file the source file to use for restore + * @throws FileNotFoundException if file does not exist */ public void restore(File file) throws FileNotFoundException { String options = ""; diff --git a/topia-persistence/src/main/java/org/nuiton/topia/persistence/legacy/Collector.java b/topia-persistence/src/main/java/org/nuiton/topia/persistence/legacy/Collector.java index 6e10159..30dd34d 100644 --- a/topia-persistence/src/main/java/org/nuiton/topia/persistence/legacy/Collector.java +++ b/topia-persistence/src/main/java/org/nuiton/topia/persistence/legacy/Collector.java @@ -40,10 +40,10 @@ import java.util.Deque; /** * Un objet qui permet de parcourir des entites (via un * {@link CollectorVisitor}) et de collecter des donnees pendant le parcours. - * <p/> + * * La classe a un type qui est le type de retour de la methode * {@link #detect(TopiaEntity...)}. - * <p/> + * * On peut donc très facilement en faire un collecteur de donnees. * * @author Tony Chemit - chemit@codelutin.com diff --git a/topia-persistence/src/main/java/org/nuiton/topia/persistence/legacy/DBMapping.java b/topia-persistence/src/main/java/org/nuiton/topia/persistence/legacy/DBMapping.java index fd40d3a..79cb7f6 100644 --- a/topia-persistence/src/main/java/org/nuiton/topia/persistence/legacy/DBMapping.java +++ b/topia-persistence/src/main/java/org/nuiton/topia/persistence/legacy/DBMapping.java @@ -52,7 +52,7 @@ import java.util.regex.Pattern; /** * Une classe qui permet d'obtenir les mapping de noms entre les entités et les objets de la base. - * <p/> + * * On retrouve aussi ici des méthodes utils pour executer du code sql sur la base (notamment la gestion des séquences). * * @author Tony Chemit - chemit@codelutin.com diff --git a/topia-persistence/src/main/java/org/nuiton/topia/persistence/legacy/EntityListUpdator.java b/topia-persistence/src/main/java/org/nuiton/topia/persistence/legacy/EntityListUpdator.java index 0a5c736..a316028 100644 --- a/topia-persistence/src/main/java/org/nuiton/topia/persistence/legacy/EntityListUpdator.java +++ b/topia-persistence/src/main/java/org/nuiton/topia/persistence/legacy/EntityListUpdator.java @@ -36,13 +36,13 @@ import java.util.Collection; /** * A implementation of {@link ListUpdator} for {@link TopiaEntity} type. - * <p/> + * * Some factory methods are defined to simplify the generic cast, prefer used them * instead of the (protected) constructor. * * @author Tony Chemit - chemit@codelutin.com * @param <P> type of parent of childs - * @param <E> type of child + * @param <E>type of child */ public class EntityListUpdator<P extends TopiaEntity, E extends TopiaEntity> implements ListUpdator<P, E> { diff --git a/topia-persistence/src/main/java/org/nuiton/topia/persistence/legacy/ListUpdator.java b/topia-persistence/src/main/java/org/nuiton/topia/persistence/legacy/ListUpdator.java index aa6d3a6..6e4047a 100644 --- a/topia-persistence/src/main/java/org/nuiton/topia/persistence/legacy/ListUpdator.java +++ b/topia-persistence/src/main/java/org/nuiton/topia/persistence/legacy/ListUpdator.java @@ -30,13 +30,13 @@ import java.util.Collection; /** * A simple contract to allow you to update some collections of an entity. - * <p/> + * * The purpose of the contract is to make possible (via a StorageService for example) some * automatic and generic behaviour when you want to set a collection of childs into a entity. * * @author Tony Chemit - chemit@codelutin.com * @param <P> the type of the entity which contains the collection to update. - * @param <E> the type of entities in the collection. + * @param <E>the type of entities in the collection. */ public interface ListUpdator<P, E> { @@ -52,7 +52,7 @@ public interface ListUpdator<P, E> { * * @param parent the entity to query * @param topiaId the id of the researched child entity. - * @return the child entity or <code>null</code>, if not found. + * @return the child entity or {@code null}, if not found. */ E getChild(P parent, String topiaId); diff --git a/topia-persistence/src/main/java/org/nuiton/topia/persistence/legacy/Loador.java b/topia-persistence/src/main/java/org/nuiton/topia/persistence/legacy/Loador.java index 6393447..378b67c 100644 --- a/topia-persistence/src/main/java/org/nuiton/topia/persistence/legacy/Loador.java +++ b/topia-persistence/src/main/java/org/nuiton/topia/persistence/legacy/Loador.java @@ -31,7 +31,7 @@ import java.util.Map; * A simple contract to load an object from another one. * * @author Tony Chemit - chemit@codelutin.com - * @param <E> type of bean to load + * @param <E>type of bean to load */ public interface Loador<E> extends Serializable { @@ -45,10 +45,10 @@ public interface Loador<E> extends Serializable { /** * Obtain from an entity all data to bind to another one according the * definition of the loador. - * <p/> + * * This method is usefull when you can not directly used the * {@link #load(Object, Object, boolean, String...)} method. - * <p/> + * * For example, when an entity has a immutable business key (says with an * hibernate naturalId for example), * and that you want to create the data in a db, you must give all the diff --git a/topia-persistence/src/main/java/org/nuiton/topia/persistence/support/TopiaJpaSupport.java b/topia-persistence/src/main/java/org/nuiton/topia/persistence/support/TopiaJpaSupport.java index eacea98..e7de731 100644 --- a/topia-persistence/src/main/java/org/nuiton/topia/persistence/support/TopiaJpaSupport.java +++ b/topia-persistence/src/main/java/org/nuiton/topia/persistence/support/TopiaJpaSupport.java @@ -24,11 +24,11 @@ package org.nuiton.topia.persistence.support; * #L% */ +import org.nuiton.topia.persistence.QueryMissingOrderException; + import java.util.List; import java.util.Map; -import org.nuiton.topia.persistence.QueryMissingOrderException; - /** * This API provides methods to use persistence using JPA queries * @@ -39,26 +39,28 @@ public interface TopiaJpaSupport { /** * Allow to do some JPA-QL query - * <p/> + * * WARNING : Depending on the registered service, this method may not * support something else than queries on TopiaEntity * + * @param <T> type of result * @param jpaql the JPA-QL query * @param parameters a map which keys are the attribute names and values are the attributes expected values * @return The result list */ - <T> List<T> findAll(String jpaql, - Map<String, Object> parameters); + <T> List<T> findAll(String jpaql, Map<String, Object> parameters); /** * Allow to do some JPA-QL query using the given bounds. - * <p/> - * No lower bound : <code>startIndex</code> = 0.<br/> - * No upper bound : <code>endIndex</code> = -1. - * <p/> + * <ul> + * <li>No lower bound : {@code startIndex = 0}.</li> + * <li>No upper bound : {@code endIndex = -1}.</li> + * </ul> + * * WARNING : Depending on the registered service, this method may not * support something else than queries on TopiaEntity * + * @param <T> type of result * @param jpaql the JPA-QL query * @param startIndex first index of entity to return * @param endIndex last index of entity to return @@ -75,31 +77,31 @@ public interface TopiaJpaSupport { /** * Allow to do some JPA-QL query and return a single result. If nothing is * found by the query, will return null. - * <p/> + * * WARNING : Depending on the registered service, this method may not * support something else than queries on TopiaEntity * + * @param <T> type of result * @param jpaql the JPA-QL query * @param parameters a map which keys are the attribute names and values are the attributes expected values * @return The result instance or null */ - <T> T findAny(String jpaql, - Map<String, Object> parameters); + <T> T findAny(String jpaql, Map<String, Object> parameters); /** * Allow to do some JPA-QL query and return an unique result. If nothing is * found by the query, will return null. If more than one result is found, * will throw an exception. - * <p/> + * * WARNING : Depending on the registered service, this method may not * support something else than queries on TopiaEntity * + * @param <T> type of result * @param jpaql the JPA-QL query * @param parameters a map which keys are the attribute names and values are the attributes expected values * @return The result instance or null */ - <T> T findUnique(String jpaql, - Map<String, Object> parameters); + <T> T findUnique(String jpaql, Map<String, Object> parameters); /** * Execute JPA-QL operation on data (Update, Delete). @@ -108,12 +110,11 @@ public interface TopiaJpaSupport { * @param parameters a map which keys are the attribute names and values are the attributes expected values * @return The number of entities updated or deleted. */ - int execute(String jpaql, - Map<String, Object> parameters); + int execute(String jpaql, Map<String, Object> parameters); /** * Tells to the context if it has to use a flush mode before each query. - * <p/> + * * By default, we use a flush mode, but in some case it costs to much doing * this, that's why you can disable it setting the value to {@code false}. * @@ -125,7 +126,7 @@ public interface TopiaJpaSupport { /** * Persist the given transient instance, first assigning a generated identifier. This method is JPA implementation * independent. - * <p/> + * * This method is "inspired" of the Hibernate's Session#save method. * * @param object a transient instance of a persistent class @@ -134,7 +135,7 @@ public interface TopiaJpaSupport { /** * Update the persistent instance with the identifier of the given detached instance. - * <p/> + * * This method is "inspired" of the Hibernate's Session#update method. * * @param object a detached instance containing updated state @@ -143,7 +144,7 @@ public interface TopiaJpaSupport { /** * Either {@link #save(Object)} or {@link #update(Object)} the given instance. - * <p/> + * * This method is "inspired" of the Hibernate's Session#saveOrUpdate method. * * @param object a transient or detached instance containing new or updated state @@ -154,7 +155,7 @@ public interface TopiaJpaSupport { /** * Remove a persistent instance. - * <p/> + * * This method is "inspired" of the Hibernate's Session#delete method. * * @param object the instance to be removed diff --git a/topia-persistence/src/main/java/org/nuiton/topia/persistence/support/TopiaListenableSupport.java b/topia-persistence/src/main/java/org/nuiton/topia/persistence/support/TopiaListenableSupport.java index 50674a3..85e66ff 100644 --- a/topia-persistence/src/main/java/org/nuiton/topia/persistence/support/TopiaListenableSupport.java +++ b/topia-persistence/src/main/java/org/nuiton/topia/persistence/support/TopiaListenableSupport.java @@ -46,7 +46,7 @@ public interface TopiaListenableSupport { /** * Register to the context a TopiaEntityListener about any TopiaEntity. - * <code>listener</code> instance will be notified AFTER any operation on + * {@code listener} instance will be notified AFTER any operation on * the entity. * * @param listener the listener instance to register @@ -55,7 +55,7 @@ public interface TopiaListenableSupport { /** * Register to the context a TopiaEntityListener about the given entity - * class. <code>listener</code> instance will be notified AFTER any + * class. {@code listener} instance will be notified AFTER any * operation on the entity. * * @param entityClass the TopiaEntity's class to listen @@ -87,7 +87,7 @@ public interface TopiaListenableSupport { /** * Register to the context a TopiaEntityVetoable about any TopiaEntity. - * <code>vetoable</code> instance will be notified BEFORE any operation on + * {@code vetoable} instance will be notified BEFORE any operation on * the entity. * * @param vetoable the vetoable instance to register @@ -96,7 +96,7 @@ public interface TopiaListenableSupport { /** * Register to the context a TopiaEntityVetoable about the given entity - * class. <code>vetoable</code> instance will be notified BEFORE any + * class. {@code vetoable} instance will be notified BEFORE any * operation on the entity. * * @param entityClass the TopiaEntity's class to listen @@ -128,7 +128,7 @@ public interface TopiaListenableSupport { /** * Register to the context a TopiaEntitiesVetoable about any TopiaEntity. - * <code>vetoable</code> instance will be notified BEFORE any entity load + * {@code vetoable} instance will be notified BEFORE any entity load * * @param vetoable the vetoable instance to register */ @@ -147,7 +147,7 @@ public interface TopiaListenableSupport { /** * Register to the context a TopiaTransactionListener about the transaction. - * <code>listener</code> instance will be notified AFTER any operation on + * {@code listener} instance will be notified AFTER any operation on * the transaction. * * @param listener the listener instance to register @@ -167,7 +167,7 @@ public interface TopiaListenableSupport { /** * Register to the context a TopiaTransactionVetoable about the transaction. - * <code>vetoable</code> instance will be notified BEFORE any operation on + * {@code vetoable} instance will be notified BEFORE any operation on * the transaction. * * @param vetoable the vetoable instance to register @@ -187,7 +187,7 @@ public interface TopiaListenableSupport { /** * Register to the context a PropertyChangeListener about some entity's - * property change. <code>listener</code> instance will be notified AFTER + * property change. {@code listener} instance will be notified AFTER * any change on the entity's property * * @param listener the listener instance to register @@ -207,7 +207,7 @@ public interface TopiaListenableSupport { /** * Register to the context a TopiaSchemaListener about any schema - * modification. <code>listener</code> instance will be notified BEFORE and + * modification. {@code listener} instance will be notified BEFORE and * AFTER any change on the schema * * @param listener the listener instance to register diff --git a/topia-persistence/src/main/java/org/nuiton/topia/persistence/support/TopiaReplicationSupport.java b/topia-persistence/src/main/java/org/nuiton/topia/persistence/support/TopiaReplicationSupport.java index ff75d22..f3f5ef5 100644 --- a/topia-persistence/src/main/java/org/nuiton/topia/persistence/support/TopiaReplicationSupport.java +++ b/topia-persistence/src/main/java/org/nuiton/topia/persistence/support/TopiaReplicationSupport.java @@ -24,8 +24,8 @@ package org.nuiton.topia.persistence.support; * #L% */ -import org.nuiton.topia.persistence.TopiaReplicationDestination; import org.nuiton.topia.persistence.TopiaEntity; +import org.nuiton.topia.persistence.TopiaReplicationDestination; import java.util.List; @@ -40,18 +40,18 @@ public interface TopiaReplicationSupport { /** * Makes a replication of some entities from this context to the given * context without any entity modification. - * <p/> - * <b>Note:</b> If the <code>entityAndCondition</code> parameter is empty, + * + * <b>Note:</b> If the {@code entityAndCondition} parameter is empty, * all the database will be replicated - * <p/> + * * <b>Note 2:</b> The simple replication may not be sufficent. You may want * to replicate only a part of some entities : use the method {@link * #replicateEntities(TopiaReplicationDestination, java.util.List)}. * * @param topiaReplicationDestination the destination context - * @param entityAndCondition [key;value;...] parameter which key is the - * entity class to replicate, and value the - * "where" condition to use when querying entities + * @param entityAndCondition [key;value;...] parameter which key is the + * entity class to replicate, and value the + * "where" condition to use when querying entities * @throws IllegalArgumentException if one of the context is closed or if * trying to replicate within the same * database @@ -63,7 +63,8 @@ public interface TopiaReplicationSupport { * Replicate a given entity from this context to the given context. * * @param topiaReplicationDestination the destination context - * @param entity the entity instance to replicate + * @param entity the entity instance to replicate + * @param <T> type of entity * @throws IllegalArgumentException if one of the context is closed or if * trying to replicate within the same * database @@ -76,7 +77,8 @@ public interface TopiaReplicationSupport { * context without any entity modification. * * @param topiaReplicationDestination the destination context - * @param entities the list of entities instance to replicate + * @param entities the list of entities instance to replicate + * @param <T> type of entity * @throws IllegalArgumentException if one of the context is closed or if * trying to replicate within the same * database diff --git a/topia-persistence/src/main/java/org/nuiton/topia/persistence/support/TopiaServiceSupport.java b/topia-persistence/src/main/java/org/nuiton/topia/persistence/support/TopiaServiceSupport.java index aa53369..dee02b8 100644 --- a/topia-persistence/src/main/java/org/nuiton/topia/persistence/support/TopiaServiceSupport.java +++ b/topia-persistence/src/main/java/org/nuiton/topia/persistence/support/TopiaServiceSupport.java @@ -37,12 +37,14 @@ import java.util.Map; public interface TopiaServiceSupport { /** - * The list of registered services. The map key is the service name, and the value is the service instance. + * @return The list of registered services. The map key is the service name, and the value is the service instance. */ Map<String, TopiaService> getServices(); /** - * Same as {@link #getServices()} but returns only services that implements + * @param interfaceService FIXME + * @param <T> type of service + * @return Same as {@link #getServices()} but returns only services that implements * given contract (or is instance of given class). */ <T extends TopiaService> Map<String, T> getServices(Class<T> interfaceService); diff --git a/topia-persistence/src/main/java/org/nuiton/topia/persistence/support/TopiaSqlQuery.java b/topia-persistence/src/main/java/org/nuiton/topia/persistence/support/TopiaSqlQuery.java index 54ec2c9..6c98c8d 100644 --- a/topia-persistence/src/main/java/org/nuiton/topia/persistence/support/TopiaSqlQuery.java +++ b/topia-persistence/src/main/java/org/nuiton/topia/persistence/support/TopiaSqlQuery.java @@ -95,7 +95,7 @@ public abstract class TopiaSqlQuery<O> { /** * From a given result set, let's count his number of row. - * <p/> + * * <strong>Note:</strong> the result set must be scrollable to go back to * before first row. * diff --git a/topia-persistence/src/main/java/org/nuiton/topia/persistence/support/TopiaSqlSupport.java b/topia-persistence/src/main/java/org/nuiton/topia/persistence/support/TopiaSqlSupport.java index 6fc0fd9..32ef408 100644 --- a/topia-persistence/src/main/java/org/nuiton/topia/persistence/support/TopiaSqlSupport.java +++ b/topia-persistence/src/main/java/org/nuiton/topia/persistence/support/TopiaSqlSupport.java @@ -53,6 +53,7 @@ public interface TopiaSqlSupport { /** * Runs the given SQL query and return its first result if there is some. * + * @param <O> type of result * @param query query to play * @return the single result or {@code null} if none found. * @throws TopiaException for any pb @@ -62,6 +63,7 @@ public interface TopiaSqlSupport { /** * Runs the given SQL query and return all his result if there is some. * + * @param <O> type of result * @param query query to play * @return the list of results (the list is empty if query returns no result). * @throws TopiaException for any pb diff --git a/topia-persistence/src/main/java/org/nuiton/topia/persistence/util/DiffState.java b/topia-persistence/src/main/java/org/nuiton/topia/persistence/util/DiffState.java index a2c29f0..0be13fd 100644 --- a/topia-persistence/src/main/java/org/nuiton/topia/persistence/util/DiffState.java +++ b/topia-persistence/src/main/java/org/nuiton/topia/persistence/util/DiffState.java @@ -41,19 +41,19 @@ public enum DiffState { /** * nouvel entite dans le storage de reference. - * <p/> + * * A ajouter dans le storage local. */ NEW, /** * entite modifie dans le storage de reference (voir topiaVersion). - * <p/> + * * A mettre a jour dans le storage local. */ MODIFIED, /** * entité supprimée dans le storage de reference. - * <p/> + * * A supprimer du storage local (apres remplacement par autre chose...) */ REMOVED; diff --git a/topia-persistence/src/main/java/org/nuiton/topia/persistence/util/EntityOperator.java b/topia-persistence/src/main/java/org/nuiton/topia/persistence/util/EntityOperator.java index 833bcef..184e266 100644 --- a/topia-persistence/src/main/java/org/nuiton/topia/persistence/util/EntityOperator.java +++ b/topia-persistence/src/main/java/org/nuiton/topia/persistence/util/EntityOperator.java @@ -53,10 +53,10 @@ import com.google.common.base.Defaults; /** * Un objet qui permet d'effecuter des operations de manipulation des donnees * dans les entites du type donne. - * <p/> + * * L'objet connait la liste des proprietes et des associations du type donne et * permet de modifier ces valeurs : - * <p/> + * * {@link #get(String, TopiaEntity)} * {@link #set(String, TopiaEntity, Object)} * {@link #copy(String, TopiaEntity, TopiaEntity)} @@ -64,14 +64,14 @@ import com.google.common.base.Defaults; * {@link #addChild(String, TopiaEntity, Object)} * {@link #removeChild(String, TopiaEntity, Object)} * ... - * <p/> + * * D'autres methodes permettent d'effectuer des operations en lot (sur plusieurs * proprietes en meme temps) sur les proprietes : - * <p/> + * * {@link #copyProperties(TopiaEntity, TopiaEntity, boolean, String...)} * {@link #obtainProperties(TopiaEntity, String...)} * {@link #clearProperties(TopiaEntity, String...)} - * <p/> + * * Note : cet objet ne permet pas d'operation vers les bases. * * @param <B> type de l'entite @@ -138,8 +138,8 @@ public class EntityOperator<B extends TopiaEntity> { /** * Recupere la valeur de la propriete donnee. - * <p/> - * Note : cela apellera la methode <code>getXXX()</code>. + * + * Note : cela apellera la methode {@code getXXX()}. * * @param name le nom de la propriete * @param bean l'instance a interroger @@ -153,8 +153,8 @@ public class EntityOperator<B extends TopiaEntity> { /** * Positionner la valeur donne de la propriete donnee. - * <p/> - * Note : cela apellera la methode <code>setXXX(value)</code>. + * + * Note : cela apellera la methode {@code setXXX(value)}. * * @param name le nom de la propriete * @param bean l'instance a mettre a jour @@ -218,7 +218,7 @@ public class EntityOperator<B extends TopiaEntity> { /** * Pour obtenir un dictionnaire des propriétés marqués not-null et la clef naturelle * du {@code bean} donne. - * <p/> + * * Cette methode est utilisée pour faire un dao.create, pour s'assurer que * tout ce qui ne doit pas pas être à null est bien fourni à la création de * l'objet, sinon on obtient des erreurs. @@ -240,8 +240,8 @@ public class EntityOperator<B extends TopiaEntity> { /** * Copie une propriete de src vers dst. - * <p/> - * Note : cela apellera la methode <code>setXXX(value)</code>. + * + * Note : cela apellera la methode {@code setXXX(value)}. * * @param name le nom de la propriete * @param from l'instance a interroger @@ -255,8 +255,8 @@ public class EntityOperator<B extends TopiaEntity> { /** * Positionner la valeur nulle de la propriete donnee. - * <p/> - * Note : cela apellera la methode <code>setXXX(nullValue)</code>. + * + * Note : cela apellera la methode {@code setXXX(nullValue)}. * * @param name le nom de la propriete * @param bean l'instance a mettre a jour @@ -271,8 +271,8 @@ public class EntityOperator<B extends TopiaEntity> { /** * Recupere une entite d'association a partir de son id. - * <p/> - * Note : cela apellera la methode <code>getXXXByTopiaId(topiaId)</code>. + * + * Note : cela apellera la methode {@code getXXXByTopiaId(topiaId)}. * * @param name le nom de la propriete d'association * @param bean l'instance a interroger @@ -287,8 +287,8 @@ public class EntityOperator<B extends TopiaEntity> { /** * Test s'il existe des entites d'association pour la propriete donnee. - * <p/> - * Note : cela apellera la methode <code>isXXXEmpty()</code>. + * + * Note : cela apellera la methode {@code isXXXEmpty()}. * * @param name le nom de la propriete d'association * @param bean l'instance a interroger @@ -302,8 +302,8 @@ public class EntityOperator<B extends TopiaEntity> { /** * Ajoute une entite d'association. - * <p/> - * Note : cela apellera la methode <code>addXXX(child)</code>. + * + * Note : cela apellera la methode {@code addXXX(child)}. * * @param name le nom de la propriete d'association * @param bean l'instance a mettre a jour @@ -316,8 +316,8 @@ public class EntityOperator<B extends TopiaEntity> { /** * Ajoute toutes les entites d'association. - * <p/> - * Note : cela apellera la methode <code>addXXX(child)</code>. + * + * Note : cela apellera la methode {@code addXXX(child)}. * * @param name le nom de la propriete d'association * @param bean l'instance a mettre a jour @@ -330,8 +330,8 @@ public class EntityOperator<B extends TopiaEntity> { /** * Retire une entite d'association. - * <p/> - * Note : cela apellera la methode <code>removeXXX(child)</code>. + * + * Note : cela apellera la methode {@code removeXXX(child)}. * * @param name le nom de la propriete d'association * @param bean l'instance a mettre a jour @@ -344,8 +344,8 @@ public class EntityOperator<B extends TopiaEntity> { /** * Retourne le nombre d'entite d'association. - * <p/> - * Note : cela apellera la methode <code>sizeXXX(childs)</code>. + * + * Note : cela apellera la methode {@code sizeXXX(childs)}. * * @param name le nom de la propriete d'association * @param bean l'instance a mettre a jour @@ -359,8 +359,8 @@ public class EntityOperator<B extends TopiaEntity> { /** * Retire toutes les entites d'association. - * <p/> - * Note : cela apellera la methode <code>clearXXX(childs)</code>. + * + * Note : cela apellera la methode {@code clearXXX(childs)}. * * @param name le nom de la propriete d'association * @param bean l'instance a mettre a jour @@ -372,7 +372,7 @@ public class EntityOperator<B extends TopiaEntity> { /** * Recopie toutes les proprietes donnes depuis src vers dst. - * <p/> + * * Note : si aucune propriete n'est donnee, on utilise toutes les proprietes * connues par l'operateur. * @@ -405,7 +405,7 @@ public class EntityOperator<B extends TopiaEntity> { /** * Obtenir dans un dictionnaire, les valeurs des proprietes donnees. - * <p/> + * * Si aucune proropiete n'est donne, alors on utilise toutes les proprietes * connu par l'operateur. * @@ -432,7 +432,7 @@ public class EntityOperator<B extends TopiaEntity> { /** * Met a null toutes les proprietes donnees. - * <p/> + * * Si aucune proropiete n'est donnee, alors on utilise toutes les proprietes * connu par l'operateur. * diff --git a/topia-persistence/src/main/java/org/nuiton/topia/persistence/util/EntityOperatorStore.java b/topia-persistence/src/main/java/org/nuiton/topia/persistence/util/EntityOperatorStore.java index 1d45c4f..7d72350 100644 --- a/topia-persistence/src/main/java/org/nuiton/topia/persistence/util/EntityOperatorStore.java +++ b/topia-persistence/src/main/java/org/nuiton/topia/persistence/util/EntityOperatorStore.java @@ -48,7 +48,7 @@ public class EntityOperatorStore { /** * - * @param <E> le type de l'entite + * @param <E>le type de l'entite * @param contract le contrat de l'entite * @return l'operator associe au contrat * @see EntityOperator diff --git a/topia-persistence/src/main/java/org/nuiton/topia/persistence/util/TopiaEntityBinder.java b/topia-persistence/src/main/java/org/nuiton/topia/persistence/util/TopiaEntityBinder.java index 16ded67..dbceeff 100644 --- a/topia-persistence/src/main/java/org/nuiton/topia/persistence/util/TopiaEntityBinder.java +++ b/topia-persistence/src/main/java/org/nuiton/topia/persistence/util/TopiaEntityBinder.java @@ -31,18 +31,19 @@ import org.nuiton.util.beans.Binder; /** * A {@link Binder} dedicated to {@link TopiaEntity} dealing with technical * values. - * <p/> + * * There is an internal sate {@link #empty} to deal with default values of * properties of an entity. - * <p/> + * * <b>Note:</b> Should remove {@link Loador} contract soon. * - * @author tchemit < chemit@codelutin.com > * @param <E> the type of entity + * @author Tony Chemit - tchemit@codelutin.com * @since 2.3.0 */ public class TopiaEntityBinder<E extends TopiaEntity> extends Binder<E, E> implements Loador<E> { + private static final long serialVersionUID = 1L; protected E empty; diff --git a/topia-persistence/src/main/java/org/nuiton/topia/persistence/util/TopiaEntityHelper.java b/topia-persistence/src/main/java/org/nuiton/topia/persistence/util/TopiaEntityHelper.java index f5adcf8..f3efaf1 100644 --- a/topia-persistence/src/main/java/org/nuiton/topia/persistence/util/TopiaEntityHelper.java +++ b/topia-persistence/src/main/java/org/nuiton/topia/persistence/util/TopiaEntityHelper.java @@ -85,13 +85,13 @@ public class TopiaEntityHelper { /** * Récupère une entité qui doit exister à partir de son id. - * <p/> + * * Si l'entité n'existe pas, on déclanche une exception {@link * IllegalArgumentException}. * * @param dao la dao pour récupérer la valeur * @param topiaId l'id de l'entité recherchée - * @param <E> le type de l'entité + * @param <E> le type de l'entité * @return l'entité recherché * @throws TopiaException pour tout pb lors de la récupération de * l'entité @@ -112,8 +112,8 @@ public class TopiaEntityHelper { * * @param entities la liste des entités à scanner * @param topiaId l'id de l'entité recherchée - * @param <E> le type de l'entité - * @return l'entité trouvée, ou <code>null</code> si elle n'est pas + * @param <E> le type de l'entité + * @return l'entité trouvée, ou {@code null} si elle n'est pas * trouvée. */ public static <E extends TopiaEntity> E getEntityByTopiaId( @@ -150,7 +150,7 @@ public class TopiaEntityHelper { * * @param paramName le nom du paramètre à afficher en casd'erreur * @param bean l'entité à tester - * @param <E> le type de l'entité + * @param <E> le type de l'entité * @throws IllegalStateException si l'entité n'a pas de topiaId * @throws NullPointerException si l'entité est null */ @@ -167,7 +167,7 @@ public class TopiaEntityHelper { * * @param paramName le nom de paramètre à afficher en cas d'erreur * @param bean l'entité à tester - * @param <E> le type del'entité + * @param <E> le type del'entité * @throws NullPointerException si l'entité est nulle * @throws IllegalStateException si l'entité possède un topiaId. */ @@ -445,7 +445,7 @@ public class TopiaEntityHelper { /** * Collecte l'ensemble des types d'entites (via un parcours en profondeur). - * <p/> + * * On retourne toujours les contrats des entites et jamais les * implantations. * @@ -497,7 +497,7 @@ public class TopiaEntityHelper { /** * Collecte l'ensemble des entites (via un parcours en profondeur) avec un * filtrage sur les types d'entites a retourner. - * <p/> + * * On retourne toujours les contrats des entites et jamais les * implantations. * @@ -559,7 +559,7 @@ public class TopiaEntityHelper { /** * Collecte l'ensemble des ids d'entites (via un parcours en profondeur) * avec un filtrage sur les types d'entites a retourner. - * <p/> + * * On retourne toujours les contrats des entites et jamais les * implantations. * @@ -954,7 +954,7 @@ public class TopiaEntityHelper { * Construit une list d'entite dont les ids sont tous dans la liste d'ids * donnee. * - * @param <E> le type des entites de la liste + * @param <E> le type des entites de la liste * @param list la liste a filter * @param topiaIds la liste des ids a retenir * @return la nouvelle liste filtree @@ -976,7 +976,7 @@ public class TopiaEntityHelper { /** * Construit le dictionnaire des differences entre deux listes d'entites. * - * @param <E> le type des entites + * @param <E> le type des entites * @param referentiel la liste considere comme reference * @param locale la liste a mettre a jour * @return le dictionnaire des etats des entites ajoutees, modifiees ou @@ -1160,7 +1160,7 @@ public class TopiaEntityHelper { * Given two names (representing two types of entity), obtains the * association table name in the format {@code X_Y} where X est the table * name smaller (in natural order on {@link String}). - * <p/> + * * Example: from {@code A} and {@code B}, we get {@code A_B}. * * @param table1 the first table diff --git a/topia-persistence/src/main/java/org/nuiton/topia/persistence/util/TopiaEntityMap.java b/topia-persistence/src/main/java/org/nuiton/topia/persistence/util/TopiaEntityMap.java index 92cc162..3ebbaa8 100644 --- a/topia-persistence/src/main/java/org/nuiton/topia/persistence/util/TopiaEntityMap.java +++ b/topia-persistence/src/main/java/org/nuiton/topia/persistence/util/TopiaEntityMap.java @@ -73,7 +73,7 @@ public abstract class TopiaEntityMap<K extends TopiaEntityEnum, V extends TopiaE /** * Adds the given entity to the dictonary only if it does not exists. - * <p/> + * * Will return {@code true} if entity was added, {@code false} otherwise. * * @param entity the entity to add diff --git a/topia-persistence/src/main/java/org/nuiton/topia/persistence/util/TopiaEntityRef.java b/topia-persistence/src/main/java/org/nuiton/topia/persistence/util/TopiaEntityRef.java index d53a5f4..051222c 100644 --- a/topia-persistence/src/main/java/org/nuiton/topia/persistence/util/TopiaEntityRef.java +++ b/topia-persistence/src/main/java/org/nuiton/topia/persistence/util/TopiaEntityRef.java @@ -31,10 +31,10 @@ import com.google.common.base.Preconditions; /** * Definition of a reference of an entity from a root entity. - * <p/> + * * the method {@link #getAccessorExpression()} return the jxpath to access the * ref from the root object. - * <p/> + * * TODO Javadoc... * * @since 2.2.0 diff --git a/topia-persistence/src/main/java/org/nuiton/topia/persistence/util/TopiaH2Util.java b/topia-persistence/src/main/java/org/nuiton/topia/persistence/util/TopiaH2Util.java index 53af068..053252d 100644 --- a/topia-persistence/src/main/java/org/nuiton/topia/persistence/util/TopiaH2Util.java +++ b/topia-persistence/src/main/java/org/nuiton/topia/persistence/util/TopiaH2Util.java @@ -70,7 +70,7 @@ public class TopiaH2Util { /** * Read database from gzip compressed file - * <p/> + * * Only work for h2 database * * @param file the source file to use for restore diff --git a/topia-persistence/src/main/java/org/nuiton/topia/persistence/util/TopiaUtil.java b/topia-persistence/src/main/java/org/nuiton/topia/persistence/util/TopiaUtil.java index 958b13b..3440079 100644 --- a/topia-persistence/src/main/java/org/nuiton/topia/persistence/util/TopiaUtil.java +++ b/topia-persistence/src/main/java/org/nuiton/topia/persistence/util/TopiaUtil.java @@ -68,7 +68,7 @@ import java.util.regex.Pattern; /** * TODO-fdesbois-20100507 : Need javadoc + translations for existing methods. * - * @author bpoussin <poussin@codelutin.com> + * @author Benjamin Poussin - poussin@codelutin.com * @author Tony Chemit - chemit@codelutin.com */ public class TopiaUtil { @@ -124,9 +124,9 @@ public class TopiaUtil { /** * Compute a regex pattern given a format string. - * <p/> + * * A {@link String#format(String, Object...)} will be apply to - * <code>format</code>, with for parameters the list of <code>klass</code> + * {@code format}, with for parameters the list of {@code klass} * transformed in topia pattern via method {@link #getTopiaIdPattern(Class)} * ready to be capture (enclosed by ()). * @@ -514,7 +514,7 @@ public class TopiaUtil { } /** - * Hibernate 4.3.x compatible Supplier<ConnectionProvider>. The provider will choose the best way to find the + * Hibernate 4.3.x compatible {@code Supplier<ConnectionProvider>}. The provider will choose the best way to find the * ConnectionProvider depending on the way is has been created. */ public static class ConnectionProviderSupplier implements Supplier<ConnectionProvider>, Closeable { -- To stop receiving notification emails like this one, please contact nuiton.org SCM administrator <admin+scm@nuiton.org>.
This is an automated email from the git hooks/post-receive script. New commit to branch feature/3858_javadoc_jdk8 in repository topia. See http://git.nuiton.org/topia.git commit 7e60561901a6b4e61a97b2271470a978b61a7802 Author: Tony CHEMIT <chemit@codelutin.com> Date: Wed Dec 30 16:29:09 2015 +0100 Fix javadoc in templates module (See #3858) --- .../topia/templates/EntityDaoTransformer.java | 4 +- .../templates/EntityHibernateMappingGenerator.java | 2 +- .../nuiton/topia/templates/EntityTransformer.java | 8 +- .../nuiton/topia/templates/TopiaGeneratorUtil.java | 34 +++-- .../nuiton/topia/templates/TopiaJavaValidator.java | 2 +- .../nuiton/topia/templates/TopiaStereoTypes.java | 1 + .../org/nuiton/topia/templates/TopiaTagValues.java | 151 ++++++++++++--------- .../topia/templates/TopiaTemplateHelper.java | 23 ++-- .../org/nuiton/topia/templates/package-info.java | 2 +- 9 files changed, 127 insertions(+), 100 deletions(-) diff --git a/topia-templates/src/main/java/org/nuiton/topia/templates/EntityDaoTransformer.java b/topia-templates/src/main/java/org/nuiton/topia/templates/EntityDaoTransformer.java index 82b6b57..0cba1c8 100644 --- a/topia-templates/src/main/java/org/nuiton/topia/templates/EntityDaoTransformer.java +++ b/topia-templates/src/main/java/org/nuiton/topia/templates/EntityDaoTransformer.java @@ -63,7 +63,7 @@ import java.util.Set; import java.util.TreeMap; /** - * To generate all <code>DAO</code> related classes for a given entity. + * To generate all {@code DAO} related classes for a given entity. * * @author Tony Chemit - chemit@codelutin.com * @since 2.5.4 @@ -77,7 +77,7 @@ public class EntityDaoTransformer extends ObjectModelTransformerToJava { /** * map of direct usages (values) for each entity (key). - * <p/> + * * This map is used to generate the findUsages methods for DAOAbstract. */ protected Map<ObjectModelClass, Set<ObjectModelClass>> usages; diff --git a/topia-templates/src/main/java/org/nuiton/topia/templates/EntityHibernateMappingGenerator.java b/topia-templates/src/main/java/org/nuiton/topia/templates/EntityHibernateMappingGenerator.java index c3f3868..1cded91 100644 --- a/topia-templates/src/main/java/org/nuiton/topia/templates/EntityHibernateMappingGenerator.java +++ b/topia-templates/src/main/java/org/nuiton/topia/templates/EntityHibernateMappingGenerator.java @@ -54,7 +54,7 @@ import java.util.TreeMap; /** * - * @author poussin <poussin@codelutin.com> + * @author Benjamin Poussin - poussin@codelutin.com * @plexus.component role="org.nuiton.eugene.Template" role-hint="org.nuiton.topia.templates.EntityHibernateMappingGenerator" */ public class EntityHibernateMappingGenerator extends ObjectModelGenerator { diff --git a/topia-templates/src/main/java/org/nuiton/topia/templates/EntityTransformer.java b/topia-templates/src/main/java/org/nuiton/topia/templates/EntityTransformer.java index bea9385..996da47 100644 --- a/topia-templates/src/main/java/org/nuiton/topia/templates/EntityTransformer.java +++ b/topia-templates/src/main/java/org/nuiton/topia/templates/EntityTransformer.java @@ -358,8 +358,8 @@ public class EntityTransformer extends ObjectModelTransformerToJava { /** * Ajout les methodes necessaire à l'interface {@link TopiaEntityContextable} * si le tagValue {@link TopiaTagValues#TAG_CONTEXTABLE} est renseigné. - * @param input - * @param outputAbstract + * @param input FIXME + * @param outputAbstract FIXME */ protected void addContextableMethods(ObjectModelClass input, ObjectModelClass outputAbstract) { @@ -582,8 +582,8 @@ public class EntityTransformer extends ObjectModelTransformerToJava { * Generate properties from {@code attributes}. Generate * constant, attribute and operations for each property. * @param attributes Input attributes - * @param aClass - * @param aPackage + * @param aClass FIXME + * @param aPackage FIXME */ protected void generateProperties(Collection<ObjectModelAttribute> attributes, ObjectModelClassifier aClass, ObjectModelPackage aPackage) { for (ObjectModelAttribute attribute : attributes) { diff --git a/topia-templates/src/main/java/org/nuiton/topia/templates/TopiaGeneratorUtil.java b/topia-templates/src/main/java/org/nuiton/topia/templates/TopiaGeneratorUtil.java index f335bff..76b16df 100644 --- a/topia-templates/src/main/java/org/nuiton/topia/templates/TopiaGeneratorUtil.java +++ b/topia-templates/src/main/java/org/nuiton/topia/templates/TopiaGeneratorUtil.java @@ -27,7 +27,6 @@ package org.nuiton.topia.templates; import com.google.common.base.Joiner; import com.google.common.base.Preconditions; import com.google.common.collect.Lists; - import org.apache.commons.collections4.CollectionUtils; import org.apache.commons.lang3.StringUtils; import org.apache.commons.logging.Log; @@ -66,13 +65,13 @@ import java.util.TreeMap; /** * Classe regroupant divers méthodes utiles pour la génération des entités - * <p/> + * * Created: 13 déc. 2005 * * @author Arnaud Thimel (Code Lutin) - * @author tchemit <tchemit@codelutin.com> - * @author fdesbois <fdesbois@codelutin.com> - * @author chatellier <chatellier@codelutin.com> + * @author Tony Chemit - tchemit@codelutin.com + * @author Florian Desbois- fdebois@codelutin.com + * @author Éric Chatellier - chatellier@codelutin.com * @deprecated since 3.0, prefer use {@link TopiaTemplateHelper}. */ @Deprecated @@ -257,7 +256,7 @@ public class TopiaGeneratorUtil extends JavaGeneratorUtil { /** * Obtain the reverse db name of an attribute. - * <p/> + * * If attribute has a specific reverse attribute, use his db name, otherwise * suffix the db name of the attribute by {@code _id}. * @@ -490,7 +489,7 @@ public class TopiaGeneratorUtil extends JavaGeneratorUtil { * - cette relation est unidirectionnelle * - le type de l'attribut représente un entité * - cette entité a des sous-classes dans le modèle - * <p/> + * * Ce cas correspond à une incompatibilité d'Hibernate qui nous oblige a * adopter un comportement particulier. * </p> @@ -524,10 +523,7 @@ public class TopiaGeneratorUtil extends JavaGeneratorUtil { /** * Renvoie le nom unique de table pour une relation ManyToMany en fonction - * de l'attribut <code>attr</code> - * <p/> - * Plusieurs cas de figure: - * <li> + * de l'attribut {@code attr} * * @param attr l'attribut servant de base au calcul du nom * @return le nom de la table @@ -904,6 +900,10 @@ public class TopiaGeneratorUtil extends JavaGeneratorUtil { } /** + * @param <Type> FIXME + * @param elements FIXME + * @param stereotypes FIXME + * @return FIXME * @deprecated since 3.0, not used anywhere in ToPIA */ @Deprecated @@ -919,6 +919,9 @@ public class TopiaGeneratorUtil extends JavaGeneratorUtil { } /** + * @param element FIXME + * @param stereotypes FIXME + * @return FIXME * @deprecated since 3.0, not used anywhere in ToPIA */ @Deprecated @@ -933,6 +936,9 @@ public class TopiaGeneratorUtil extends JavaGeneratorUtil { } /** + * @param clazz FIXME + * @param includeName FIXME + * @return FIXME * @deprecated since 3.0, not used anywhere in ToPIA */ @Deprecated @@ -955,11 +961,13 @@ public class TopiaGeneratorUtil extends JavaGeneratorUtil { } /** + * @param attr FIXME + * @return FIXME * @deprecated since 3.0, not used anywhere in ToPIA */ @Deprecated public static boolean isAssociationClassDoublon(ObjectModelAttribute attr) { - return attr.getReverseAttribute() != null && + return attr.getReverseAttribute() != null && attr.getDeclaringElement().equals( attr.getReverseAttribute().getDeclaringElement()) && !GeneratorUtil.isFirstAttribute(attr); @@ -1018,7 +1026,7 @@ public class TopiaGeneratorUtil extends JavaGeneratorUtil { /** * Obtain the class to use as abstract dao. - * <p/> + * * It will look after a tag value {@link TopiaTagValues#TAG_DAO_IMPLEMENTATION} in model * and if not found will use the default value which is {@link AbstractTopiaDao}. * diff --git a/topia-templates/src/main/java/org/nuiton/topia/templates/TopiaJavaValidator.java b/topia-templates/src/main/java/org/nuiton/topia/templates/TopiaJavaValidator.java index 914f454..c9eb9eb 100644 --- a/topia-templates/src/main/java/org/nuiton/topia/templates/TopiaJavaValidator.java +++ b/topia-templates/src/main/java/org/nuiton/topia/templates/TopiaJavaValidator.java @@ -42,7 +42,7 @@ import java.util.Set; * - les nom des attributs * - les duplication d'attibuts * - * @author chatellier <chatellier@codelutin.com> + * @author Éric Chatellier - chatellier@codelutin.com */ public class TopiaJavaValidator extends ObjectModelValidator { diff --git a/topia-templates/src/main/java/org/nuiton/topia/templates/TopiaStereoTypes.java b/topia-templates/src/main/java/org/nuiton/topia/templates/TopiaStereoTypes.java index 5744dca..01af013 100644 --- a/topia-templates/src/main/java/org/nuiton/topia/templates/TopiaStereoTypes.java +++ b/topia-templates/src/main/java/org/nuiton/topia/templates/TopiaStereoTypes.java @@ -63,6 +63,7 @@ public class TopiaStereoTypes extends StereotypeDefinitionProvider { /** * Check if the given classifier has the {@link TopiaStereoTypes#STEREOTYPE_ENTITY} stereotype. * + * @param aPackage FIXME * @param classifier classifier to test * @return {@code true} if stereotype was found, {@code false otherwise} * @see TopiaStereoTypes#STEREOTYPE_ENTITY diff --git a/topia-templates/src/main/java/org/nuiton/topia/templates/TopiaTagValues.java b/topia-templates/src/main/java/org/nuiton/topia/templates/TopiaTagValues.java index b28becb..53430c6 100644 --- a/topia-templates/src/main/java/org/nuiton/topia/templates/TopiaTagValues.java +++ b/topia-templates/src/main/java/org/nuiton/topia/templates/TopiaTagValues.java @@ -70,7 +70,7 @@ public class TopiaTagValues extends TagValueDefinitionProvider { * @since 2.5 */ @TagValueDefinition(target = {ObjectModelClassifier.class}, - documentation = "TODO") + documentation = "TODO") public static final String TAG_PERSISTENCE_TYPE = "persistenceType"; /** @@ -91,7 +91,7 @@ public class TopiaTagValues extends TagValueDefinitionProvider { * @see TopiaTemplateHelper#getReverseDbName(ObjectModelAttribute) */ @TagValueDefinition(target = {ObjectModelElement.class}, - documentation = "Sets the database name of an element of the model (a table or a column)") + documentation = "Sets the database name of an element of the model (a table or a column)") public static final String TAG_DB_NAME = "dbName"; /** @@ -100,7 +100,7 @@ public class TopiaTagValues extends TagValueDefinitionProvider { * @see TopiaTemplateHelper#getReverseDbName(ObjectModelAttribute) */ @TagValueDefinition(target = {ObjectModelAttribute.class}, - documentation = "Sets the database name of the reverse db name attribute of the model (a column)") + documentation = "Sets the database name of the reverse db name attribute of the model (a column)") public static final String TAG_REVERSE_DB_NAME = "reverseDbName"; /** @@ -111,7 +111,7 @@ public class TopiaTagValues extends TagValueDefinitionProvider { * @since 2.9.2 */ @TagValueDefinition(target = {ObjectModelAttribute.class}, - documentation = "Sets the database table name of a many to many relation for a attribute of the model") + documentation = "Sets the database table name of a many to many relation for a attribute of the model") public static final String TAG_MANY_TO_MANY_TABLE_NAME = "manyToManyTableName"; /** @@ -121,7 +121,7 @@ public class TopiaTagValues extends TagValueDefinitionProvider { * @since 2.5 */ @TagValueDefinition(target = {ObjectModel.class, ObjectModelPackage.class, ObjectModelClassifier.class, ObjectModelAttribute.class}, - documentation = "Sets the database schema name") + documentation = "Sets the database schema name") public static final String TAG_SCHEMA_NAME = "dbSchema"; /** @@ -131,7 +131,7 @@ public class TopiaTagValues extends TagValueDefinitionProvider { * @since 2.5 */ @TagValueDefinition(target = {ObjectModelAttribute.class}, - documentation = "Sets the length of an attribute in database") + documentation = "Sets the length of an attribute in database") public static final String TAG_LENGTH = "length"; /** @@ -141,7 +141,7 @@ public class TopiaTagValues extends TagValueDefinitionProvider { * @since 2.5 */ @TagValueDefinition(target = {ObjectModelAttribute.class}, - documentation = "Sets an annotation of an attribute") + documentation = "Sets an annotation of an attribute") public static final String TAG_ANNOTATION = "annotation"; /** @@ -151,7 +151,7 @@ public class TopiaTagValues extends TagValueDefinitionProvider { * @since 2.5 */ @TagValueDefinition(target = {ObjectModelAttribute.class}, - documentation = "Sets the access type of an attribute (Hibernate mapping)") + documentation = "Sets the access type of an attribute (Hibernate mapping)") public static final String TAG_ACCESS = "access"; /** @@ -161,7 +161,7 @@ public class TopiaTagValues extends TagValueDefinitionProvider { * @since 2.5 */ @TagValueDefinition(target = {ObjectModelAttribute.class}, - documentation = "Sets an attribute as part of a natural id (Hibernate Mapping)") + documentation = "Sets an attribute as part of a natural id (Hibernate Mapping)") public static final String TAG_NATURAL_ID = "naturalId"; /** @@ -171,7 +171,7 @@ public class TopiaTagValues extends TagValueDefinitionProvider { * @since 2.5 */ @TagValueDefinition(target = {ObjectModelClassifier.class}, - documentation = "Sets if natural id of a entity is mutable (hibernate mapping)") + documentation = "Sets if natural id of a entity is mutable (hibernate mapping)") public static final String TAG_NATURAL_ID_MUTABLE = "naturalIdMutable"; /** @@ -185,7 +185,7 @@ public class TopiaTagValues extends TagValueDefinitionProvider { * @since 2.5 */ @TagValueDefinition(target = {ObjectModelAttribute.class}, - documentation = "Sets which part of a N-N relation is master (inverse=true) and slave (inverse=false) (must be put on each side on a such relation) (Hibernate mapping)") + documentation = "Sets which part of a N-N relation is master (inverse=true) and slave (inverse=false) (must be put on each side on a such relation) (Hibernate mapping)") public static final String TAG_INVERSE = "inverse"; /** @@ -195,7 +195,7 @@ public class TopiaTagValues extends TagValueDefinitionProvider { * @since 2.5 */ @TagValueDefinition(target = {ObjectModelAttribute.class}, - documentation = "Sets if an association should be lazy (Hibernate mapping)") + documentation = "Sets if an association should be lazy (Hibernate mapping)") public static final String TAG_LAZY = "lazy"; /** @@ -205,7 +205,7 @@ public class TopiaTagValues extends TagValueDefinitionProvider { * @since 2.5 */ @TagValueDefinition(target = {ObjectModelAttribute.class}, - documentation = "Sets the fetch caracteristic of an attribute (Hibernate mapping)") + documentation = "Sets the fetch caracteristic of an attribute (Hibernate mapping)") public static final String TAG_FETCH = "fetch"; /** @@ -215,7 +215,7 @@ public class TopiaTagValues extends TagValueDefinitionProvider { * @since 2.5 */ @TagValueDefinition(target = {ObjectModelAttribute.class}, - documentation = "Sets the order by propertie of an multiple association (Hibernate mapping)") + documentation = "Sets the order by propertie of an multiple association (Hibernate mapping)") public static final String TAG_ORDER_BY = "orderBy"; /** @@ -225,7 +225,7 @@ public class TopiaTagValues extends TagValueDefinitionProvider { * @since 2.5 */ @TagValueDefinition(target = {ObjectModelAttribute.class}, - documentation = "Sets if an attribute must be not null (Hibernate mapping)") + documentation = "Sets if an attribute must be not null (Hibernate mapping)") public static final String TAG_NOT_NULL = "notNull"; /** @@ -238,39 +238,39 @@ public class TopiaTagValues extends TagValueDefinitionProvider { * @since 3.0 */ @TagValueDefinition(target = {ObjectModel.class, ObjectModelPackage.class, ObjectModelClassifier.class, ObjectModelAttribute.class}, - documentation = "'true' if the value of this attribute of type Enumeration should be stored with its name (instead of using ordinal)", - defaultValue = "true") + documentation = "'true' if the value of this attribute of type Enumeration should be stored with its name (instead of using ordinal)", + defaultValue = "true") public static final String TAG_USE_ENUMERATION_NAME = "useEnumerationName"; /** * Tag pour configurer l'interface du proxy sur autre chose que l'implementation par defaut. - * <p/> + * * Par defaut : - * null > generere le proxy sur l'interface de l'implementation + * null → generere le proxy sur l'interface de l'implementation * Autre valeur : - * "none" > laisse la configuration par defaut d'hibernate + * "none" → laisse la configuration par defaut d'hibernate * * @see #getPersistenceTypeTagValue(ObjectModelClassifier) * @since 2.5 */ @TagValueDefinition(target = {ObjectModel.class, ObjectModelPackage.class, ObjectModelClassifier.class}, - documentation = "Configure the proxy interface on something else than the default implementation (null to use our default implementation, none to let hibernate deal it) (Hibernate mapping)") + documentation = "Configure the proxy interface on something else than the default implementation (null to use our default implementation, none to let hibernate deal it) (Hibernate mapping)") public static final String TAG_PROXY_INTERFACE = "hibernateProxyInterface"; /** * Tag pour configurer la stategie d'heritage choisie. - * <p/> + * * Par defaut : union-subclass : Table per class strategy * Autre valeur : - * "subclass" > Single table per class hierarchy strategy - * "joined-subclass" > Joined subclass strategy + * "subclass" → Single table per class hierarchy strategy + * "joined-subclass" → Joined subclass strategy * * @see #getPersistenceTypeTagValue(ObjectModelClassifier) * @since 3.0 */ @TagValueDefinition(target = {ObjectModel.class, ObjectModelPackage.class, ObjectModelClassifier.class}, - documentation = "Configure the proxy interface on something else than the default implementation (null to use our default implementation, none to let hibernate deal it) (Hibernate mapping)", - defaultValue = "union-subclass") + documentation = "Configure the proxy interface on something else than the default implementation (null to use our default implementation, none to let hibernate deal it) (Hibernate mapping)", + defaultValue = "union-subclass") public static final String TAG_INHERITANCE_STRATEGY = "inheritanceStrategy"; /** @@ -280,8 +280,8 @@ public class TopiaTagValues extends TagValueDefinitionProvider { * @since 2.5 */ @TagValueDefinition(target = {ObjectModel.class, ObjectModelPackage.class, ObjectModelClassifier.class}, - defaultValue = "true", - documentation = "Tag to skip toString() methods generation on entities.") + defaultValue = "true", + documentation = "Tag to skip toString() methods generation on entities.") public static final String TAG_NOT_GENERATE_TO_STRING = "notGenerateToString"; /** @@ -291,7 +291,7 @@ public class TopiaTagValues extends TagValueDefinitionProvider { * @since 2.5 */ @TagValueDefinition(target = {ObjectModel.class, ObjectModelPackage.class, ObjectModelClassifier.class}, - documentation = "To sort attribute while generation") + documentation = "To sort attribute while generation") public static final String TAG_SORT_ATTRIBUTE = "sortAttribute"; /** @@ -301,7 +301,7 @@ public class TopiaTagValues extends TagValueDefinitionProvider { * @since 2.5 */ @TagValueDefinition(target = {ObjectModel.class}, - documentation = "To generate EntityOperation on generated DAOHelper") + documentation = "To generate EntityOperation on generated DAOHelper") public static final String TAG_GENERATE_OPERATOR_FOR_DAO_HELPER = "generateOperatorForDAOHelper"; /** @@ -314,7 +314,7 @@ public class TopiaTagValues extends TagValueDefinitionProvider { */ @Deprecated @TagValueDefinition(target = {ObjectModelAttribute.class}, - documentation = "Sets the hibernate type of an attribute (Hibernate mapping)") + documentation = "Sets the hibernate type of an attribute (Hibernate mapping)") public static final String TAG_TYPE = "type"; /** @@ -324,21 +324,21 @@ public class TopiaTagValues extends TagValueDefinitionProvider { * @since 2.5 */ @TagValueDefinition(target = {ObjectModelAttribute.class}, - documentation = "Sets the sql type of an attribute (Hibernate mapping)") + documentation = "Sets the sql type of an attribute (Hibernate mapping)") public static final String TAG_SQL_TYPE = "sqlType"; /** * To specify the abstract dao to use. - * <p/> + * * If none given, will use the {@code org.nuiton.topia.persistence.TopiaDAOImpl}. - * <p/> + * * Other value possible is {@code org.nuiton.topia.persistence.TopiaDAOLegacy} * * @see #getDaoImplementationTagValue(ObjectModel) * @since 2.5 */ @TagValueDefinition(target = {ObjectModel.class}, - documentation = "Sets the fully qualified name of the DAO implementation to use in generated DAO (default is DAOImpl (base on TopiaQuery))") + documentation = "Sets the fully qualified name of the DAO implementation to use in generated DAO (default is DAOImpl (base on TopiaQuery))") public static final String TAG_DAO_IMPLEMENTATION = "daoImplementation"; /** @@ -348,8 +348,8 @@ public class TopiaTagValues extends TagValueDefinitionProvider { * @since 2.6.5 */ @TagValueDefinition(target = {ObjectModel.class, ObjectModelPackage.class, ObjectModelAttribute.class}, - defaultValue = "true", - documentation = "Specifies if an nm-multiplicity attribute (or all nm-multiplicity attributes of a given model) needs an index in db (Hibernate mapping)") + defaultValue = "true", + documentation = "Specifies if an nm-multiplicity attribute (or all nm-multiplicity attributes of a given model) needs an index in db (Hibernate mapping)") public static final String TAG_INDEX_FOREIGN_KEYS = "indexForeignKeys"; /** @@ -365,7 +365,7 @@ public class TopiaTagValues extends TagValueDefinitionProvider { /** * Tag to specify a super class to use instead of * {@link org.nuiton.topia.persistence.internal.AbstractTopiaPersistenceContext}. - * <p/> + * * <strong>Note:</strong> the class must implements * {@link org.nuiton.topia.persistence.internal.AbstractTopiaPersistenceContext}. * @@ -374,13 +374,13 @@ public class TopiaTagValues extends TagValueDefinitionProvider { * @since 3.0 */ @TagValueDefinition(target = {ObjectModel.class}, - documentation = "Change the super class to use when generating PersistenceContext.") + documentation = "Change the super class to use when generating PersistenceContext.") public static final String TAG_PERSISTENCE_CONTEXT_SUPER_CLASS = "persistenceContextSuperClass"; /** * Tag to specify a super class to use instead of * {@link org.nuiton.topia.persistence.internal.AbstractTopiaApplicationContext}. - * <p/> + * * <strong>Note:</strong> the class must implement * {@link org.nuiton.topia.persistence.internal.AbstractTopiaApplicationContext}. * @@ -389,12 +389,12 @@ public class TopiaTagValues extends TagValueDefinitionProvider { * @since 3.0 */ @TagValueDefinition(target = {ObjectModel.class}, - documentation = "Change the super class to use when generating ApplicationContext.") + documentation = "Change the super class to use when generating ApplicationContext.") public static final String TAG_APPLICATION_CONTEXT_SUPER_CLASS = "applicationContextSuperClass"; /** * Tag to specify a super class to use instead of {@link org.nuiton.topia.persistence.internal.AbstractTopiaDao}. - * <p/> + * * <strong>Note:</strong> the class must implements {@link org.nuiton.topia.persistence.TopiaDao}. * * @see org.nuiton.topia.persistence.internal.AbstractTopiaDao @@ -402,12 +402,12 @@ public class TopiaTagValues extends TagValueDefinitionProvider { * @since 3.0 */ @TagValueDefinition(target = {ObjectModelClassifier.class, ObjectModelPackage.class, ObjectModel.class}, - documentation = "Change the super class to use when generating dao.") + documentation = "Change the super class to use when generating dao.") public static final String TAG_DAO_SUPER_CLASS = "daoSuperClass"; /** * Tag to specify a super class to use instead of {@link org.nuiton.topia.persistence.internal.AbstractTopiaEntity}. - * <p/> + * * <strong>Note:</strong> the class must implements {@link TopiaEntity}. * * @see TopiaEntity @@ -415,58 +415,59 @@ public class TopiaTagValues extends TagValueDefinitionProvider { * @since 3.0 */ @TagValueDefinition(target = {ObjectModelClassifier.class, ObjectModelPackage.class, ObjectModel.class}, - documentation = "Change the super class to use when generating Entity.") + documentation = "Change the super class to use when generating Entity.") public static final String TAG_ENTITY_SUPER_CLASS = "entitySuperClass"; /** * Tag to change the type of an attribute in a hibernate mapping. - * <p/> + * * This is a special tagValue that is dynamic. - * <p/> + * * For example to change the type {@code String} into hibernate mapping type {@code text}, add this: * <pre> * model.tagValue.hibernateAttributeType.String=text * </pre> - * <p/> + * * Before 3.0, you could do the same thing using: * <pre> * model.tagValue.String=text * </pre> - * <p/> + * * The new way permits us to validate the usage of the tagValue, old way can't. * * @see #getHibernateAttributeType(ObjectModelAttribute, ObjectModelClassifier, ObjectModelPackage, ObjectModel) * @since 3.0 */ @TagValueDefinition(target = {ObjectModelAttribute.class, ObjectModelPackage.class, ObjectModelClassifier.class, ObjectModel.class}, - documentation = "Change the super class to use when generating Entity.", - matcherClass = StartsWithTagNameMatcher.class) + documentation = "Change the super class to use when generating Entity.", + matcherClass = StartsWithTagNameMatcher.class) public static final String TAG_HIBERNATE_ATTRIBUTE_TYPE = "hibernateAttributeType"; /** * Tag to change the type of an attribute. - * <p/> + * * This is a special tagValue that is dynamic. - * <p/> + * * For example to change the type {@code String} into type {@code java.lang.String}, add this: * <pre> * model.tagValue.attributeType.String=java.lang.String * </pre> - * <p/> + * * Before 3.0, you could do the same thing using: * <pre> * model.tagValue.String=java.lang.String * </pre> - * <p/> + * * The new way permits us to validate the usage of the tagValue, old way can't. * * @see #getHibernateAttributeType(ObjectModelAttribute, ObjectModelClassifier, ObjectModelPackage, ObjectModel) * @since 3.0 */ @TagValueDefinition(target = {ObjectModelAttribute.class, ObjectModelPackage.class, ObjectModelClassifier.class, ObjectModel.class}, - documentation = "Change an attribute type.", - matcherClass = StartsWithTagNameMatcher.class) + documentation = "Change an attribute type.", + matcherClass = StartsWithTagNameMatcher.class) public static final String TAG_ATTRIBUTE_TYPE = "attributeType"; + /** * Tag to specify if PropertyChangeListener support should be generated * @@ -508,7 +509,7 @@ public class TopiaTagValues extends TagValueDefinitionProvider { /** * Obtain the value of the {@link #TAG_DB_NAME} tag value on the given element. - * <p/> + * * <strong>Note:</strong> We just try a direct search on the element and do not * walk through his declaring elements if not found (see https://forge.nuiton.org/issues/2342). * @@ -527,7 +528,8 @@ public class TopiaTagValues extends TagValueDefinitionProvider { * * @param classifier classifier to seek * @param aPackage package to seek - * @param model model to seek @return the none empty value of the found tag value or {@code null} if not found nor empty. + * @param model model to seek + * @return the none empty value of the found tag value or {@code null} if not found nor empty. * @see #TAG_SCHEMA_NAME * @since 2.5 */ @@ -539,7 +541,7 @@ public class TopiaTagValues extends TagValueDefinitionProvider { /** * Obtain the value of the {@link TopiaTagValues#TAG_MANY_TO_MANY_TABLE_NAME} * tag value on the given attribute. - * <p/> + * * * Note that it won't and search on declaring element or anywhere else than on the given element. * See https://forge.nuiton.org/issues/2342 @@ -623,6 +625,7 @@ public class TopiaTagValues extends TagValueDefinitionProvider { * Obtain the value of the {@link #TAG_CONTEXTABLE} tag value on the given classifier or model. * * @param classifier classifier to seek + * @param aPackage FIXME * @param model model to seek * @return the boolean value of the found tag value or {@code false} if not found nor empty. * @see #TAG_CONTEXTABLE @@ -702,6 +705,7 @@ public class TopiaTagValues extends TagValueDefinitionProvider { * Obtain the value of the {@link #TAG_PROXY_INTERFACE} tag value on the given classifier. * * @param classifier classifier to seek + * @param aPackage FIXME * @param model model to seek * @return the none empty value of the found tag value or {@code null} if not found nor empty. * @see #TAG_PROXY_INTERFACE @@ -715,8 +719,9 @@ public class TopiaTagValues extends TagValueDefinitionProvider { /** * Obtain the value of the {@link #TAG_NOT_GENERATE_TO_STRING} tag value on the given class. * - * @param clazz class to seek - * @param model model to seek + * @param clazz class to seek + * @param aPackage FIXME + * @param model model to seek * @return the none empty value of the found tag value or {@code null} if not found nor empty. * @see #TAG_NOT_GENERATE_TO_STRING * @since 2.5 @@ -730,6 +735,7 @@ public class TopiaTagValues extends TagValueDefinitionProvider { * Obtain the value of the {@link #TAG_SORT_ATTRIBUTE} tag value on the given classifier. * * @param classifier classifier to seek + * @param aPackage FIXME * @param model model to seek * @return the none empty value of the found tag value or {@code null} if not found nor empty. * @see #TAG_SORT_ATTRIBUTE @@ -754,7 +760,7 @@ public class TopiaTagValues extends TagValueDefinitionProvider { */ public boolean isGenerateForeignKeyNames(ObjectModelClassifier classifier, ObjectModel model) { boolean value = findBooleanTagValue(TAG_GENERATE_FOREIGN_KEY_NAMES, classifier, model); - return value ; + return value; } protected static final Map<String, String> HIBERNATE_ATTRIBUTE_TYPE_DEFAULT_VALUES = Maps.newHashMap(); @@ -780,7 +786,10 @@ public class TopiaTagValues extends TagValueDefinitionProvider { /** * Obtain the value of the {@link #TAG_HIBERNATE_ATTRIBUTE_TYPE} tag value on the given attribute, classifier or model. * - * @param attribute attribute to seek + * @param attribute attribute to seek + * @param aPackage FIXME + * @param model FIXME + * @param classifier FIXME * @return the none empty value of the found tag value or {@code null} if not found nor empty. * @see #TAG_HIBERNATE_ATTRIBUTE_TYPE * @since 3.0 @@ -800,7 +809,10 @@ public class TopiaTagValues extends TagValueDefinitionProvider { /** * Obtain the value of the {@link #TAG_ATTRIBUTE_TYPE} tag value on the given attribute, classifier or model. * - * @param attribute attribute to seek + * @param attribute attribute to seek + * @param aPackage FIXME + * @param model FIXME + * @param classifier FIXME * @return the none empty value of the found tag value or {@code null} if not found nor empty. * @see #TAG_ATTRIBUTE_TYPE * @since 3.0.1 @@ -848,6 +860,7 @@ public class TopiaTagValues extends TagValueDefinitionProvider { * * @param attribute attribute to test * @param model model to test + * @param aPackage FIXME * @return none empty value of the found tag value or {@code null} if not found nor empty. * @see #TAG_INDEX_FOREIGN_KEYS * @since 2.6.5 @@ -892,7 +905,9 @@ public class TopiaTagValues extends TagValueDefinitionProvider { /** * Obtains the value of the {@link #TAG_DAO_SUPER_CLASS} tag value on the given classifier or on the model. * - * @param model model to seek + * @param model model to seek + * @param aPackage FIXME + * @param classifier FIXME * @return the none empty value of the found tag value or {@code null} if not found nor empty. * @see #TAG_DAO_SUPER_CLASS * @since 3.0 @@ -905,7 +920,9 @@ public class TopiaTagValues extends TagValueDefinitionProvider { /** * Obtains the value of the {@link #TAG_ENTITY_SUPER_CLASS} tag value on the given classifier or on the model. * - * @param model model to seek + * @param model model to seek + * @param aPackage FIXME + * @param classifier FIXME * @return the none empty value of the found tag value or {@code null} if not found nor empty. * @see #TAG_ENTITY_SUPER_CLASS * @since 3.0 diff --git a/topia-templates/src/main/java/org/nuiton/topia/templates/TopiaTemplateHelper.java b/topia-templates/src/main/java/org/nuiton/topia/templates/TopiaTemplateHelper.java index ec57837..a17e749 100644 --- a/topia-templates/src/main/java/org/nuiton/topia/templates/TopiaTemplateHelper.java +++ b/topia-templates/src/main/java/org/nuiton/topia/templates/TopiaTemplateHelper.java @@ -64,10 +64,10 @@ import java.util.TreeMap; /** * Classe regroupant divers méthodes utiles pour la génération des entités. - * <p/> + * * Remplace {@code TopiageneratorUtil} car on ne veut plus utiliser de méthodes * statiques (par exemple pour avoir les valeurs par défaut des tagValues,...). - * <p/> + * * Created on 7/6/14. * * @author Tony Chemit - chemit@codelutin.com @@ -244,7 +244,7 @@ public class TopiaTemplateHelper { /** * Obtain the reverse db name of an attribute. - * <p/> + * * Try first to get the reverse db Name from the reverseDbname tag-value, then * if attribute has a specific reverse attribute, use his db name, otherwise * suffix the db name of the attribute by {@code _id}. @@ -288,10 +288,11 @@ public class TopiaTemplateHelper { * * <strong>Note that the reverse attribute can't be null here.</strong> * <ul> - * <li>Try first to get the reverse db Name from the ReverseDbname tag-value</li> - * <li>If not found, try then the ReverseDbname tag-value on the same attribute but from this other side of the relation</li> - * <li>If not found, try then just get the name of the reverse attribute</li> + * <li>Try first to get the reverse db Name from the ReverseDbname tag-value</li> + * <li>If not found, try then the ReverseDbname tag-value on the same attribute but from this other side of the relation</li> + * <li>If not found, try then just get the name of the reverse attribute</li> * </ul> + * * @param attr the attribute to seek * @return the value of the reverse db name on the reverse attribute * @since 2.9.5.2 @@ -517,7 +518,7 @@ public class TopiaTemplateHelper { * - cette relation est unidirectionnelle * - le type de l'attribut représente un entité * - cette entité a des sous-classes dans le modèle - * <p/> + * * Ce cas correspond à une incompatibilité d'Hibernate qui nous oblige a * adopter un comportement particulier. * </p> @@ -552,10 +553,7 @@ public class TopiaTemplateHelper { /** * Renvoie le nom unique de table pour une relation ManyToMany en fonction - * de l'attribut <code>attr</code> - * <p/> - * Plusieurs cas de figure: - * <li> + * de l'attribut {@code attr} * * @param attr l'attribut servant de base au calcul du nom * @return le nom de la table @@ -931,6 +929,7 @@ public class TopiaTemplateHelper { return collectionType; } + public Class<?> getCollectionInstanceType(ObjectModelAttribute attribute) { boolean unique = EugeneStereoTypes.hasUniqueStereotype(attribute); @@ -965,6 +964,8 @@ public class TopiaTemplateHelper { /** * dependency to add extra operations for entity dao. * + * @param input FIXME + * @return FIXME * @since 2.3.4 * @deprecated only used for warn to help migration to 3.0, should be deleted */ diff --git a/topia-templates/src/main/java/org/nuiton/topia/templates/package-info.java b/topia-templates/src/main/java/org/nuiton/topia/templates/package-info.java index 676b67c..fe38534 100644 --- a/topia-templates/src/main/java/org/nuiton/topia/templates/package-info.java +++ b/topia-templates/src/main/java/org/nuiton/topia/templates/package-info.java @@ -88,7 +88,7 @@ * méthodes l'utilise dans les signatures de méthode lorsqu'il y a un * lien entre deux entités.</p> * - * @author poussin <poussin@codelutin.com> + * @author Benjamin Poussin - poussin@codelutin.com */ package org.nuiton.topia.templates; -- To stop receiving notification emails like this one, please contact nuiton.org SCM administrator <admin+scm@nuiton.org>.
This is an automated email from the git hooks/post-receive script. New commit to branch feature/3858_javadoc_jdk8 in repository topia. See http://git.nuiton.org/topia.git commit d73ad89cf96f5802a0293117d6c13c85fa35acfc Author: Tony CHEMIT <chemit@codelutin.com> Date: Wed Dec 30 16:36:52 2015 +0100 Fix javadoc in service replication module (See #3858) --- .../topia/replication/TopiaReplicationContext.java | 4 ++-- .../replication/TopiaReplicationModelBuilder.java | 12 +++++------ .../replication/TopiaReplicationOperation.java | 14 ++++++------- .../TopiaReplicationOperationProvider.java | 2 +- .../TopiaReplicationOperationUndoable.java | 4 ++-- .../topia/replication/TopiaReplicationService.java | 24 +++++++++++----------- .../topia/replication/model/ReplicationLink.java | 6 +++--- .../topia/replication/model/ReplicationModel.java | 2 +- .../topia/replication/model/ReplicationNode.java | 2 +- .../replication/model/ReplicationOperationDef.java | 8 ++++---- .../model/ReplicationOperationPhase.java | 2 +- .../topia/replication/operation/AttachLink.java | 14 ++++++------- .../replication/operation/DettachAssociation.java | 2 +- .../topia/replication/operation/Duplicate.java | 2 +- .../topia/replication/operation/LoadLink.java | 2 +- .../AbstractTopiaReplicationServiceTest.java | 2 +- .../replication/TopiaReplicationOperationTest.java | 2 +- .../TopiaReplicationServiceImplAllTest.java | 2 +- .../TopiaReplicationServiceImplTest.java | 12 +++++------ 19 files changed, 59 insertions(+), 59 deletions(-) diff --git a/topia-service-replication/src/main/java/org/nuiton/topia/replication/TopiaReplicationContext.java b/topia-service-replication/src/main/java/org/nuiton/topia/replication/TopiaReplicationContext.java index 414e4ff..b605854 100644 --- a/topia-service-replication/src/main/java/org/nuiton/topia/replication/TopiaReplicationContext.java +++ b/topia-service-replication/src/main/java/org/nuiton/topia/replication/TopiaReplicationContext.java @@ -43,7 +43,7 @@ import java.util.List; /** * Defines the context used to replicate. - * <p/> + * * It contains : * <ul> * <li>the {@link #replicationModel}</li> @@ -131,7 +131,7 @@ public class TopiaReplicationContext { /** * Init the replication context. - * <p/> + * * Comptute the universe to replicate and store it in {@link #data}. * * @throws TopiaException for any error when initializing the replication context diff --git a/topia-service-replication/src/main/java/org/nuiton/topia/replication/TopiaReplicationModelBuilder.java b/topia-service-replication/src/main/java/org/nuiton/topia/replication/TopiaReplicationModelBuilder.java index 069ee47..c8a39eb 100644 --- a/topia-service-replication/src/main/java/org/nuiton/topia/replication/TopiaReplicationModelBuilder.java +++ b/topia-service-replication/src/main/java/org/nuiton/topia/replication/TopiaReplicationModelBuilder.java @@ -64,7 +64,7 @@ public class TopiaReplicationModelBuilder { /** * Prepare le modele de replication pour les entites données dans * {@code topiaIds} et de leur couverture. - * <p/> + * * Le paramètre {@code computeOrder} détermine si on doit calculer l'ordre * de replication des données (valeur à {@code true}), sinon (valeur * à {@code false}) on utilise l'ordre induit par le paramètre @@ -93,12 +93,12 @@ public class TopiaReplicationModelBuilder { /** * Prepare le modele de replication pour toutes les entites des types * donnes. - * <p/> + * * La méthode calcule l'ordre de replication des données. - * <p/> + * * Actuellement, on n'est pas capable de calculer l'ordre si le graphe des * entités contient des cycles. - * <p/> + * * TODO : faire en sorte de pouvoir gérer les cycles. * * @param contracts les contrats des types a repliquer @@ -190,7 +190,7 @@ public class TopiaReplicationModelBuilder { /** * Instantie un nouveau modèle de réplication pour les entités données par * leur ids. - * <p/> + * * L'ordre de réplication dépend du paramètre {@code computeOrder}. Si * celui-ci vaut {@code true}, on calcule l'ordre de réplication, sinon on * utilise l'ordre induit par les {@code contracts}. @@ -227,7 +227,7 @@ public class TopiaReplicationModelBuilder { /** * Instantie un nouveau modèle de réplication pour toutes les entitées. - * <p/> + * * Ici, l'ordre est toujours calculé. * * @param contracts les types d'entités diff --git a/topia-service-replication/src/main/java/org/nuiton/topia/replication/TopiaReplicationOperation.java b/topia-service-replication/src/main/java/org/nuiton/topia/replication/TopiaReplicationOperation.java index f742952..7e6c138 100644 --- a/topia-service-replication/src/main/java/org/nuiton/topia/replication/TopiaReplicationOperation.java +++ b/topia-service-replication/src/main/java/org/nuiton/topia/replication/TopiaReplicationOperation.java @@ -37,18 +37,18 @@ import java.util.ServiceLoader; /** * Le contrat d'une operation a effectuer lors de la replication. - * <p/> + * * Le module propose des operations de base dans le paquetage * {@code org.nuiton.topia.replication.operation}. - * <p/> - * <p/> + * + * * Pour definir une nouvelle implantation d'operation, il faut l'enregister * en tant que service (au sens de la classe {@link ServiceLoader}, * c'est à dire ajouter dans un fichier (du class-path) * {@code META-INF/services/org.nuiton.topia.replication.TopiaReplicationOperation} - * <p/> + * * une ligne avec le nom qualifie de votre implantation. - * <p/> + * * Lors du chargement du service, on detecte toutes les operations disponibles. * * @author Tony Chemit - chemit@codelutin.com @@ -59,7 +59,7 @@ public interface TopiaReplicationOperation { /** * Creer et enregister une operation utilisateur apres la creation du * modele via la methode - * <p/> + * * {@link TopiaReplicationService#prepare(TopiaEntityEnum[], boolean, String...)}. * * @param model le modele de replication @@ -82,7 +82,7 @@ public interface TopiaReplicationOperation { /** * Execute l'operation avec le parametrage donnee. - * <p/> + * * Note : le commit sur le context cible doit etre geree dans la methode. * * @param replicationContext le contexte de replication diff --git a/topia-service-replication/src/main/java/org/nuiton/topia/replication/TopiaReplicationOperationProvider.java b/topia-service-replication/src/main/java/org/nuiton/topia/replication/TopiaReplicationOperationProvider.java index 5bcae9d..6262096 100644 --- a/topia-service-replication/src/main/java/org/nuiton/topia/replication/TopiaReplicationOperationProvider.java +++ b/topia-service-replication/src/main/java/org/nuiton/topia/replication/TopiaReplicationOperationProvider.java @@ -54,7 +54,7 @@ public class TopiaReplicationOperationProvider { /** * Obtains all {@link TopiaReplicationOperation} available * via {@link ServiceLoader}. - * <p/> + * * If {@link #operations} is null, then load operations, otherwise just * return the already computed result. * diff --git a/topia-service-replication/src/main/java/org/nuiton/topia/replication/TopiaReplicationOperationUndoable.java b/topia-service-replication/src/main/java/org/nuiton/topia/replication/TopiaReplicationOperationUndoable.java index 3071e60..b8dd756 100644 --- a/topia-service-replication/src/main/java/org/nuiton/topia/replication/TopiaReplicationOperationUndoable.java +++ b/topia-service-replication/src/main/java/org/nuiton/topia/replication/TopiaReplicationOperationUndoable.java @@ -30,7 +30,7 @@ import org.nuiton.topia.replication.model.ReplicationOperationDef; /** * Le contrat d'une operation {@link TopiaReplicationOperation} qui peut être * rollbacker lorsque la replication a échouée. - * <p/> + * * * @author Tony Chemit - chemit@codelutin.com * @since 2.4.3 @@ -40,7 +40,7 @@ public interface TopiaReplicationOperationUndoable extends TopiaReplicationOpera /** * Execute l'operation inverse avec le parametrage donnee * (pour annuler l'opération). - * <p/> + * * Note : le commit sur le context cible doit etre geree dans la methode. * * @param operationDef la definition de l'operation a realiser diff --git a/topia-service-replication/src/main/java/org/nuiton/topia/replication/TopiaReplicationService.java b/topia-service-replication/src/main/java/org/nuiton/topia/replication/TopiaReplicationService.java index 80049d7..c32542b 100644 --- a/topia-service-replication/src/main/java/org/nuiton/topia/replication/TopiaReplicationService.java +++ b/topia-service-replication/src/main/java/org/nuiton/topia/replication/TopiaReplicationService.java @@ -32,17 +32,17 @@ import org.nuiton.topia.replication.model.ReplicationModel; /** * User visible interface for replication engin - * <p/> + * * To use replicator you must have properties defined in config file: - * <li>topia.replication.engin=[class used to indexation] <li>possible specific - * property for index engin used - * <p/> + * <ul> + * <li>topia.replication.engin=[class used to indexation]</li> + * <li>possible specific property for index engin used</li> + * </ul> * The replication is always done in two phases : - * <p/> - * <li> - prepare the replication model - ({@link #prepare(TopiaEntityEnum[], boolean, String...)} - ({@link #prepareForAll(TopiaEntityEnum[])} - * <p/> - * <li> - lanch replication {@link #doReplicate(ReplicationModel, - * TopiaApplicationContext)} + * <ul> + * <li> - prepare the replication model - ({@link #prepare(TopiaEntityEnum[], boolean, String...)} - ({@link #prepareForAll(TopiaEntityEnum[])}</li> + * <li> - lanch replication {@link #doReplicate(ReplicationModel,TopiaApplicationContext)}</li> + * </ul> * * @author Tony Chemit - chemit@codelutin.com * @since 2.2.0 @@ -76,12 +76,12 @@ public interface TopiaReplicationService extends TopiaService { /** * Prepare le modele de replication pour toutes les entites des types * donnes. - * <p/> + * * La méthode calcule l'ordre de replication des données. - * <p/> + * * Actuellement, on n'est pas capable de calculer l'ordre si le graphe des * entités contient des cycles. - * <p/> + * * TODO : faire en sorte de pouvoir gérer les cycles. * * @param contracts les contrats des types a repliquer diff --git a/topia-service-replication/src/main/java/org/nuiton/topia/replication/model/ReplicationLink.java b/topia-service-replication/src/main/java/org/nuiton/topia/replication/model/ReplicationLink.java index d897be5..8dd03f0 100644 --- a/topia-service-replication/src/main/java/org/nuiton/topia/replication/model/ReplicationLink.java +++ b/topia-service-replication/src/main/java/org/nuiton/topia/replication/model/ReplicationLink.java @@ -44,7 +44,7 @@ public class ReplicationLink { /** * liste des noeuds requis. - * <p/> + * * TODO tchemit 2010-08-14 Expliquer à quoi ça sert vraiment... */ protected final Set<ReplicationNode> requires; @@ -90,9 +90,9 @@ public class ReplicationLink { /** * Teste si on peut reattacher le lien en connaissant l'univers des * noeuds disponibles. - * <p/> + * * On teste si toutes les pre-requis sont disponibles. - * <p/> + * * Si oui, on peut reattacher. * * @param universe l'univers des noeuds disponibles diff --git a/topia-service-replication/src/main/java/org/nuiton/topia/replication/model/ReplicationModel.java b/topia-service-replication/src/main/java/org/nuiton/topia/replication/model/ReplicationModel.java index 0855f2d..82cbefe 100644 --- a/topia-service-replication/src/main/java/org/nuiton/topia/replication/model/ReplicationModel.java +++ b/topia-service-replication/src/main/java/org/nuiton/topia/replication/model/ReplicationModel.java @@ -53,7 +53,7 @@ import java.util.Set; /** * Model of replication. - * <p/> + * * the object contains the required {@link #nodes} to replicate : * <ul> * <li>all entities for the given {@code nodes} if flag {@link #replicateAll} is diff --git a/topia-service-replication/src/main/java/org/nuiton/topia/replication/model/ReplicationNode.java b/topia-service-replication/src/main/java/org/nuiton/topia/replication/model/ReplicationNode.java index e8298eb..ddbb04f 100644 --- a/topia-service-replication/src/main/java/org/nuiton/topia/replication/model/ReplicationNode.java +++ b/topia-service-replication/src/main/java/org/nuiton/topia/replication/model/ReplicationNode.java @@ -42,7 +42,7 @@ import java.util.Set; /** * Model of a replication's node. - * <p/> + * * The invariant of a replication's node is his {@link #contract}, means the * type of entity to replicate. * diff --git a/topia-service-replication/src/main/java/org/nuiton/topia/replication/model/ReplicationOperationDef.java b/topia-service-replication/src/main/java/org/nuiton/topia/replication/model/ReplicationOperationDef.java index 4939ad3..8516ff4 100644 --- a/topia-service-replication/src/main/java/org/nuiton/topia/replication/model/ReplicationOperationDef.java +++ b/topia-service-replication/src/main/java/org/nuiton/topia/replication/model/ReplicationOperationDef.java @@ -32,7 +32,7 @@ import java.util.Arrays; /** * Definition of a concrete operation to execute. - * <p/> + * * A such operation involves : * <ul> * <li>the replication node</li> @@ -40,12 +40,12 @@ import java.util.Arrays; * <li>the replication operation type</li> * <li>the replication operation arguments</li> * </ul> - * <p/> + * * This definition is detected when building replication model. - * <p/> + * * Then when starting replication, based on this definition, we can instanciate * the operation to execute. - * <p/> + * * <b>Note:</b> Such objects can be comparable via their {@link #phase}. * * @author Tony Chemit - chemit@codelutin.com diff --git a/topia-service-replication/src/main/java/org/nuiton/topia/replication/model/ReplicationOperationPhase.java b/topia-service-replication/src/main/java/org/nuiton/topia/replication/model/ReplicationOperationPhase.java index f5e6914..aced1d8 100644 --- a/topia-service-replication/src/main/java/org/nuiton/topia/replication/model/ReplicationOperationPhase.java +++ b/topia-service-replication/src/main/java/org/nuiton/topia/replication/model/ReplicationOperationPhase.java @@ -28,7 +28,7 @@ import org.nuiton.topia.replication.operation.Duplicate; /** * Une enumeration pour definir quand appliquer une operation. - * <p/> + * * L'ordre induit par cette enumeration sera utilisé pour trier les operations * a realiser sur chaque noeud de replication. * diff --git a/topia-service-replication/src/main/java/org/nuiton/topia/replication/operation/AttachLink.java b/topia-service-replication/src/main/java/org/nuiton/topia/replication/operation/AttachLink.java index 779ace5..6f03dae 100644 --- a/topia-service-replication/src/main/java/org/nuiton/topia/replication/operation/AttachLink.java +++ b/topia-service-replication/src/main/java/org/nuiton/topia/replication/operation/AttachLink.java @@ -45,20 +45,20 @@ import org.nuiton.topia.replication.model.ReplicationOperationPhase; /** * Pour attacher une association. - * <p/> + * * Deux cas peuvent se produire : - * <p/> + * * - le noeud de l'operation est la source de l'association, dans ce cas la - * <code>nodeEntities</code> contient les entites sources de l'association et on + * {@code nodeEntities} contient les entites sources de l'association et on * retrouve les entites associes a partir du type de l'association - * <p/> + * * Ce premier cas est verifie quand reverse (le econd parametre) est a false - * <p/> + * * - le noeud de l'operation est la cible de l'association, dans ce cas la - * <code>nodeEntities</code> contient les entities associes (cibles) de + * {@code nodeEntities} contient les entities associes (cibles) de * l'assocation et on retrouve les entities a partir d'un troisieme parametre * qui donne le node source des entities sources. - * <p/> + * * Note : cette operation est interne, et n'est pas creable par l'utilisateur * via la methode {@link #register(ReplicationModel, ReplicationNode, * ReplicationOperationPhase, Object...)}. diff --git a/topia-service-replication/src/main/java/org/nuiton/topia/replication/operation/DettachAssociation.java b/topia-service-replication/src/main/java/org/nuiton/topia/replication/operation/DettachAssociation.java index 3eb1b08..31610b9 100644 --- a/topia-service-replication/src/main/java/org/nuiton/topia/replication/operation/DettachAssociation.java +++ b/topia-service-replication/src/main/java/org/nuiton/topia/replication/operation/DettachAssociation.java @@ -41,7 +41,7 @@ import org.nuiton.topia.replication.model.ReplicationOperationPhase; /** * Pour dettacher une association. - * <p/> + * * Note : cette operation est interne, et n'est pas creable par * l'utilisateur via la methode * {@link #register(ReplicationModel, ReplicationNode, ReplicationOperationPhase, Object...)}. diff --git a/topia-service-replication/src/main/java/org/nuiton/topia/replication/operation/Duplicate.java b/topia-service-replication/src/main/java/org/nuiton/topia/replication/operation/Duplicate.java index 6144c0e..1790026 100644 --- a/topia-service-replication/src/main/java/org/nuiton/topia/replication/operation/Duplicate.java +++ b/topia-service-replication/src/main/java/org/nuiton/topia/replication/operation/Duplicate.java @@ -43,7 +43,7 @@ import java.util.List; /** * L'operation de duplication d'un noeud de replication. - * <p/> + * * Note : cette operation est interne, et n'est pas creable par * l'utilisateur via la methode * {@link #register(ReplicationModel, ReplicationNode, ReplicationOperationPhase, Object...)}. diff --git a/topia-service-replication/src/main/java/org/nuiton/topia/replication/operation/LoadLink.java b/topia-service-replication/src/main/java/org/nuiton/topia/replication/operation/LoadLink.java index 458057b..a871031 100644 --- a/topia-service-replication/src/main/java/org/nuiton/topia/replication/operation/LoadLink.java +++ b/topia-service-replication/src/main/java/org/nuiton/topia/replication/operation/LoadLink.java @@ -42,7 +42,7 @@ import java.util.List; /** * Pour charger une association sur le noeud de l'operation. - * <p/> + * * Note : cette operation est interne, et n'est pas creable par * l'utilisateur via la methode * {@link #register(ReplicationModel, ReplicationNode, ReplicationOperationPhase, Object...)}. diff --git a/topia-service-replication/src/test/java/org/nuiton/topia/replication/AbstractTopiaReplicationServiceTest.java b/topia-service-replication/src/test/java/org/nuiton/topia/replication/AbstractTopiaReplicationServiceTest.java index 898ad47..7079f38 100644 --- a/topia-service-replication/src/test/java/org/nuiton/topia/replication/AbstractTopiaReplicationServiceTest.java +++ b/topia-service-replication/src/test/java/org/nuiton/topia/replication/AbstractTopiaReplicationServiceTest.java @@ -58,7 +58,7 @@ import java.util.Set; /** * TopiaReplicationServiceImplTest. - * <p/> + * * Created: 07 jun. 09 17:14:22 * * @author Tony Chemit - chemit@codelutin.com diff --git a/topia-service-replication/src/test/java/org/nuiton/topia/replication/TopiaReplicationOperationTest.java b/topia-service-replication/src/test/java/org/nuiton/topia/replication/TopiaReplicationOperationTest.java index cf24fdb..85231ad 100644 --- a/topia-service-replication/src/test/java/org/nuiton/topia/replication/TopiaReplicationOperationTest.java +++ b/topia-service-replication/src/test/java/org/nuiton/topia/replication/TopiaReplicationOperationTest.java @@ -50,7 +50,7 @@ import org.nuiton.topia.replication.operation.UnregistredOperation; /** * TopiaReplicationServiceImplTest on model TopiaTest - * <p/> + * * Created: 07 jun. 09 17:14:22 * * @author Tony Chemit - chemit@codelutin.com diff --git a/topia-service-replication/src/test/java/org/nuiton/topia/replication/TopiaReplicationServiceImplAllTest.java b/topia-service-replication/src/test/java/org/nuiton/topia/replication/TopiaReplicationServiceImplAllTest.java index 98ba656..988de37 100644 --- a/topia-service-replication/src/test/java/org/nuiton/topia/replication/TopiaReplicationServiceImplAllTest.java +++ b/topia-service-replication/src/test/java/org/nuiton/topia/replication/TopiaReplicationServiceImplAllTest.java @@ -46,7 +46,7 @@ import org.nuiton.topia.persistence.TopiaPersistenceContext; /** * TopiaReplicationServiceImplTest on model TopiaTest - * <p/> + * * Created: 07 jun. 09 17:14:22 * * @author Tony Chemit - chemit@codelutin.com diff --git a/topia-service-replication/src/test/java/org/nuiton/topia/replication/TopiaReplicationServiceImplTest.java b/topia-service-replication/src/test/java/org/nuiton/topia/replication/TopiaReplicationServiceImplTest.java index 8f71cb1..5f143bd 100644 --- a/topia-service-replication/src/test/java/org/nuiton/topia/replication/TopiaReplicationServiceImplTest.java +++ b/topia-service-replication/src/test/java/org/nuiton/topia/replication/TopiaReplicationServiceImplTest.java @@ -52,7 +52,7 @@ import org.nuiton.topia.replication.operation.UnregistredOperation; /** * TopiaReplicationServiceImplTest on model TopiaTest - * <p/> + * * Created: 07 jun. 09 17:14:22 * * @author Tony Chemit - chemit@codelutin.com @@ -237,7 +237,7 @@ public class TopiaReplicationServiceImplTest extends AbstractTopiaReplicationSer /** * Cette methode montre pourquoi la simple replication ne peut pas * fonctionner :) - * <p/> + * * Le replicateur ne deplique pas dans le bon ordre et on a donc des * violations de clef etrangeres... * @@ -269,7 +269,7 @@ public class TopiaReplicationServiceImplTest extends AbstractTopiaReplicationSer /** * Cette methode montre comment manuellement on peut effectuer la * replication (en dettachant les dependances qui forment des cycles) - * <p/> + * * La methode utilisee ici peut ne pas fonctionner : si une clef metier est * posee sur une dependance alors cela ne fonctionne pas. * @@ -316,13 +316,13 @@ public class TopiaReplicationServiceImplTest extends AbstractTopiaReplicationSer /** * Cette methode montre comment manuellement on peut effectuer la * replication (en dettachant les associations qui forment des cycles) - * <p/> + * * La methode utilisee ici fonctionne mieux que la precedante : il parrait * dificille de pose une une clef metier sur une association :). - * <p/> + * * On remarque que l'on dettache l'assocation qui forme un cycle et que l'on * est pas obligee de la reattachee car elle est bi-directionnelle. - * <p/> + * * On doit optimiser l'algorithme dans la methode {@link * ReplicationModel#adjustOperations(TopiaEntityIdsMap)}. * -- To stop receiving notification emails like this one, please contact nuiton.org SCM administrator <admin+scm@nuiton.org>.
This is an automated email from the git hooks/post-receive script. New commit to branch feature/3858_javadoc_jdk8 in repository topia. See http://git.nuiton.org/topia.git commit b09950839d578f5024606f89fe6e0409218c73dd Author: Tony CHEMIT <chemit@codelutin.com> Date: Wed Dec 30 16:37:03 2015 +0100 Fix javadoc in service migration module (See #3858) --- .../nuiton/topia/migration/AbstractTopiaMigrationCallback.java | 8 ++++---- .../org/nuiton/topia/migration/TopiaMigrationCallbackByClass.java | 4 ++-- .../nuiton/topia/migration/TopiaMigrationCallbackByClassNG.java | 4 ++-- .../nuiton/topia/migration/TopiaMigrationCallbackByMethod.java | 4 ++-- .../java/org/nuiton/topia/migration/TopiaMigrationEngine.java | 8 ++++---- 5 files changed, 14 insertions(+), 14 deletions(-) diff --git a/topia-service-migration/src/main/java/org/nuiton/topia/migration/AbstractTopiaMigrationCallback.java b/topia-service-migration/src/main/java/org/nuiton/topia/migration/AbstractTopiaMigrationCallback.java index cd684c3..3e8000e 100644 --- a/topia-service-migration/src/main/java/org/nuiton/topia/migration/AbstractTopiaMigrationCallback.java +++ b/topia-service-migration/src/main/java/org/nuiton/topia/migration/AbstractTopiaMigrationCallback.java @@ -74,14 +74,14 @@ public abstract class AbstractTopiaMigrationCallback { /** * Tentative de migration depuis la version de la base version la version * souhaitee. - * <p/> + * * On applique toutes les migrations de version indiquee dans le parametre - * <code>version</code>. - * <p/> + * {@code version}. + * * Pour chaque version, on cherche la methode migrateTo_XXX ou XXX est la * version transforme en identifiant java via la methode * {@link Version#getValidName()} et on l'execute. - * <p/> + * * Note: pour chaque version a appliquer, on ouvre une nouvelle transaction. * * @param versionConfiguration configuration Hibernate permettant d'accéder à la base diff --git a/topia-service-migration/src/main/java/org/nuiton/topia/migration/TopiaMigrationCallbackByClass.java b/topia-service-migration/src/main/java/org/nuiton/topia/migration/TopiaMigrationCallbackByClass.java index d06a1f5..4c9bc2d 100644 --- a/topia-service-migration/src/main/java/org/nuiton/topia/migration/TopiaMigrationCallbackByClass.java +++ b/topia-service-migration/src/main/java/org/nuiton/topia/migration/TopiaMigrationCallbackByClass.java @@ -36,11 +36,11 @@ import java.util.Map; /** * Migration callback which use a different class for each version to migrate. - * <p/> + * * You must fill in the constructor the mapping for each version of * {@link #getAvailableVersions()} a matching migrator for version which * extends {@link MigrationCallBackForVersion}. - * <p/> + * * Use the callback when you have a lot of version to migrate and the * {@link TopiaMigrationCallbackByMethod} begins to be messy. * diff --git a/topia-service-migration/src/main/java/org/nuiton/topia/migration/TopiaMigrationCallbackByClassNG.java b/topia-service-migration/src/main/java/org/nuiton/topia/migration/TopiaMigrationCallbackByClassNG.java index 45adbd1..b53b639 100644 --- a/topia-service-migration/src/main/java/org/nuiton/topia/migration/TopiaMigrationCallbackByClassNG.java +++ b/topia-service-migration/src/main/java/org/nuiton/topia/migration/TopiaMigrationCallbackByClassNG.java @@ -40,11 +40,11 @@ import java.util.TreeMap; /** * Migration callback which use a different class for each version to migrate. - * <p/> + * * You must fill in the constructor the mapping for each version of * {@link #getAvailableVersions()} a matching migrator for version which * extends {@link MigrationCallBackForVersion}. - * <p/> + * * Use the callback when you have a lot of version to migrate and the * {@link TopiaMigrationCallbackByMethod} begins to be messy. * diff --git a/topia-service-migration/src/main/java/org/nuiton/topia/migration/TopiaMigrationCallbackByMethod.java b/topia-service-migration/src/main/java/org/nuiton/topia/migration/TopiaMigrationCallbackByMethod.java index 516c6fb..da7f697 100644 --- a/topia-service-migration/src/main/java/org/nuiton/topia/migration/TopiaMigrationCallbackByMethod.java +++ b/topia-service-migration/src/main/java/org/nuiton/topia/migration/TopiaMigrationCallbackByMethod.java @@ -34,11 +34,11 @@ import java.lang.reflect.Method; /** * Migration callback base on methods. - * <p/> + * * The callback defines for each version of {@link #getAvailableVersions()} * a method named {@code migrate_on_XXX} where {@code XXX} is the version with * all dots replaces by underscores. - * <p/> + * * Replace deprecated implementation {@code TopiaMigrationCallBack}. * * @author Tony Chemit - chemit@codelutin.com diff --git a/topia-service-migration/src/main/java/org/nuiton/topia/migration/TopiaMigrationEngine.java b/topia-service-migration/src/main/java/org/nuiton/topia/migration/TopiaMigrationEngine.java index a1c733e..65c3cf3 100644 --- a/topia-service-migration/src/main/java/org/nuiton/topia/migration/TopiaMigrationEngine.java +++ b/topia-service-migration/src/main/java/org/nuiton/topia/migration/TopiaMigrationEngine.java @@ -57,9 +57,9 @@ import java.util.TreeSet; /** * Le moteur de migration proposé par topia. Il est basé sur un {@link AbstractTopiaMigrationCallback} * qui donne la version de l'application, les version de mises à jour disponibles. - * <p/> + * * Le call back offre aussi les commandes sql à passer pour chaque version de mise à jour. - * <p/> + * * FIXME Finir cette documentation * * @author tchemit @@ -113,7 +113,7 @@ public class TopiaMigrationEngine implements TopiaMigrationService { /** * A flag to check if version was detected in database. - * <p/> + * * This flag is set to {@code true} at the end of method {@link #detectDbVersion()}. */ protected boolean versionDetected; @@ -514,7 +514,7 @@ public class TopiaMigrationEngine implements TopiaMigrationService { /** * Recupere depuis la base les états internes du service : - * <p/> + * * <ul> * <li>{@link #versionTableExist}</li> * <li>{@link #dbVersion}</li> -- To stop receiving notification emails like this one, please contact nuiton.org SCM administrator <admin+scm@nuiton.org>.
This is an automated email from the git hooks/post-receive script. New commit to branch feature/3858_javadoc_jdk8 in repository topia. See http://git.nuiton.org/topia.git commit 9d864dd6eeac25cd73711c93d52114ce6873a961 Author: Tony CHEMIT <chemit@codelutin.com> Date: Wed Dec 30 16:37:14 2015 +0100 Fix javadoc in service csv module (See #3858) --- .../org/nuiton/topia/service/csv/in/AbstractImportModel.java | 2 +- .../java/org/nuiton/topia/service/csv/in/ImportStrategy.java | 2 +- .../java/org/nuiton/topia/service/csv/in/TopiaCsvImports.java | 10 +++++----- 3 files changed, 7 insertions(+), 7 deletions(-) diff --git a/topia-service-csv/src/main/java/org/nuiton/topia/service/csv/in/AbstractImportModel.java b/topia-service-csv/src/main/java/org/nuiton/topia/service/csv/in/AbstractImportModel.java index 0b35e11..1a2246b 100644 --- a/topia-service-csv/src/main/java/org/nuiton/topia/service/csv/in/AbstractImportModel.java +++ b/topia-service-csv/src/main/java/org/nuiton/topia/service/csv/in/AbstractImportModel.java @@ -33,7 +33,7 @@ import java.util.Map; /** * Abstract import model which add the useful methdo about importing foreign keys. * - * @param <E> type of entity to import + * @param <E>type of entity to import * @author Tony Chemit - chemit@codelutin.com * @since 2.6.12 */ diff --git a/topia-service-csv/src/main/java/org/nuiton/topia/service/csv/in/ImportStrategy.java b/topia-service-csv/src/main/java/org/nuiton/topia/service/csv/in/ImportStrategy.java index 4ee54cb..1feb03e 100644 --- a/topia-service-csv/src/main/java/org/nuiton/topia/service/csv/in/ImportStrategy.java +++ b/topia-service-csv/src/main/java/org/nuiton/topia/service/csv/in/ImportStrategy.java @@ -36,7 +36,7 @@ import java.io.Reader; /** * Strategy to import some stuff. - * <p/> + * * Implements it and then you can use it with helper methods * {@link TopiaCsvImports#importTable(Reader, ImportStrategy, TableMeta, CsvImportResult)}, * {@link TopiaCsvImports#importAssociation(Reader, ImportStrategy, AssociationMeta, CsvImportResult)}. diff --git a/topia-service-csv/src/main/java/org/nuiton/topia/service/csv/in/TopiaCsvImports.java b/topia-service-csv/src/main/java/org/nuiton/topia/service/csv/in/TopiaCsvImports.java index de8fb5f..2ecd894 100644 --- a/topia-service-csv/src/main/java/org/nuiton/topia/service/csv/in/TopiaCsvImports.java +++ b/topia-service-csv/src/main/java/org/nuiton/topia/service/csv/in/TopiaCsvImports.java @@ -141,7 +141,7 @@ public class TopiaCsvImports { /** * To import a table (given by his {@code meta}) from a reader and a strategy. - * <p/> + * * Result of import can be stored in an optional csv result. * * @param reader where to read csv data @@ -149,7 +149,7 @@ public class TopiaCsvImports { * @param meta meta of the data * @param csvResult optional csv result * @param <T> type of entity enum - * @param <E> type of data + * @param <E> type of data * @throws TopiaException if any db problem while storing datas * @throws IOException if any pb while reading csv data * @see ImportStrategy#importTable(TableMeta, Import, CsvImportResult) @@ -175,7 +175,7 @@ public class TopiaCsvImports { /** * To import a table (given by his {@code meta}) from a reader and a strategy. - * <p/> + * * Result of import can be stored in an optional csv result. * * @param reader where to read csv data @@ -183,7 +183,7 @@ public class TopiaCsvImports { * @param meta meta of the data * @param csvResult optional csv result * @param <T> type of entity enum - * @param <E> type of data + * @param <E> type of data * @throws TopiaException if any db problem while storing datas * @throws IOException if any pb while reading csv data * @see ImportStrategy#importTable(TableMeta, Import, CsvImportResult) @@ -209,7 +209,7 @@ public class TopiaCsvImports { /** * To import a association (given by his {@code meta}) from a reader and a strategy. - * <p/> + * * Result of import can be stored in an optional csv result. * * @param reader where to read csv data -- To stop receiving notification emails like this one, please contact nuiton.org SCM administrator <admin+scm@nuiton.org>.
This is an automated email from the git hooks/post-receive script. New commit to branch feature/3858_javadoc_jdk8 in repository topia. See http://git.nuiton.org/topia.git commit 2e7869a7eb144107f783135f5e1d019f55cbc7ab Author: Tony CHEMIT <chemit@codelutin.com> Date: Wed Dec 30 16:37:28 2015 +0100 Fix javadoc in it module (See #3858) --- .../topia/it/legacy/topiatest/persistence/Entity1.java | 2 +- .../it/legacy/topiatest/persistence/Entity1Abstract.java | 2 +- .../topia/it/legacy/topiatest/persistence/Entity1Impl.java | 2 +- .../src/test/java/org/nuiton/topia/it/GenerateTest.java | 2 +- .../org/nuiton/topia/it/legacy/TopiaItLegacyDatabase.java | 4 ++-- .../it/legacy/persistence/EntityVisitorExportXmlTest.java | 4 ++-- .../nuiton/topia/it/legacy/persistence/NaturalIdTest.java | 2 +- .../it/legacy/persistence/util/TopiaEntityRefTester.java | 14 +++++++------- .../legacy/persistence/util/TopiaEntityRefTesterTest.java | 2 +- .../org/nuiton/topia/it/legacy/topiatest/EnumTest.java | 2 +- 10 files changed, 18 insertions(+), 18 deletions(-) diff --git a/topia-it/src/main/java/org/nuiton/topia/it/legacy/topiatest/persistence/Entity1.java b/topia-it/src/main/java/org/nuiton/topia/it/legacy/topiatest/persistence/Entity1.java index da04ec0..3f90491 100644 --- a/topia-it/src/main/java/org/nuiton/topia/it/legacy/topiatest/persistence/Entity1.java +++ b/topia-it/src/main/java/org/nuiton/topia/it/legacy/topiatest/persistence/Entity1.java @@ -29,7 +29,7 @@ import org.nuiton.topia.persistence.TopiaEntity; /** * Created: 11 mai 2010 * - * @author fdesbois <fdesbois@codelutin.com> + * @author Florian Desbois- fdebois@codelutin.com */ public interface Entity1 extends TopiaEntity { diff --git a/topia-it/src/main/java/org/nuiton/topia/it/legacy/topiatest/persistence/Entity1Abstract.java b/topia-it/src/main/java/org/nuiton/topia/it/legacy/topiatest/persistence/Entity1Abstract.java index 29f1f34..57881a4 100644 --- a/topia-it/src/main/java/org/nuiton/topia/it/legacy/topiatest/persistence/Entity1Abstract.java +++ b/topia-it/src/main/java/org/nuiton/topia/it/legacy/topiatest/persistence/Entity1Abstract.java @@ -31,7 +31,7 @@ import org.nuiton.topia.persistence.TopiaException; /** * Created: 11 mai 2010 * - * @author fdesbois <fdesbois@codelutin.com> + * @author Florian Desbois- fdebois@codelutin.com */ public abstract class Entity1Abstract extends AbstractTopiaEntity implements Entity1 { diff --git a/topia-it/src/main/java/org/nuiton/topia/it/legacy/topiatest/persistence/Entity1Impl.java b/topia-it/src/main/java/org/nuiton/topia/it/legacy/topiatest/persistence/Entity1Impl.java index 8b093a7..77ace76 100644 --- a/topia-it/src/main/java/org/nuiton/topia/it/legacy/topiatest/persistence/Entity1Impl.java +++ b/topia-it/src/main/java/org/nuiton/topia/it/legacy/topiatest/persistence/Entity1Impl.java @@ -27,7 +27,7 @@ package org.nuiton.topia.it.legacy.topiatest.persistence; /** * Created: 11 mai 2010 * - * @author fdesbois <fdesbois@codelutin.com> + * @author Florian Desbois- fdebois@codelutin.com */ public class Entity1Impl extends Entity1Abstract { } diff --git a/topia-it/src/test/java/org/nuiton/topia/it/GenerateTest.java b/topia-it/src/test/java/org/nuiton/topia/it/GenerateTest.java index c5dbec1..b2e5104 100644 --- a/topia-it/src/test/java/org/nuiton/topia/it/GenerateTest.java +++ b/topia-it/src/test/java/org/nuiton/topia/it/GenerateTest.java @@ -46,7 +46,7 @@ import org.nuiton.topia.it.legacy.test.entities.PetTopiaDao; /** * To test generated classes. - * <p/> + * * Created on 12/19/13. * * @author Tony Chemit - chemit@codelutin.com diff --git a/topia-it/src/test/java/org/nuiton/topia/it/legacy/TopiaItLegacyDatabase.java b/topia-it/src/test/java/org/nuiton/topia/it/legacy/TopiaItLegacyDatabase.java index 2b7accd..b04a2e8 100644 --- a/topia-it/src/test/java/org/nuiton/topia/it/legacy/TopiaItLegacyDatabase.java +++ b/topia-it/src/test/java/org/nuiton/topia/it/legacy/TopiaItLegacyDatabase.java @@ -29,7 +29,7 @@ import org.nuiton.topia.persistence.TopiaConfiguration; /** * Put this class as a Rule in test to obtain a new isolated db for each test. - * <p/> + * * Here is a simple example of usage : * <pre> * public class MyTest { @@ -45,7 +45,7 @@ import org.nuiton.topia.persistence.TopiaConfiguration; * } * </pre> * The db created will be unique for each test method (and for each build also). - * <p/> + * * You don't need to close any transaction, it will be done for you and the end * of each method test. * diff --git a/topia-it/src/test/java/org/nuiton/topia/it/legacy/persistence/EntityVisitorExportXmlTest.java b/topia-it/src/test/java/org/nuiton/topia/it/legacy/persistence/EntityVisitorExportXmlTest.java index 60fc6a6..d26f9f2 100644 --- a/topia-it/src/test/java/org/nuiton/topia/it/legacy/persistence/EntityVisitorExportXmlTest.java +++ b/topia-it/src/test/java/org/nuiton/topia/it/legacy/persistence/EntityVisitorExportXmlTest.java @@ -58,7 +58,7 @@ public class EntityVisitorExportXmlTest { /** * Prepare test. - * <p/> + * * Add all tests commons data * * @throws TopiaException if could not create datas @@ -104,7 +104,7 @@ public class EntityVisitorExportXmlTest { /** * Test l'export XML via un visiteur. - * <p/> + * * Parcourt en profondeur. * * @throws TopiaException diff --git a/topia-it/src/test/java/org/nuiton/topia/it/legacy/persistence/NaturalIdTest.java b/topia-it/src/test/java/org/nuiton/topia/it/legacy/persistence/NaturalIdTest.java index 3998880..e30192e 100644 --- a/topia-it/src/test/java/org/nuiton/topia/it/legacy/persistence/NaturalIdTest.java +++ b/topia-it/src/test/java/org/nuiton/topia/it/legacy/persistence/NaturalIdTest.java @@ -39,7 +39,7 @@ import org.nuiton.topia.it.legacy.topiatest.NaturalizedEntityTopiaDao; /** * NaturalIdTest - * <p/> + * * Created: 18 févr. 2010 * * @author fdesbois diff --git a/topia-it/src/test/java/org/nuiton/topia/it/legacy/persistence/util/TopiaEntityRefTester.java b/topia-it/src/test/java/org/nuiton/topia/it/legacy/persistence/util/TopiaEntityRefTester.java index 36a4e0a..e2551d0 100644 --- a/topia-it/src/test/java/org/nuiton/topia/it/legacy/persistence/util/TopiaEntityRefTester.java +++ b/topia-it/src/test/java/org/nuiton/topia/it/legacy/persistence/util/TopiaEntityRefTester.java @@ -44,7 +44,7 @@ import static java.util.Map.Entry; /** * A abstract class to help testing {@link TopiaEntityRef} as detectes types, or * detects or references. - * <p/> + * * An example of use if given in the test {@link TopiaEntityRefTesterTest}. * * @author Tony Chemit - chemit@codelutin.com @@ -106,7 +106,7 @@ public abstract class TopiaEntityRefTester<T extends TopiaEntityEnum> { /** * Obtain the reference of an association for a given entity. - * <p/> + * * Example, to obtain the Pet 'pudding' on a Person : * <pre>pet[@topiaId='pudding']</pre> * invoke @@ -122,7 +122,7 @@ public abstract class TopiaEntityRefTester<T extends TopiaEntityEnum> { /** * Obtain the reference of an association for a given id. - * <p/> + * * Example to obtain the Pet 'pudding' on a Person : * <pre>pet[@topiaId='pudding']</pre> * invoke @@ -143,7 +143,7 @@ public abstract class TopiaEntityRefTester<T extends TopiaEntityEnum> { /** * Obtain the next entry from the iterator. - * <p/> + * * As a side-effect, it will increment the state {@link #index}. */ protected void nextEntry() { @@ -157,7 +157,7 @@ public abstract class TopiaEntityRefTester<T extends TopiaEntityEnum> { /** * Detects the references from the given {@code entity} which have their * topiaId in the given list of {@code ids}. - * <p/> + * * As a side-effect, it will update the states {@code detected} and set the * iterator {@code itr} to the first position on detected entries. * @@ -177,7 +177,7 @@ public abstract class TopiaEntityRefTester<T extends TopiaEntityEnum> { /** * Detects the references from the given {@code entity} which have their * topiaId in the given list of {@code ids}. - * <p/> + * * As a side-effect, it will update the states {@code detected} and set the * iterator {@code itr} to the first position on detected entries. * @@ -318,7 +318,7 @@ public abstract class TopiaEntityRefTester<T extends TopiaEntityEnum> { /** * Asserts that the number of detected entries (store in internal state * {@code detected}) is ok. - * <p/> + * * As a side-effect, it will reset the internal state {@code itr} on the * first entry of the {@code detected} list. * diff --git a/topia-it/src/test/java/org/nuiton/topia/it/legacy/persistence/util/TopiaEntityRefTesterTest.java b/topia-it/src/test/java/org/nuiton/topia/it/legacy/persistence/util/TopiaEntityRefTesterTest.java index 37e40ab..166526f 100644 --- a/topia-it/src/test/java/org/nuiton/topia/it/legacy/persistence/util/TopiaEntityRefTesterTest.java +++ b/topia-it/src/test/java/org/nuiton/topia/it/legacy/persistence/util/TopiaEntityRefTesterTest.java @@ -34,7 +34,7 @@ import org.nuiton.topia.it.legacy.test.entities.Race; /** * Test the {@link TopiaEntityRefTester} on - * <p/> + * * <ul> <li>{@link Pet}</li> <li>{@link Race}</li> <li>{@link Person}</li> * </ul> * diff --git a/topia-it/src/test/java/org/nuiton/topia/it/legacy/topiatest/EnumTest.java b/topia-it/src/test/java/org/nuiton/topia/it/legacy/topiatest/EnumTest.java index 8541da5..e35e646 100644 --- a/topia-it/src/test/java/org/nuiton/topia/it/legacy/topiatest/EnumTest.java +++ b/topia-it/src/test/java/org/nuiton/topia/it/legacy/topiatest/EnumTest.java @@ -43,7 +43,7 @@ public class EnumTest { /** * Create an entity having two field of type enumeration. One is stored * using ordinal, the other using the name. - * <p/> + * * The test check that values are stored, and that find methods works * * @throws TopiaException if any exception with db -- To stop receiving notification emails like this one, please contact nuiton.org SCM administrator <admin+scm@nuiton.org>.
This is an automated email from the git hooks/post-receive script. New commit to branch feature/3858_javadoc_jdk8 in repository topia. See http://git.nuiton.org/topia.git commit d3fd8060851c6c61b0adc1dc3d8c1b4e730ac4a7 Author: Tony CHEMIT <chemit@codelutin.com> Date: Wed Dec 30 16:37:36 2015 +0100 Fix javadoc junit module (See #3858) --- .../main/java/org/nuiton/topia/junit/AbstractDatabaseResource.java | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/topia-junit/src/main/java/org/nuiton/topia/junit/AbstractDatabaseResource.java b/topia-junit/src/main/java/org/nuiton/topia/junit/AbstractDatabaseResource.java index 4fd9d47..acfd0f5 100644 --- a/topia-junit/src/main/java/org/nuiton/topia/junit/AbstractDatabaseResource.java +++ b/topia-junit/src/main/java/org/nuiton/topia/junit/AbstractDatabaseResource.java @@ -35,7 +35,7 @@ import org.nuiton.topia.persistence.internal.AbstractTopiaApplicationContext; /** * Put this class as a Rule in test to obtain a new isolated db for each test. - * <p/> + * * Here is a simple example of usage : * <pre> * public class MyTest { @@ -51,10 +51,10 @@ import org.nuiton.topia.persistence.internal.AbstractTopiaApplicationContext; * } * </pre> * The db created will be unique for each test method (and for each build also). - * <p/> + * * You don't need to close any transaction, it will be done for you and the end * of each method test. - * <p/> + * * Created on 11/22/13. * * @author Tony Chemit - chemit@codelutin.com -- To stop receiving notification emails like this one, please contact nuiton.org SCM administrator <admin+scm@nuiton.org>.
This is an automated email from the git hooks/post-receive script. New commit to branch feature/3858_javadoc_jdk8 in repository topia. See http://git.nuiton.org/topia.git commit 2545932c6abc9203254e9212bfe1ee0120b3c3bf Author: Tony CHEMIT <chemit@codelutin.com> Date: Wed Dec 30 16:45:05 2015 +0100 Fix javadoc in tests (See #3858) --- .../nuiton/topia/it/legacy/persistence/EntityVisitorExportXmlTest.java | 2 +- .../nuiton/topia/it/legacy/persistence/util/TopiaEntityHelperTest.java | 2 +- .../java/org/nuiton/topia/it/legacy/topiatest/CascadeSaveTest.java | 3 --- .../java/org/nuiton/topia/it/mapping/test4/ElementCollectionTest.java | 3 +-- .../persistence/FullyQualifiedNamePlusUuidTopiaIdFactoryTest.java | 2 +- 5 files changed, 4 insertions(+), 8 deletions(-) diff --git a/topia-it/src/test/java/org/nuiton/topia/it/legacy/persistence/EntityVisitorExportXmlTest.java b/topia-it/src/test/java/org/nuiton/topia/it/legacy/persistence/EntityVisitorExportXmlTest.java index d26f9f2..a3f7d2d 100644 --- a/topia-it/src/test/java/org/nuiton/topia/it/legacy/persistence/EntityVisitorExportXmlTest.java +++ b/topia-it/src/test/java/org/nuiton/topia/it/legacy/persistence/EntityVisitorExportXmlTest.java @@ -107,7 +107,7 @@ public class EntityVisitorExportXmlTest { * * Parcourt en profondeur. * - * @throws TopiaException + * @throws TopiaException FIXME */ @Test public void testExportXMLDepth() throws TopiaException { diff --git a/topia-it/src/test/java/org/nuiton/topia/it/legacy/persistence/util/TopiaEntityHelperTest.java b/topia-it/src/test/java/org/nuiton/topia/it/legacy/persistence/util/TopiaEntityHelperTest.java index 6bfc657..9c259da 100644 --- a/topia-it/src/test/java/org/nuiton/topia/it/legacy/persistence/util/TopiaEntityHelperTest.java +++ b/topia-it/src/test/java/org/nuiton/topia/it/legacy/persistence/util/TopiaEntityHelperTest.java @@ -144,7 +144,7 @@ public class TopiaEntityHelperTest { /** * Test of detectTypes method, of class TopiaEntityHelper. * - * @throws TopiaException + * @throws TopiaException FIXME */ @Test public void testDetectTypes() throws TopiaException { diff --git a/topia-it/src/test/java/org/nuiton/topia/it/legacy/topiatest/CascadeSaveTest.java b/topia-it/src/test/java/org/nuiton/topia/it/legacy/topiatest/CascadeSaveTest.java index b5366b4..dd512e3 100644 --- a/topia-it/src/test/java/org/nuiton/topia/it/legacy/topiatest/CascadeSaveTest.java +++ b/topia-it/src/test/java/org/nuiton/topia/it/legacy/topiatest/CascadeSaveTest.java @@ -26,7 +26,6 @@ package org.nuiton.topia.it.legacy.topiatest; import org.junit.Rule; import org.junit.Test; -import org.nuiton.topia.persistence.TopiaException; import org.nuiton.topia.it.legacy.TopiaItLegacyDatabase; import org.nuiton.topia.it.legacy.TopiaItLegacyTopiaPersistenceContext; @@ -41,8 +40,6 @@ public class CascadeSaveTest { /** * The following test will fail if no topiaId is injected on cascade save. This will test code within this method : * org.nuiton.topia.persistence.internal.support.TopiaHibernateEventListener#onSaveOrUpdate(org.hibernate.event.spi.SaveOrUpdateEvent) - * - * @throws TopiaException */ @Test public void testSaveCascade() { diff --git a/topia-it/src/test/java/org/nuiton/topia/it/mapping/test4/ElementCollectionTest.java b/topia-it/src/test/java/org/nuiton/topia/it/mapping/test4/ElementCollectionTest.java index 34ffd72..42931e3 100644 --- a/topia-it/src/test/java/org/nuiton/topia/it/mapping/test4/ElementCollectionTest.java +++ b/topia-it/src/test/java/org/nuiton/topia/it/mapping/test4/ElementCollectionTest.java @@ -38,8 +38,7 @@ import org.nuiton.topia.persistence.TopiaException; import java.util.Arrays; /** - * Tests that everything is ok with fields with multiplicity > 1 on primitive - * data. + * Tests that everything is ok with fields with multiplicity → 1 on primitive data. * * @author Tony Chemit - chemit@codelutin.com * @since 3.0 diff --git a/topia-persistence/src/test/java/org/nuiton/topia/persistence/FullyQualifiedNamePlusUuidTopiaIdFactoryTest.java b/topia-persistence/src/test/java/org/nuiton/topia/persistence/FullyQualifiedNamePlusUuidTopiaIdFactoryTest.java index a27a8eb..72de488 100644 --- a/topia-persistence/src/test/java/org/nuiton/topia/persistence/FullyQualifiedNamePlusUuidTopiaIdFactoryTest.java +++ b/topia-persistence/src/test/java/org/nuiton/topia/persistence/FullyQualifiedNamePlusUuidTopiaIdFactoryTest.java @@ -30,7 +30,7 @@ import org.nuiton.topia.persistence.internal.AbstractTopiaEntity; import org.nuiton.topia.persistence.internal.FullyQualifiedNamePlusUuidTopiaIdFactory; /** - * @author Sylvain Bavencoff <bavencoff@codelutin.com> + * @author Sylvain Bavencoff - bavencoff@codelutin.com */ public class FullyQualifiedNamePlusUuidTopiaIdFactoryTest { -- To stop receiving notification emails like this one, please contact nuiton.org SCM administrator <admin+scm@nuiton.org>.
participants (1)
-
nuiton.org scm