You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@polygene.apache.org by ni...@apache.org on 2015/04/17 18:08:33 UTC
[21/50] [abbrv] zest-qi4j git commit: Fixed all JavaDoc ERRORS
reported by DocLint in Java 8.
Fixed all JavaDoc ERRORS reported by DocLint in Java 8.
Project: http://git-wip-us.apache.org/repos/asf/zest-qi4j/repo
Commit: http://git-wip-us.apache.org/repos/asf/zest-qi4j/commit/3bf71dfe
Tree: http://git-wip-us.apache.org/repos/asf/zest-qi4j/tree/3bf71dfe
Diff: http://git-wip-us.apache.org/repos/asf/zest-qi4j/diff/3bf71dfe
Branch: refs/heads/3.0
Commit: 3bf71dfea23dad90b449e271e24308edc0127e6f
Parents: 6ea0457
Author: Niclas Hedhman <ni...@hedhman.org>
Authored: Tue Aug 26 12:24:16 2014 +0800
Committer: Niclas Hedhman <ni...@hedhman.org>
Committed: Tue Aug 26 12:24:16 2014 +0800
----------------------------------------------------------------------
.../java/org/qi4j/api/activation/Activator.java | 2 +-
.../qi4j/api/activation/ActivatorAdapter.java | 2 +-
.../api/association/AssociationDescriptor.java | 17 ++++++--
.../java/org/qi4j/api/common/AppliesTo.java | 2 +-
.../org/qi4j/api/common/AppliesToFilter.java | 4 +-
.../main/java/org/qi4j/api/common/MetaInfo.java | 11 +++---
.../java/org/qi4j/api/common/UseDefaults.java | 10 ++---
.../api/composite/AmbiguousTypeException.java | 4 +-
.../java/org/qi4j/api/composite/Composite.java | 6 ++-
.../qi4j/api/composite/CompositeInvoker.java | 10 +++--
.../org/qi4j/api/composite/DecoratorMixin.java | 3 +-
.../java/org/qi4j/api/concern/ConcernOf.java | 6 ++-
.../qi4j/api/concern/internal/ConcernFor.java | 13 ++++---
.../qi4j/api/configuration/Configuration.java | 22 +++++------
.../ConstraintViolationException.java | 19 +++++----
.../org/qi4j/api/constraint/Constraints.java | 3 +-
.../main/java/org/qi4j/api/entity/Identity.java | 4 +-
.../java/org/qi4j/api/entity/Lifecycle.java | 20 +++++-----
.../qi4j/api/injection/scope/Invocation.java | 4 +-
.../org/qi4j/api/injection/scope/Service.java | 13 ++++---
.../org/qi4j/api/injection/scope/State.java | 8 ++--
.../org/qi4j/api/injection/scope/Structure.java | 7 ++--
.../java/org/qi4j/api/injection/scope/This.java | 6 ++-
.../qi4j/api/metrics/MetricsCounterFactory.java | 2 -
.../api/metrics/MetricsHealthCheckFactory.java | 1 -
.../api/metrics/MetricsHistogramFactory.java | 1 -
.../qi4j/api/metrics/MetricsTimerFactory.java | 1 -
.../main/java/org/qi4j/api/mixin/Mixins.java | 21 ++++++----
.../qi4j/api/property/PropertyDescriptor.java | 8 ++--
.../src/main/java/org/qi4j/api/query/Query.java | 5 ++-
.../org/qi4j/api/service/ServiceFinder.java | 14 +++++--
.../org/qi4j/api/service/qualifier/Active.java | 10 +++--
.../qi4j/api/service/qualifier/Available.java | 4 +-
.../qi4j/api/service/qualifier/HasMetaInfo.java | 21 ++++++----
.../api/service/qualifier/IdentifiedBy.java | 2 +-
.../api/service/qualifier/ServiceQualifier.java | 14 +++++--
.../org/qi4j/api/service/qualifier/Tagged.java | 4 +-
.../org/qi4j/api/service/qualifier/package.html | 12 +++---
.../org/qi4j/api/sideeffect/SideEffectOf.java | 6 ++-
.../org/qi4j/api/sideeffect/SideEffects.java | 1 -
.../api/sideeffect/internal/SideEffectFor.java | 19 ++++-----
.../org/qi4j/api/unitofwork/UnitOfWork.java | 8 +++-
.../qi4j/api/unitofwork/UnitOfWorkFactory.java | 27 ++++++-------
.../qi4j/api/unitofwork/UnitOfWorkOptions.java | 7 +++-
.../unitofwork/concern/UnitOfWorkDiscardOn.java | 20 ++++++----
.../concern/UnitOfWorkPropagation.java | 10 ++---
.../main/java/org/qi4j/api/util/Classes.java | 9 +++--
.../org/qi4j/api/value/ValueDeserializer.java | 2 +-
.../main/java/org/qi4j/bootstrap/Assembler.java | 4 +-
.../org/qi4j/bootstrap/AssemblerCollection.java | 3 +-
.../org/qi4j/bootstrap/AssemblyVisitor.java | 9 +++--
.../qi4j/bootstrap/AssociationDeclarations.java | 2 +-
.../java/org/qi4j/bootstrap/ClassScanner.java | 13 +++----
.../java/org/qi4j/bootstrap/Energy4Java.java | 9 +++--
.../org/qi4j/bootstrap/EntityDeclaration.java | 8 ++--
.../bootstrap/ManyAssociationDeclarations.java | 2 +-
.../java/org/qi4j/bootstrap/ModuleAssembly.java | 15 ++++---
.../bootstrap/NamedAssociationDeclarations.java | 2 +-
.../org/qi4j/bootstrap/SingletonAssembler.java | 2 +-
.../org/qi4j/bootstrap/StateDeclarations.java | 2 +-
.../main/java/org/qi4j/functional/ForEach.java | 5 ++-
.../java/org/qi4j/functional/Functions.java | 5 +--
core/io/src/main/java/org/qi4j/io/Input.java | 3 +-
core/io/src/main/java/org/qi4j/io/Outputs.java | 8 ++--
.../qi4j/runtime/injection/DependencyModel.java | 21 +++++++---
.../ImportedServiceReferenceInstance.java | 4 +-
.../service/ServiceReferenceInstance.java | 10 +++--
.../test/composite/CleanStackTraceTest.java | 3 +-
.../java/org/qi4j/spi/entity/EntityState.java | 8 ++--
.../ConcurrentModificationCheckConcern.java | 3 +-
.../spi/entitystore/EntityStoreUnitOfWork.java | 4 +-
.../spi/entitystore/helpers/MapEntityStore.java | 1 +
.../spi/value/ValueDeserializerAdapter.java | 2 +-
.../org/qi4j/test/AbstractQi4jBaseTest.java | 4 +-
.../org/qi4j/test/AbstractQi4jScenarioTest.java | 10 +++--
.../file/FileEntityStoreConfiguration.java | 3 +-
.../entitystore/jdbm/JdbmConfiguration.java | 4 +-
.../prefs/PreferencesEntityStoreService.java | 16 +++++---
.../index/sql/SQLIndexingEngineService.java | 3 +-
.../org/qi4j/library/alarm/AlarmHistory.java | 4 +-
.../org/qi4j/library/alarm/AlarmNameFormat.java | 4 +-
.../java/org/qi4j/library/alarm/AlarmPoint.java | 34 +++++++++-------
.../alarm/ExtendedAlarmModelService.java | 9 ++---
.../library/alarm/SimpleAlarmModelService.java | 6 +--
.../alarm/StandardAlarmModelService.java | 7 ++--
.../rest/server/DomainEventSourceResource.java | 8 +++-
.../application/api/ApplicationEvent.java | 11 ++++--
.../source/ApplicationEventSource.java | 21 ++++++----
.../helper/ApplicationTransactionTracker.java | 9 +++--
.../domain/api/DomainEventValue.java | 8 ++--
.../domain/source/EventSource.java | 6 ++-
.../source/helper/DomainEventTracker.java | 8 +++-
.../library/fileconfig/FileConfiguration.java | 3 +-
.../library/http/SecureJettyConfiguration.java | 12 +++---
.../ReturnCachedValueOnExceptionConcern.java | 3 +-
.../qi4j/library/jmx/JMXConnectorService.java | 8 +++-
.../org/qi4j/lang/beanshell/BeanShellMixin.java | 5 ++-
.../java/org/qi4j/lang/groovy/GroovyMixin.java | 5 ++-
.../qi4j/lang/javascript/JavaScriptMixin.java | 5 ++-
.../java/org/qi4j/lang/jruby/JRubyMixin.java | 5 ++-
.../main/java/org/qi4j/logging/trace/Trace.java | 13 +++++--
.../org/qi4j/logging/trace/TraceAllConcern.java | 4 +-
.../org/qi4j/logging/trace/TraceConcern.java | 7 ++--
.../org/qi4j/library/osgi/FallbackStrategy.java | 4 +-
.../library/rest/client/api/ErrorHandler.java | 2 +-
.../api/constraint/InteractionValidation.java | 15 +++++--
.../library/rest/admin/EntitiesResource.java | 3 +-
.../org/qi4j/library/scheduler/Scheduler.java | 2 +-
.../bootstrap/Qi4jApplicationBootstrap.java | 29 +++++++-------
.../library/sql/common/SQLConfiguration.java | 2 +-
.../library/uowfile/singular/HasUoWFile.java | 1 +
.../infrastructure/WicketQi4jApplication.java | 4 +-
.../testing/ExpectedException.java | 25 ++++++++----
.../moneytransfer/context/PayBillsContext.java | 41 +++++++++++++-------
.../moneytransfer/context/PayBillsContext2.java | 37 +++++++++++++-----
.../samples/cargo/app1/model/cargo/Cargo.java | 37 +++++++++++-------
.../PostgreSQLEntityStorePerformanceTest.java | 6 ++-
.../composite/InvocationPerformanceTest.java | 6 ++-
.../PropertyMixinInvocationPerformanceTest.java | 3 +-
.../org/qi4j/envisage/tree/TreeModelPane.java | 8 ++--
.../org/qi4j/tutorials/composites/package.html | 6 ++-
.../tutorials/composites/tutorial1/package.html | 12 ++++--
.../tutorial10/HelloWorldComposite.java | 6 +--
.../tutorials/composites/tutorial2/package.html | 9 +++--
.../tutorial3/HelloWorldComposite.java | 6 +--
.../tutorials/composites/tutorial3/package.html | 6 ++-
.../tutorial4/HelloWorldBehaviour.java | 6 +--
.../tutorial4/HelloWorldBehaviourMixin.java | 6 +--
.../tutorial4/HelloWorldComposite.java | 3 +-
.../tutorials/composites/tutorial4/package.html | 15 ++++---
.../tutorial5/HelloWorldBehaviour.java | 3 +-
.../tutorial5/HelloWorldBehaviourMixin.java | 3 +-
.../tutorial5/HelloWorldComposite.java | 3 +-
.../composites/tutorial5/HelloWorldState.java | 3 +-
.../tutorials/composites/tutorial5/package.html | 22 +++++++----
.../tutorial6/HelloWorldBehaviour.java | 3 +-
.../tutorial6/HelloWorldBehaviourMixin.java | 3 +-
.../tutorial6/HelloWorldComposite.java | 3 +-
.../composites/tutorial6/HelloWorldState.java | 3 +-
.../tutorials/composites/tutorial6/package.html | 15 ++++---
.../tutorial7/HelloWorldBehaviourMixin.java | 3 +-
.../tutorial7/HelloWorldComposite.java | 3 +-
.../composites/tutorial7/HelloWorldState.java | 3 +-
.../tutorials/composites/tutorial7/package.html | 22 ++++++++---
.../tutorial8/HelloWorldBehaviourMixin.java | 3 +-
.../composites/tutorial8/HelloWorldState.java | 3 +-
.../tutorials/composites/tutorial8/package.html | 15 ++++---
.../tutorial9/HelloWorldComposite.java | 3 +-
.../composites/tutorial9/HelloWorldState.java | 3 +-
.../tutorials/composites/tutorial9/package.html | 15 ++++---
.../composites/src/main/javadoc/overview.html | 11 +++---
.../java/org/qi4j/tutorials/hello/Hello.java | 1 -
152 files changed, 770 insertions(+), 494 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/zest-qi4j/blob/3bf71dfe/core/api/src/main/java/org/qi4j/api/activation/Activator.java
----------------------------------------------------------------------
diff --git a/core/api/src/main/java/org/qi4j/api/activation/Activator.java b/core/api/src/main/java/org/qi4j/api/activation/Activator.java
index 4c36d7f..2cba184 100644
--- a/core/api/src/main/java/org/qi4j/api/activation/Activator.java
+++ b/core/api/src/main/java/org/qi4j/api/activation/Activator.java
@@ -23,7 +23,7 @@ package org.qi4j.api.activation;
* @param <ActivateeType> Type of the activatee.
*
* @see ActivatorAdapter
- * @see ServiceActivation
+ * @see org.qi4j.api.service.ServiceActivation
*/
public interface Activator<ActivateeType>
{
http://git-wip-us.apache.org/repos/asf/zest-qi4j/blob/3bf71dfe/core/api/src/main/java/org/qi4j/api/activation/ActivatorAdapter.java
----------------------------------------------------------------------
diff --git a/core/api/src/main/java/org/qi4j/api/activation/ActivatorAdapter.java b/core/api/src/main/java/org/qi4j/api/activation/ActivatorAdapter.java
index 7eb8960..59652b9 100644
--- a/core/api/src/main/java/org/qi4j/api/activation/ActivatorAdapter.java
+++ b/core/api/src/main/java/org/qi4j/api/activation/ActivatorAdapter.java
@@ -19,7 +19,7 @@ package org.qi4j.api.activation;
/**
* Adapter for Activator.
- * <p>If you are thinking about Service activation, see {@link ServiceActivatorAdapter}.</p>
+ * <p>If you are thinking about Service activation, see {@link org.qi4j.api.service.ServiceActivatorAdapter}.</p>
*
* @param <ActivateeType> Type of the activatee.
*/
http://git-wip-us.apache.org/repos/asf/zest-qi4j/blob/3bf71dfe/core/api/src/main/java/org/qi4j/api/association/AssociationDescriptor.java
----------------------------------------------------------------------
diff --git a/core/api/src/main/java/org/qi4j/api/association/AssociationDescriptor.java b/core/api/src/main/java/org/qi4j/api/association/AssociationDescriptor.java
index c301c63..9f7576a 100644
--- a/core/api/src/main/java/org/qi4j/api/association/AssociationDescriptor.java
+++ b/core/api/src/main/java/org/qi4j/api/association/AssociationDescriptor.java
@@ -27,11 +27,20 @@ public interface AssociationDescriptor extends MetaInfoHolder
/**
* Get the qualified name of the association. This is constructed by
* concatenating the name of the declaring interface with the name
- * of the method, using ":" as separator. Example:<br/>
- * com.somecompany.MyInterface with association method<br/>
- * Association<String> someAssociation();<br/>
- * will have the qualified name:<br/>
+ * of the method, using ":" as separator.
+ * <p>
+ * Example:
+ * </p>
+ * <p>
+ * com.somecompany.MyInterface with association method
+ * </p>
+ * <pre><code>
+ * Association<String> someAssociation();
+ * </code></pre>
+ * will have the qualified name:
+ * <pre><code>
* com.somecompany.MyInterface:someAssociation
+ * </code></pre>
*
* @return the qualified name of the association
*/
http://git-wip-us.apache.org/repos/asf/zest-qi4j/blob/3bf71dfe/core/api/src/main/java/org/qi4j/api/common/AppliesTo.java
----------------------------------------------------------------------
diff --git a/core/api/src/main/java/org/qi4j/api/common/AppliesTo.java b/core/api/src/main/java/org/qi4j/api/common/AppliesTo.java
index d448aad..ccdff03 100644
--- a/core/api/src/main/java/org/qi4j/api/common/AppliesTo.java
+++ b/core/api/src/main/java/org/qi4j/api/common/AppliesTo.java
@@ -27,12 +27,12 @@ import java.lang.annotation.Target;
* annotation or implement a known interface should use this annotation.
* <p>
* @AppliesTo can specify one of;
+ * </p>
* <ul>
* <li>An annotation,</li>
* <li>An interface,</li>
* <li>An AppliesToFilter implementation.</li>
* </ul>
- * </p>
* <p>
* Example with annotation:
* </p>
http://git-wip-us.apache.org/repos/asf/zest-qi4j/blob/3bf71dfe/core/api/src/main/java/org/qi4j/api/common/AppliesToFilter.java
----------------------------------------------------------------------
diff --git a/core/api/src/main/java/org/qi4j/api/common/AppliesToFilter.java b/core/api/src/main/java/org/qi4j/api/common/AppliesToFilter.java
index 4d008f4..2a07c00 100644
--- a/core/api/src/main/java/org/qi4j/api/common/AppliesToFilter.java
+++ b/core/api/src/main/java/org/qi4j/api/common/AppliesToFilter.java
@@ -26,7 +26,8 @@ import java.lang.reflect.Method;
* <p>
* The starting point is the basic use of AppliesToFilter, where the @AppliesTo annotation is given an
* AppliesToFilter implementation as an argument, for instance at a Mixin implementation;
- * <pre></code>
+ * </p>
+ * <pre><code>
* @AppliesTo( MyAppliesToFilter.class )
* public class SomeMixin
* implements InvocationHandler
@@ -43,6 +44,7 @@ import java.lang.reflect.Method;
* }
* }
* </code></pre>
+ * <p>
* In the case above, the generic mixin will only be applied to the methods that that is defined by the
* AppliesToFilter. This is the primary way to define limits on the application of generic fragments, since
* especially mixins are rarely applied to all methods.
http://git-wip-us.apache.org/repos/asf/zest-qi4j/blob/3bf71dfe/core/api/src/main/java/org/qi4j/api/common/MetaInfo.java
----------------------------------------------------------------------
diff --git a/core/api/src/main/java/org/qi4j/api/common/MetaInfo.java b/core/api/src/main/java/org/qi4j/api/common/MetaInfo.java
index 3313e60..b746711 100644
--- a/core/api/src/main/java/org/qi4j/api/common/MetaInfo.java
+++ b/core/api/src/main/java/org/qi4j/api/common/MetaInfo.java
@@ -43,19 +43,19 @@ import static org.qi4j.api.util.Classes.typesOf;
* To set the MetaInfo on a Composite, call the {@code setMetaInfo()} methods on the various composite declaration
* types, such as;
* </p>
- * <code><pre>
+ * <pre><code>
* public void assemble( ModuleAssembly module )
* throws AssemblyException
* {
- * Map<String,String> properties = ...;
+ * Map<String,String> properties = ...;
* module.services( MyService.class ).setMetaInfo( properties );
* }
- * </pre></code>
+ * </code></pre>
* <p>
* which can later be retrieved by calling the {@code metaInfo()} method on the composite itself. For the example
* above that would be;
* </p>
- * <code><pre>
+ * <pre><code>
* @Mixins(MyServiceMixin.class)
* public interface MyService extends ServiceComposite
* {
@@ -72,8 +72,7 @@ import static org.qi4j.api.util.Classes.typesOf;
* props = metaInfo( Map.class );
* }
* }
- * </pre></code>
- * <p>
+ * </code></pre>
*/
public final class MetaInfo
{
http://git-wip-us.apache.org/repos/asf/zest-qi4j/blob/3bf71dfe/core/api/src/main/java/org/qi4j/api/common/UseDefaults.java
----------------------------------------------------------------------
diff --git a/core/api/src/main/java/org/qi4j/api/common/UseDefaults.java b/core/api/src/main/java/org/qi4j/api/common/UseDefaults.java
index bf0f008..0f61ea1 100644
--- a/core/api/src/main/java/org/qi4j/api/common/UseDefaults.java
+++ b/core/api/src/main/java/org/qi4j/api/common/UseDefaults.java
@@ -52,22 +52,22 @@ import java.lang.annotation.Target;
* Example;
* Let's assume that we have the following mixin type;
*
- * <code><pre>
+ * <pre><code>
* public interface SomeType
* {
* @UseDefaults
- * Property<String> someValue();
+ * Property<String> someValue();
* }
- * </pre></code>
+ * </code></pre>
* And that we want to have {@code someValue()} to be initialized to "<unknown>" instead of the empty string.
* Then we need to declare the default for that with the following in the assembler.
- * <code><pre>
+ * <pre><code>
* public void assemble( ModuleAssembly module )
* {
* module.forMixin( SomeType.class ).declareDefaults().someValue().set( "<unknown>" );
* }
* }
- * </pre></code>
+ * </code></pre>
*/
@Retention( RetentionPolicy.RUNTIME )
@Target( { ElementType.METHOD, ElementType.FIELD } )
http://git-wip-us.apache.org/repos/asf/zest-qi4j/blob/3bf71dfe/core/api/src/main/java/org/qi4j/api/composite/AmbiguousTypeException.java
----------------------------------------------------------------------
diff --git a/core/api/src/main/java/org/qi4j/api/composite/AmbiguousTypeException.java b/core/api/src/main/java/org/qi4j/api/composite/AmbiguousTypeException.java
index 79ef8b3..34f3653 100644
--- a/core/api/src/main/java/org/qi4j/api/composite/AmbiguousTypeException.java
+++ b/core/api/src/main/java/org/qi4j/api/composite/AmbiguousTypeException.java
@@ -23,7 +23,7 @@ package org.qi4j.api.composite;
* <p>
* For instance;
* </p>
- * <code><pre>
+ * <pre><code>
* public interface AbcComposite extends TransientComposite, Abc
* {}
*
@@ -38,7 +38,7 @@ package org.qi4j.api.composite;
*
*
* TransientBuilder cb = factory.newTransientBuilder( Abc.class );
- * </pre></code>
+ * </code></pre>
* <p>
* In the code above, both the AbcComposite and DefComposite implement Abc, and therefore
* the <code>newTransientBuilder</code> method can not unambiguously figure out which
http://git-wip-us.apache.org/repos/asf/zest-qi4j/blob/3bf71dfe/core/api/src/main/java/org/qi4j/api/composite/Composite.java
----------------------------------------------------------------------
diff --git a/core/api/src/main/java/org/qi4j/api/composite/Composite.java b/core/api/src/main/java/org/qi4j/api/composite/Composite.java
index d3155f3..91662fb 100644
--- a/core/api/src/main/java/org/qi4j/api/composite/Composite.java
+++ b/core/api/src/main/java/org/qi4j/api/composite/Composite.java
@@ -19,12 +19,14 @@ import org.qi4j.api.property.PropertyMixin;
/**
* Base Composite interface.
- *
+ * <p>
* All Composite objects must implement this interface. Let the
* Composite interface extend this one. An implementation will be provided
* by the framework.
- * <p/>
+ * </p>
+ * <p>
* Properties and associations are handled by default.
+ * </p>
*/
@Mixins( { PropertyMixin.class } )
public interface Composite
http://git-wip-us.apache.org/repos/asf/zest-qi4j/blob/3bf71dfe/core/api/src/main/java/org/qi4j/api/composite/CompositeInvoker.java
----------------------------------------------------------------------
diff --git a/core/api/src/main/java/org/qi4j/api/composite/CompositeInvoker.java b/core/api/src/main/java/org/qi4j/api/composite/CompositeInvoker.java
index e585a38..5bd8d11 100644
--- a/core/api/src/main/java/org/qi4j/api/composite/CompositeInvoker.java
+++ b/core/api/src/main/java/org/qi4j/api/composite/CompositeInvoker.java
@@ -17,12 +17,14 @@ import java.lang.reflect.Method;
/**
* Composite method invoker.
- *
+ * <p>
* All composites must implement this interface. Methods that are invoked
* may reside either in the public Composite interface or in any internal mixins.
- *
- * <b><i>NOTE:</i></i></b>Client code should never use method in this class. We have not been able to hide this
- * from client code, but IF we find a way to do, this interface may disappear.</b>
+ * </p>
+ * <p>
+ * <strong><i>NOTE:</i></strong>Client code should never use method in this class. We have not been able to hide this
+ * from client code, but IF we find a way to do, this interface may disappear.
+ * </p>
*/
public interface CompositeInvoker
{
http://git-wip-us.apache.org/repos/asf/zest-qi4j/blob/3bf71dfe/core/api/src/main/java/org/qi4j/api/composite/DecoratorMixin.java
----------------------------------------------------------------------
diff --git a/core/api/src/main/java/org/qi4j/api/composite/DecoratorMixin.java b/core/api/src/main/java/org/qi4j/api/composite/DecoratorMixin.java
index 9f50cc1..6b81844 100644
--- a/core/api/src/main/java/org/qi4j/api/composite/DecoratorMixin.java
+++ b/core/api/src/main/java/org/qi4j/api/composite/DecoratorMixin.java
@@ -26,10 +26,11 @@ import org.qi4j.api.injection.scope.Uses;
/**
* Generic decorator mixin that allows a Composite to wrap
* any other Composite as long as they share an interface.
- * <p/>
+ * <p>
* Can be used to effectively implement
* singleton mixins, since the decorated object can be shared between
* many instances.
+ * </p>
*/
public class DecoratorMixin
implements InvocationHandler
http://git-wip-us.apache.org/repos/asf/zest-qi4j/blob/3bf71dfe/core/api/src/main/java/org/qi4j/api/concern/ConcernOf.java
----------------------------------------------------------------------
diff --git a/core/api/src/main/java/org/qi4j/api/concern/ConcernOf.java b/core/api/src/main/java/org/qi4j/api/concern/ConcernOf.java
index 26d1460..33cdd01 100644
--- a/core/api/src/main/java/org/qi4j/api/concern/ConcernOf.java
+++ b/core/api/src/main/java/org/qi4j/api/concern/ConcernOf.java
@@ -23,11 +23,13 @@ import org.qi4j.api.concern.internal.ConcernFor;
* Base class for Concerns. It introduces a typed "next" pointer
* that Concerns can use to invoke the next Concern (or mixin) in
* the chain.
- * <p/>
+ * <p>
* Generic Concerns should subclass {@link GenericConcern} instead.
- * <p/>
+ * </p>
+ * <p>
* Concerns implementations must be thread-safe in their implementation,
* as multiple threads may share instances.
+ * </p>
*/
public abstract class ConcernOf<T>
{
http://git-wip-us.apache.org/repos/asf/zest-qi4j/blob/3bf71dfe/core/api/src/main/java/org/qi4j/api/concern/internal/ConcernFor.java
----------------------------------------------------------------------
diff --git a/core/api/src/main/java/org/qi4j/api/concern/internal/ConcernFor.java b/core/api/src/main/java/org/qi4j/api/concern/internal/ConcernFor.java
index df71f77..de3e1b4 100644
--- a/core/api/src/main/java/org/qi4j/api/concern/internal/ConcernFor.java
+++ b/core/api/src/main/java/org/qi4j/api/concern/internal/ConcernFor.java
@@ -25,27 +25,28 @@ import org.qi4j.api.injection.InjectionScope;
* This annotation is required once in each Concern, to mark the
* field where the next element in the call sequence should be
* injected.
- * <p/>
+ * <p>
* The type of the field must be of the same type as the Concern
* itself, or an InvocationHandler.
- * <p/>
- * <p/>
+ * </p>
+ * <p>
* Example;
+ * </p>
* <pre><code>
* public interface MyStuff
* {
* void doSomething();
* }
- * <p/>
+ *
* public class MyStuffConcern
* implements MyStuff
* {
* @ConcernFor MyStuff next;
- * <p/>
+ *
* public void doSomething()
* {
* // HERE DO THE MODIFIER STUFF.
- * <p/>
+ *
* // Delegate to the underlying mixin/modifier.
* next.doSomething();
* }
http://git-wip-us.apache.org/repos/asf/zest-qi4j/blob/3bf71dfe/core/api/src/main/java/org/qi4j/api/configuration/Configuration.java
----------------------------------------------------------------------
diff --git a/core/api/src/main/java/org/qi4j/api/configuration/Configuration.java b/core/api/src/main/java/org/qi4j/api/configuration/Configuration.java
index e2fbea7..52ec60f 100644
--- a/core/api/src/main/java/org/qi4j/api/configuration/Configuration.java
+++ b/core/api/src/main/java/org/qi4j/api/configuration/Configuration.java
@@ -39,15 +39,16 @@ import static org.qi4j.functional.Iterables.first;
/**
* Provide Configurations for Services. A Service that wants to be configurable
* should inject a reference to Configuration with the Configuration type:
- * <code><pre>
- * <p/>
- * @This Configuration<MyServiceConfiguration> config;
- * </pre></code>
+ * <pre><code>
+ * * @This Configuration<MyServiceConfiguration> config;
+ * </code></pre>
+ * <p>
* where MyServiceConfiguration extends {@link ConfigurationComposite}, which itself is an ordinary
* {@link org.qi4j.api.entity.EntityComposite}. The Configuration implementation
* will either locate an instance of the given Configuration type in the
* persistent store using the identity of the Service, or create a new such instance
* if one doesn't already exist.
+ * </p>
* <p>
* If a new Configuration instance is created then it will be populated with properties
* from the properties file whose filesystem name is the same as the identity (e.g. "MyService.properties").
@@ -68,6 +69,7 @@ import static org.qi4j.functional.Iterables.first;
* <p>
* The user configuration entity is part of a long running {@link UnitOfWork}, and to persist changes to it the
* {@link #save()} method must be called. No other actions are required. Example;
+ * </p>
* <pre><code>
*
* public interface MyConfiguration extends ConfigurationComposite
@@ -85,10 +87,12 @@ import static org.qi4j.functional.Iterables.first;
* config.save();
* }
* </code></pre>
+ * <p>
* And even if a separate thread is using the {@code timeout()} configuration when this is happening, the
* {@link UnitOfWork} isolation will ensure that the other thread is not affected. That thread, on the other hand
* will need to do a {@link #refresh()} at an appropriate time to pick up the timeout change. For instance;
- * <code><pre>
+ * </p>
+ * <pre><code>
*
* @Service InventoryService remoteInventoryService;
*
@@ -102,15 +106,14 @@ import static org.qi4j.functional.Iterables.first;
* :
* :
* }
- * </pre></code>
- * </p>
+ * </code></pre>
+ *
*/
@Mixins( Configuration.ConfigurationMixin.class )
public interface Configuration<T>
{
/**
* Retrieves the user configuration instance managed by this Configuration.
- * <p/>
* <p>
* Even if the user configuration is initialized from properties file, the consistency rules of Qi4j composites
* still applies. If the the properties file is missing a value, then the initialization will fail with a
@@ -132,9 +135,6 @@ public interface Configuration<T>
/**
* Persists the modified values in the user configuration instance to the underlying store.
- * <p>
- *
- * </p>
*/
void save();
http://git-wip-us.apache.org/repos/asf/zest-qi4j/blob/3bf71dfe/core/api/src/main/java/org/qi4j/api/constraint/ConstraintViolationException.java
----------------------------------------------------------------------
diff --git a/core/api/src/main/java/org/qi4j/api/constraint/ConstraintViolationException.java b/core/api/src/main/java/org/qi4j/api/constraint/ConstraintViolationException.java
index 76efa4c..28e41b3 100644
--- a/core/api/src/main/java/org/qi4j/api/constraint/ConstraintViolationException.java
+++ b/core/api/src/main/java/org/qi4j/api/constraint/ConstraintViolationException.java
@@ -38,10 +38,6 @@ import org.qi4j.functional.Iterables;
* violations, together with the Composite instance it happened on as well as the Method that
* was invoked. The Exception also has support for localized messages of these violations.
* </p>
- * <p>
- * <b>This class is still under evolution. Beware that the methods, formatting, Locale spec may
- * change. It will be stable before the 1.0 release.
- * </p>
*/
public class ConstraintViolationException
extends IllegalArgumentException
@@ -95,13 +91,15 @@ public class ConstraintViolationException
/**
* Creates localized messages of all the constraint violations that has occured.
- * <p/>
- * The key "<code>Qi4j_ConstraintViolation_<i><strong>CompositeType</strong></code></i>" will be used to lookup the text formatting
+ * <p>
+ * The key "<code>Qi4j_ConstraintViolation_<i><strong>CompositeType</strong></i></code>" will be used to lookup the text formatting
* pattern from the ResourceBundle, where <strong><code><i>CompositeType</i></code></strong> is the
* class name of the Composite where the constraint was violated. If such key does not exist, then the
* key "<code>Qi4j_ConstraintViolation</code>" will be used, and if that one also doesn't exist, or
* the resourceBundle argument is null, then the default patterns will be used;
- * <table><tr><th>Type of Composite</th><th>Pattern used</th></tr>
+ * </p>
+ * <table summary="Localization of constraint vioations.">
+ * <tr><th>Type of Composite</th><th>Pattern used</th></tr>
* <tr><td>Composite</td>
* <td><code>Constraint Violation in {2}.{3} with constraint {4}, in composite \n{0} of type {1}</code></td>
* </tr>
@@ -113,7 +111,7 @@ public class ConstraintViolationException
* </tr>
* </table>
* Then format each ConstraintViolation according to such pattern, where the following argument are passed;
- * <table><tr><th>Arg</th><th>Value</th></tr>
+ * <table summary="List of arguments available."><tr><th>Arg</th><th>Value</th></tr>
* <tr>
* <td>{0}</td>
* <td>Composite instance toString()</td>
@@ -139,8 +137,9 @@ public class ConstraintViolationException
* <td>toString() of value passed as the argument, or "null" text if argument was null.</td>
* </tr>
* </table>
- * <p/>
+ * <p>
* <b>NOTE!!!</b> This class is still under construction and will be modified further.
+ * </p>
*
* @param bundle The ResourceBundle for Localization, or null if default formatting and locale to be used.
*
@@ -183,7 +182,7 @@ public class ConstraintViolationException
String name = violation.name();
Object value = violation.value();
String classes;
- if( Iterables.count( instanceTypes) == 1 )
+ if( Iterables.count( instanceTypes ) == 1 )
{
classes = Iterables.first( instanceTypes ).getSimpleName();
}
http://git-wip-us.apache.org/repos/asf/zest-qi4j/blob/3bf71dfe/core/api/src/main/java/org/qi4j/api/constraint/Constraints.java
----------------------------------------------------------------------
diff --git a/core/api/src/main/java/org/qi4j/api/constraint/Constraints.java b/core/api/src/main/java/org/qi4j/api/constraint/Constraints.java
index 079df4c..b42701c 100644
--- a/core/api/src/main/java/org/qi4j/api/constraint/Constraints.java
+++ b/core/api/src/main/java/org/qi4j/api/constraint/Constraints.java
@@ -23,8 +23,9 @@ import java.lang.annotation.Target;
/**
* This annotation is used by composites and mixins to declare what Constraints
* can be applied in the Composite.
- * <p/>
+ * <p>
* Constraints implement the {@link Constraint} interface
+ * </p>
*/
@Retention( RetentionPolicy.RUNTIME )
@Target( { ElementType.TYPE } )
http://git-wip-us.apache.org/repos/asf/zest-qi4j/blob/3bf71dfe/core/api/src/main/java/org/qi4j/api/entity/Identity.java
----------------------------------------------------------------------
diff --git a/core/api/src/main/java/org/qi4j/api/entity/Identity.java b/core/api/src/main/java/org/qi4j/api/entity/Identity.java
index 9dce884..0c82ca9 100644
--- a/core/api/src/main/java/org/qi4j/api/entity/Identity.java
+++ b/core/api/src/main/java/org/qi4j/api/entity/Identity.java
@@ -29,10 +29,10 @@ public interface Identity
{
/**
* Returns the client view of the identity.
- * <p/>
+ * <p>
* It is unique within the owning repository, but potentially not unique globally and between
* types.
- *
+ * </p>
* @return The Identity of 'this' composite.
*/
@Immutable
http://git-wip-us.apache.org/repos/asf/zest-qi4j/blob/3bf71dfe/core/api/src/main/java/org/qi4j/api/entity/Lifecycle.java
----------------------------------------------------------------------
diff --git a/core/api/src/main/java/org/qi4j/api/entity/Lifecycle.java b/core/api/src/main/java/org/qi4j/api/entity/Lifecycle.java
index 0a7400e..650f456 100644
--- a/core/api/src/main/java/org/qi4j/api/entity/Lifecycle.java
+++ b/core/api/src/main/java/org/qi4j/api/entity/Lifecycle.java
@@ -16,21 +16,23 @@ package org.qi4j.api.entity;
/**
* Lifecycle interface for all Composites.
- * <p/>
+ * <p>
* This Lifecycle interface is a built-in feature of the Qi4j runtime, similar to the Initializable interface.
* Any Mixin that implements this interface AND is part of an EntityComposite will have these two methods called
* upon creation/removal of the EntityComposite instance to/from the EntityStore. Meaning, the create method is called
* only when the identifiable EntityComposite is created the first time, and not when it is read from its persisted
* state and created into memory.
- * <p/>
+ * </p>
+ * <p>
* Example;
- * <code><pre>
+ * </p>
+ * <pre><code>
* public interface System
* {
* Property<User> admin();
* }
*
- * public class SystemAdminMixin<LifeCycle>
+ * public class SystemAdminMixin<LifeCycle>
* implements System, Lifecyle, ...
* {
* @Structure private UnitOfWork uow;
@@ -54,17 +56,17 @@ package org.qi4j.api.entity;
* public interface SystemEntity extends System, EntityComposite
* {}
*
- * </pre></code>
+ * </code></pre>
*/
public interface Lifecycle
{
/**
* Creation callback method.
- * <p/>
+ * <p>
* Called by the Qi4j runtime before the newInstance of the entity completes, before the constraints are checked,
* allowing for additional initialization.
- *
+ * </p>
* @throws LifecycleException if the entity could not be created
*/
void create()
@@ -72,10 +74,10 @@ public interface Lifecycle
/**
* Removal callback method.
- * <p/>
+ * <p>
* Called by the Qi4j runtime before the entity is removed from the system, allowing
* for clean-up operations.
- *
+ * </p>
* @throws LifecycleException if the entity could not be removed
*/
void remove()
http://git-wip-us.apache.org/repos/asf/zest-qi4j/blob/3bf71dfe/core/api/src/main/java/org/qi4j/api/injection/scope/Invocation.java
----------------------------------------------------------------------
diff --git a/core/api/src/main/java/org/qi4j/api/injection/scope/Invocation.java b/core/api/src/main/java/org/qi4j/api/injection/scope/Invocation.java
index 3e0259b..230e5c9 100644
--- a/core/api/src/main/java/org/qi4j/api/injection/scope/Invocation.java
+++ b/core/api/src/main/java/org/qi4j/api/injection/scope/Invocation.java
@@ -35,11 +35,11 @@ import org.qi4j.api.injection.InjectionScope;
* - An Annotation of a specific type
* </code></pre>
* Examples:
- * <code><pre>
+ * <pre><code>
* @Invocation Method theInvokedMethod
* @Invocation AnnotationElement annotations
* @Invocation Matches matchesAnnotation
- * </pre></code>
+ * </code></pre>
*/
@Retention( RetentionPolicy.RUNTIME )
@Target( { ElementType.FIELD, ElementType.PARAMETER } )
http://git-wip-us.apache.org/repos/asf/zest-qi4j/blob/3bf71dfe/core/api/src/main/java/org/qi4j/api/injection/scope/Service.java
----------------------------------------------------------------------
diff --git a/core/api/src/main/java/org/qi4j/api/injection/scope/Service.java b/core/api/src/main/java/org/qi4j/api/injection/scope/Service.java
index 7c74a56..6116cc1 100644
--- a/core/api/src/main/java/org/qi4j/api/injection/scope/Service.java
+++ b/core/api/src/main/java/org/qi4j/api/injection/scope/Service.java
@@ -23,14 +23,15 @@ import org.qi4j.api.injection.InjectionScope;
/**
* Annotation to denote the injection of a service dependency into a Fragment.
- * <p/>
+ * <p>
* Examples:
- * <code><pre>
+ * </p>
+ * <pre><code>
* @Service MyService service
- * @Service Iterable<MyService> services
- * @Service ServiceReference<MyService> serviceRef
- * @Service Iterable<ServiceReference<MyService>> serviceRefs
- * </pre></code>
+ * @Service Iterable<MyService> services
+ * @Service ServiceReference<MyService> serviceRef
+ * @Service Iterable<ServiceReference<MyService>> serviceRefs
+ * </code></pre>
*/
@Retention( RetentionPolicy.RUNTIME )
@Target( { ElementType.FIELD, ElementType.PARAMETER } )
http://git-wip-us.apache.org/repos/asf/zest-qi4j/blob/3bf71dfe/core/api/src/main/java/org/qi4j/api/injection/scope/State.java
----------------------------------------------------------------------
diff --git a/core/api/src/main/java/org/qi4j/api/injection/scope/State.java b/core/api/src/main/java/org/qi4j/api/injection/scope/State.java
index 80ef8db..ec3c52a 100644
--- a/core/api/src/main/java/org/qi4j/api/injection/scope/State.java
+++ b/core/api/src/main/java/org/qi4j/api/injection/scope/State.java
@@ -24,10 +24,10 @@ import org.qi4j.api.injection.InjectionScope;
* Annotation to denote the injection of a property, association or
* StateHolder.
* <pre><code>
- * @State Property<String> propertyName;
- * @State Association<MyEntity> associationName;
- * @State ManyAssociation<MyEntity> manyAssociationName;
- * @State NamedAssociation<MyEntity> namedAssociationName;
+ * @State Property<StringState propertyName;
+ * @State Association<MyEntityState associationName;
+ * @State ManyAssociation<MyEntityState manyAssociationName;
+ * @State NamedAssociation<MyEntityState namedAssociationName;
* @State StateHolder state;
* @State AssociationStateHolder associationState;
* </code></pre>
http://git-wip-us.apache.org/repos/asf/zest-qi4j/blob/3bf71dfe/core/api/src/main/java/org/qi4j/api/injection/scope/Structure.java
----------------------------------------------------------------------
diff --git a/core/api/src/main/java/org/qi4j/api/injection/scope/Structure.java b/core/api/src/main/java/org/qi4j/api/injection/scope/Structure.java
index 80b741b..252af5e 100644
--- a/core/api/src/main/java/org/qi4j/api/injection/scope/Structure.java
+++ b/core/api/src/main/java/org/qi4j/api/injection/scope/Structure.java
@@ -25,9 +25,10 @@ import org.qi4j.api.injection.InjectionScope;
* Annotation to denote the injection of a
* resource specific for the module which the
* injected object/fragment is instantiated in.
- * <p/>
+ * <p>
* Valid types are:
- * <code><pre>
+ * </p>
+ * <pre><code>
* - TransientBuilderFactory
* - ObjectBuilderFactory
* - UnitOfWorkFactory
@@ -37,7 +38,7 @@ import org.qi4j.api.injection.InjectionScope;
* - Application
* - Qi4j
* - Qi4jSPI
- * </pre></code>
+ * </code></pre>
*/
@Retention( RetentionPolicy.RUNTIME )
@Target( { ElementType.FIELD, ElementType.PARAMETER } )
http://git-wip-us.apache.org/repos/asf/zest-qi4j/blob/3bf71dfe/core/api/src/main/java/org/qi4j/api/injection/scope/This.java
----------------------------------------------------------------------
diff --git a/core/api/src/main/java/org/qi4j/api/injection/scope/This.java b/core/api/src/main/java/org/qi4j/api/injection/scope/This.java
index 26ff7cb..4d806d0 100644
--- a/core/api/src/main/java/org/qi4j/api/injection/scope/This.java
+++ b/core/api/src/main/java/org/qi4j/api/injection/scope/This.java
@@ -24,12 +24,14 @@ import org.qi4j.api.injection.InjectionScope;
/**
* Annotation to denote the injection of a reference to the same Composite
* as the fragment is a part of.
- * <p/>
+ * <p>
* If the Composite type does not implement the type of the field or parameter
* then it will be referencing a private mixin.
- * <p/>
+ * </p>
+ * <p>
* Calls to the reference will have the same semantics as calls to the Composite itself.
* Specifically the same set of Modifiers will be used.
+ * </p>
*/
@Retention( RetentionPolicy.RUNTIME )
@Target( { ElementType.FIELD, ElementType.PARAMETER } )
http://git-wip-us.apache.org/repos/asf/zest-qi4j/blob/3bf71dfe/core/api/src/main/java/org/qi4j/api/metrics/MetricsCounterFactory.java
----------------------------------------------------------------------
diff --git a/core/api/src/main/java/org/qi4j/api/metrics/MetricsCounterFactory.java b/core/api/src/main/java/org/qi4j/api/metrics/MetricsCounterFactory.java
index 73d82fe..caa2915 100644
--- a/core/api/src/main/java/org/qi4j/api/metrics/MetricsCounterFactory.java
+++ b/core/api/src/main/java/org/qi4j/api/metrics/MetricsCounterFactory.java
@@ -29,8 +29,6 @@ public interface MetricsCounterFactory extends MetricsFactory
* @param name A human readable, short name of the metric.
*
* @return A Metric instance to be used, OR org.qi4j.spi.metrics.DefaultMetric.NULL if not supported.
- *
- * @see DefaultMetric
*/
MetricsCounter createCounter( Class<?> origin, String name );
}
http://git-wip-us.apache.org/repos/asf/zest-qi4j/blob/3bf71dfe/core/api/src/main/java/org/qi4j/api/metrics/MetricsHealthCheckFactory.java
----------------------------------------------------------------------
diff --git a/core/api/src/main/java/org/qi4j/api/metrics/MetricsHealthCheckFactory.java b/core/api/src/main/java/org/qi4j/api/metrics/MetricsHealthCheckFactory.java
index 12b913d..12decc5 100644
--- a/core/api/src/main/java/org/qi4j/api/metrics/MetricsHealthCheckFactory.java
+++ b/core/api/src/main/java/org/qi4j/api/metrics/MetricsHealthCheckFactory.java
@@ -31,7 +31,6 @@ public interface MetricsHealthCheckFactory extends MetricsFactory
*
* @return A MetricsHealthCheck instance to be used, OR org.qi4j.spi.metrics.DefaultMetric.NULL if not supported.
*
- * @see DefaultMetric
*/
MetricsHealthCheck registerHealthCheck( Class<?> origin, String name, MetricsHealthCheck check );
}
http://git-wip-us.apache.org/repos/asf/zest-qi4j/blob/3bf71dfe/core/api/src/main/java/org/qi4j/api/metrics/MetricsHistogramFactory.java
----------------------------------------------------------------------
diff --git a/core/api/src/main/java/org/qi4j/api/metrics/MetricsHistogramFactory.java b/core/api/src/main/java/org/qi4j/api/metrics/MetricsHistogramFactory.java
index c9f3f27..ab62508 100644
--- a/core/api/src/main/java/org/qi4j/api/metrics/MetricsHistogramFactory.java
+++ b/core/api/src/main/java/org/qi4j/api/metrics/MetricsHistogramFactory.java
@@ -30,7 +30,6 @@ public interface MetricsHistogramFactory extends MetricsFactory
*
* @return A Metric instance to be used, OR org.qi4j.spi.metrics.DefaultMetric.NULL if not supported.
*
- * @see DefaultMetric
*/
MetricsHistogram createHistogram( Class<?> origin, String name );
}
http://git-wip-us.apache.org/repos/asf/zest-qi4j/blob/3bf71dfe/core/api/src/main/java/org/qi4j/api/metrics/MetricsTimerFactory.java
----------------------------------------------------------------------
diff --git a/core/api/src/main/java/org/qi4j/api/metrics/MetricsTimerFactory.java b/core/api/src/main/java/org/qi4j/api/metrics/MetricsTimerFactory.java
index 0a6e9ed..18d3e38 100644
--- a/core/api/src/main/java/org/qi4j/api/metrics/MetricsTimerFactory.java
+++ b/core/api/src/main/java/org/qi4j/api/metrics/MetricsTimerFactory.java
@@ -34,7 +34,6 @@ public interface MetricsTimerFactory extends MetricsFactory
*
* @return A Metric instance to be used, OR org.qi4j.spi.metrics.DefaultMetric.NULL if not supported.
*
- * @see DefaultMetric
*/
MetricsTimer createTimer( Class<?> origin, String name, TimeUnit duration, TimeUnit rate );
}
http://git-wip-us.apache.org/repos/asf/zest-qi4j/blob/3bf71dfe/core/api/src/main/java/org/qi4j/api/mixin/Mixins.java
----------------------------------------------------------------------
diff --git a/core/api/src/main/java/org/qi4j/api/mixin/Mixins.java b/core/api/src/main/java/org/qi4j/api/mixin/Mixins.java
index 59078a0..e308381 100644
--- a/core/api/src/main/java/org/qi4j/api/mixin/Mixins.java
+++ b/core/api/src/main/java/org/qi4j/api/mixin/Mixins.java
@@ -23,45 +23,50 @@ import java.lang.annotation.Target;
/**
* This annotation is used in composites to declare mixin implementation classes.
- * <p/>
+ * <p>
* Mixins tells the runtime which implementation class of a Mixin should be
* used. The @Mixins annotation can occur at any level in the composite hierarchy
* and the runtime will match each found Mixin implementation against a Mixins annotation.
* All mixin interfaces must have a Mixin implementation in the composite hierarchy or
* a runtime exception will occur.
- * <p/>
+ * </p>
+ * <p>
* Example;
+ * </p>
* <pre><code>
- * <p/>
+ *
* @Mixins( MyBeerOrder.class )
* public interface BeerOrderComposite extends BeerOrder, Composite
* {
* }
- * <p/>
+ *
* public class MyBeerOrder
* implements BeerOrder
* {
* :
* }
* </code></pre>
- * <p/>
+ * <p>
* Many implementations can be listed,
+ * </p>
* <pre><code>
* @Mixins( { MyBeerOrder.class, DescriptionImpl.class } )
* public interface BeerOrderComposite extends BeerOrder, Description, Composite
* {
* }
* </code></pre>
- * <p/>
+ * <p>
* If the Mixins is a class that implements InvocationHandler, it will be
* used for all mixins. To avoid that an invocation handler based implementation
* not service all mixin, use the AppliesTo annotation.
- * <p/>
- * <p/>
+ * </p>
+ *
+ * <p>
* It is valid to have multiple Mixins for a mixin. The first one found
* will be used. The search order is in the order they are written in the Mixins
* annotation left-to-right, and depth-first recursive search of the super-interfaces again
* left-to-right.
+ * </p>
*
* @see org.qi4j.api.common.AppliesTo
*/
http://git-wip-us.apache.org/repos/asf/zest-qi4j/blob/3bf71dfe/core/api/src/main/java/org/qi4j/api/property/PropertyDescriptor.java
----------------------------------------------------------------------
diff --git a/core/api/src/main/java/org/qi4j/api/property/PropertyDescriptor.java b/core/api/src/main/java/org/qi4j/api/property/PropertyDescriptor.java
index 1d5fa6c..aa986b1 100644
--- a/core/api/src/main/java/org/qi4j/api/property/PropertyDescriptor.java
+++ b/core/api/src/main/java/org/qi4j/api/property/PropertyDescriptor.java
@@ -29,8 +29,10 @@ public interface PropertyDescriptor extends MetaInfoHolder
boolean isImmutable();
/**
- * Get the qualified name of the property which is equal to:<br/>
- * <interface name>:<method name>
+ * Get the qualified name of the property which is equal to:
+ * <pre><code>
+ * <interface name>:<method name>
+ * </code></pre>
*
* @return the qualified name of the property
*/
@@ -38,7 +40,7 @@ public interface PropertyDescriptor extends MetaInfoHolder
/**
* Get the type of the property. If the property is declared
- * as Property<X> then X is returned.
+ * as Property<X> then X is returned.
*
* @return the property type
*/
http://git-wip-us.apache.org/repos/asf/zest-qi4j/blob/3bf71dfe/core/api/src/main/java/org/qi4j/api/query/Query.java
----------------------------------------------------------------------
diff --git a/core/api/src/main/java/org/qi4j/api/query/Query.java b/core/api/src/main/java/org/qi4j/api/query/Query.java
index 78b7994..504b2e2 100644
--- a/core/api/src/main/java/org/qi4j/api/query/Query.java
+++ b/core/api/src/main/java/org/qi4j/api/query/Query.java
@@ -27,12 +27,15 @@ import org.qi4j.api.query.grammar.OrderBy;
/**
* This represents a Query in an indexing system. It is created from a
* {@link QueryBuilder}, which decides the "where" clause in the query.
+ * <p>
* Additional limitations, such as paging, ordering, and variables, can be set on
* a Query before it is executed by calling one of find(), iterator(),
* or count().
- * <p/>
+ * </p>
+ * <p>
* DDD tip: typically Queries are created in the Domain Model and passed to the UI,
* which sets the order and paging before executing it.
+ * </p>
*/
public interface Query<T>
extends Iterable<T>, Serializable
http://git-wip-us.apache.org/repos/asf/zest-qi4j/blob/3bf71dfe/core/api/src/main/java/org/qi4j/api/service/ServiceFinder.java
----------------------------------------------------------------------
diff --git a/core/api/src/main/java/org/qi4j/api/service/ServiceFinder.java b/core/api/src/main/java/org/qi4j/api/service/ServiceFinder.java
index 398c056..efaaff9 100644
--- a/core/api/src/main/java/org/qi4j/api/service/ServiceFinder.java
+++ b/core/api/src/main/java/org/qi4j/api/service/ServiceFinder.java
@@ -17,8 +17,11 @@ package org.qi4j.api.service;
import java.lang.reflect.Type;
/**
- * Interface used to query for ServiceReferences. Each ServiceFinder is
+ * Interface used to query for ServiceReferences.
+ * <p>
+ * Each ServiceFinder is
* obtained from a specific Module, and the lookup rules are the following:
+ * </p>
* <ol>
* <li>First look in the same Module as the ServiceFinder</li>
* <li>Then look in the same Layer as the ServiceFinder. Any Services declared
@@ -26,8 +29,9 @@ import java.lang.reflect.Type;
* <li>Then look in the used Layers. Any Services declared with Visibility Application
* should be included</li>
* </ol>
- *
+ * <p>
* Both native Qi4j services and imported services are considered, with preference to native services.
+ * </p>
*/
public interface ServiceFinder
{
@@ -57,9 +61,10 @@ public interface ServiceFinder
/**
* Find ServiceReferences that implements the given type.
- * <p/>
+ * <p>
* The order of the references is such that Services more local to the querying
* Module is earlier in the list.
+ * </p>
*
* @param serviceType the type that the Services must implement
*
@@ -69,9 +74,10 @@ public interface ServiceFinder
/**
* Find ServiceReferences that implements the given type.
- * <p/>
+ * <p>
* The order of the references is such that Services more local to the querying
* Module is earlier in the list.
+ * </p>
*
* @param serviceType the type that the Services must implement
*
http://git-wip-us.apache.org/repos/asf/zest-qi4j/blob/3bf71dfe/core/api/src/main/java/org/qi4j/api/service/qualifier/Active.java
----------------------------------------------------------------------
diff --git a/core/api/src/main/java/org/qi4j/api/service/qualifier/Active.java b/core/api/src/main/java/org/qi4j/api/service/qualifier/Active.java
index 4cbccf6..d06a749 100644
--- a/core/api/src/main/java/org/qi4j/api/service/qualifier/Active.java
+++ b/core/api/src/main/java/org/qi4j/api/service/qualifier/Active.java
@@ -21,13 +21,15 @@ import org.qi4j.functional.Specification;
/**
* Filter services based on whether they are active or not.
- *
+ * <p>
* At an injection point you can do this:
- *
+ * </p>
* <pre><code>
- * @Service @Active MyService service;
+ * @Service @Active MyService service;
* </code></pre>
+ * <p>
* to get only a service that is currently active.
+ * </p>
*/
@Retention( RetentionPolicy.RUNTIME )
@Qualifier( Active.ActiveQualifier.class )
@@ -35,7 +37,7 @@ public @interface Active
{
/**
* Active Annotation Qualifier.
- * See {@see Active}.
+ * See {@link Active}.
*/
public final class ActiveQualifier
implements AnnotationQualifier<Active>
http://git-wip-us.apache.org/repos/asf/zest-qi4j/blob/3bf71dfe/core/api/src/main/java/org/qi4j/api/service/qualifier/Available.java
----------------------------------------------------------------------
diff --git a/core/api/src/main/java/org/qi4j/api/service/qualifier/Available.java b/core/api/src/main/java/org/qi4j/api/service/qualifier/Available.java
index e8c23bb..894451d 100644
--- a/core/api/src/main/java/org/qi4j/api/service/qualifier/Available.java
+++ b/core/api/src/main/java/org/qi4j/api/service/qualifier/Available.java
@@ -25,7 +25,7 @@ import org.qi4j.functional.Specification;
* At an injection point you can do this:
*
* <pre><code>
- * @Service @Available MyService service;
+ * @Service @Available MyService service;
* </code></pre>
* to get only a service that is currently available.
*/
@@ -35,7 +35,7 @@ public @interface Available
{
/**
* Available Annotation Qualifier.
- * See {@see Available}.
+ * See {@link Available}.
*/
public final class AvailableQualifier
implements AnnotationQualifier<Available>
http://git-wip-us.apache.org/repos/asf/zest-qi4j/blob/3bf71dfe/core/api/src/main/java/org/qi4j/api/service/qualifier/HasMetaInfo.java
----------------------------------------------------------------------
diff --git a/core/api/src/main/java/org/qi4j/api/service/qualifier/HasMetaInfo.java b/core/api/src/main/java/org/qi4j/api/service/qualifier/HasMetaInfo.java
index 85087a3..aac0702 100644
--- a/core/api/src/main/java/org/qi4j/api/service/qualifier/HasMetaInfo.java
+++ b/core/api/src/main/java/org/qi4j/api/service/qualifier/HasMetaInfo.java
@@ -20,17 +20,22 @@ import org.qi4j.api.service.ServiceReference;
import org.qi4j.functional.Specification;
/**
- * Filter services based on Meta Info being declared on the Service. Meta Info of any type can be set on the service
- * during assembly, e.g.;
- * <code><pre>
+ * Filter services based on Meta Info being declared on the Service.
+ * <p>
+ * Meta Info of any type can be set on the service during assembly, e.g.;
+ * </p>
+ * <pre><code>
* module.addService( MyService.class ).setMetaInfo( new MyCustomInfo(someData) );
- * </pre></code>
- * <p/>
+ * </code></pre>
+ * <p>
* and then at an injection point you can do this:
- * <code><pre>
+ * </p>
+ * <pre><code>
* @Service @HasMetaInfo(MyCustomInfo.class) MyService service;
- * </pre></code>
+ * </code></pre>
+ * <p>
* to get only a service that has a MyCustomInfo instance set as meta info.
+ * </p>
*/
@Retention( RetentionPolicy.RUNTIME )
@Qualifier( HasMetaInfo.HasMetaInfoQualifier.class )
@@ -57,7 +62,7 @@ public @interface HasMetaInfo
/**
* HasMetaInfo Annotation Qualifier.
- * See {@see HasMetaInfo}.
+ * See {@link HasMetaInfo}.
*/
public static class HasMetaInfoQualifier
implements AnnotationQualifier<HasMetaInfo>
http://git-wip-us.apache.org/repos/asf/zest-qi4j/blob/3bf71dfe/core/api/src/main/java/org/qi4j/api/service/qualifier/IdentifiedBy.java
----------------------------------------------------------------------
diff --git a/core/api/src/main/java/org/qi4j/api/service/qualifier/IdentifiedBy.java b/core/api/src/main/java/org/qi4j/api/service/qualifier/IdentifiedBy.java
index 1e30038..2c715d7 100644
--- a/core/api/src/main/java/org/qi4j/api/service/qualifier/IdentifiedBy.java
+++ b/core/api/src/main/java/org/qi4j/api/service/qualifier/IdentifiedBy.java
@@ -39,7 +39,7 @@ public @interface IdentifiedBy
/**
* IdentifiedBy Annotation Qualifier.
- * See {@see IdentifiedBy}.
+ * See {@link IdentifiedBy}.
*/
public final class IdentifiedByQualifier
implements AnnotationQualifier<IdentifiedBy>
http://git-wip-us.apache.org/repos/asf/zest-qi4j/blob/3bf71dfe/core/api/src/main/java/org/qi4j/api/service/qualifier/ServiceQualifier.java
----------------------------------------------------------------------
diff --git a/core/api/src/main/java/org/qi4j/api/service/qualifier/ServiceQualifier.java b/core/api/src/main/java/org/qi4j/api/service/qualifier/ServiceQualifier.java
index a43a0b8..75410d6 100644
--- a/core/api/src/main/java/org/qi4j/api/service/qualifier/ServiceQualifier.java
+++ b/core/api/src/main/java/org/qi4j/api/service/qualifier/ServiceQualifier.java
@@ -19,20 +19,26 @@ import org.qi4j.functional.Specification;
/**
* This class helps you select a particular service
- * from a list. Provide a Selector which does the actual
+ * from a list.
+ * <p>
+ * Provide a Selector which does the actual
* selection from the list. A common case is to select
* based on identity of the service, which you can do this way:
+ * </p>
*
* <pre><code>
- * new ServiceQualifier<MyService>(services, ServiceQualifier.withId("someId"))
+ * new ServiceQualifier<MyService>(services, ServiceQualifier.withId("someId"))
* </code></pre>
- *
+ * <p>
* Many selectors can be combined by using firstOf. Example:
+ * </p>
* <pre><code>
- * new ServiceQualifier<MyService>(services, firstOf(withTags("sometag"), firstActive(), first()))
+ * new ServiceQualifier<MyService>(services, firstOf(withTags("sometag"), firstActive(), first()))
* </code></pre>
+ * <p>
* This will pick a service that has the tag "sometag", or if none is found take the first active one. If no
* service is active, then the first service will be picked.
+ * </p>
*/
public abstract class ServiceQualifier
{
http://git-wip-us.apache.org/repos/asf/zest-qi4j/blob/3bf71dfe/core/api/src/main/java/org/qi4j/api/service/qualifier/Tagged.java
----------------------------------------------------------------------
diff --git a/core/api/src/main/java/org/qi4j/api/service/qualifier/Tagged.java b/core/api/src/main/java/org/qi4j/api/service/qualifier/Tagged.java
index 33f5a02..3c8c0b7 100644
--- a/core/api/src/main/java/org/qi4j/api/service/qualifier/Tagged.java
+++ b/core/api/src/main/java/org/qi4j/api/service/qualifier/Tagged.java
@@ -28,7 +28,7 @@ import org.qi4j.functional.Specification;
* and then at an injection point you can do this:
*
* <pre><code>
- * @Service @Tagged("onetag") MyService service;
+ * @Service @Tagged("onetag") MyService service;
* </code></pre>
* to get only a service tagged with MyService. If several match only the first match is used.
*/
@@ -40,7 +40,7 @@ public @interface Tagged
/**
* Tagged Annotation Qualifier.
- * See {@see Tagged}.
+ * See {@link Tagged}.
*/
public final class TaggedQualifier
implements AnnotationQualifier<Tagged>
http://git-wip-us.apache.org/repos/asf/zest-qi4j/blob/3bf71dfe/core/api/src/main/java/org/qi4j/api/service/qualifier/package.html
----------------------------------------------------------------------
diff --git a/core/api/src/main/java/org/qi4j/api/service/qualifier/package.html b/core/api/src/main/java/org/qi4j/api/service/qualifier/package.html
index 1647b16..103541e 100644
--- a/core/api/src/main/java/org/qi4j/api/service/qualifier/package.html
+++ b/core/api/src/main/java/org/qi4j/api/service/qualifier/package.html
@@ -27,16 +27,16 @@
</blockquote>
<p>
Let's say these SomeImportedService are only sometimes available. Then whenever iterator() is called the
- {@see org.qi4j.api.service.qualifier.Active} tag can kick in and filter out those whose
+ {@link org.qi4j.api.service.qualifier.Active} tag can kick in and filter out those whose
ServiceReference.isActive() returns false.
</p>
<p>Standard ones defined in the API are:</p>
<ul>
- <li>{@see org.qi4j.api.service.qualifier.Active}</li>
- <li>{@see org.qi4j.api.service.qualifier.Available}</li>
- <li>{@see org.qi4j.api.service.qualifier.HasMetaInfo}</li>
- <li>{@see org.qi4j.api.service.qualifier.IdentifiedBy}</li>
- <li>{@see org.qi4j.api.service.qualifier.Tagged}</li>
+ <li>{@link org.qi4j.api.service.qualifier.Active}</li>
+ <li>{@link org.qi4j.api.service.qualifier.Available}</li>
+ <li>{@link org.qi4j.api.service.qualifier.HasMetaInfo}</li>
+ <li>{@link org.qi4j.api.service.qualifier.IdentifiedBy}</li>
+ <li>{@link org.qi4j.api.service.qualifier.Tagged}</li>
</ul>
<p>See tests and API for more examples, and how to implement your own qualifiers.</p>
</body>
http://git-wip-us.apache.org/repos/asf/zest-qi4j/blob/3bf71dfe/core/api/src/main/java/org/qi4j/api/sideeffect/SideEffectOf.java
----------------------------------------------------------------------
diff --git a/core/api/src/main/java/org/qi4j/api/sideeffect/SideEffectOf.java b/core/api/src/main/java/org/qi4j/api/sideeffect/SideEffectOf.java
index f1a73a4..39113cc 100644
--- a/core/api/src/main/java/org/qi4j/api/sideeffect/SideEffectOf.java
+++ b/core/api/src/main/java/org/qi4j/api/sideeffect/SideEffectOf.java
@@ -22,11 +22,13 @@ import org.qi4j.api.sideeffect.internal.SideEffectFor;
/**
* Base class for SideEffects. It introduces a typed "next" pointer
* that SideEffects can use to get the result of the original invocation.
- * <p/>
+ * <p>
* Generic SideEffects should subclass {@link GenericSideEffect} instead.
- * <p/>
+ * </p>
+ * <p>
* SideEffects implementations must be thread-safe in their implementation,
* as multiple threads may share instances.
+ * </p>
*/
public abstract class SideEffectOf<T>
{
http://git-wip-us.apache.org/repos/asf/zest-qi4j/blob/3bf71dfe/core/api/src/main/java/org/qi4j/api/sideeffect/SideEffects.java
----------------------------------------------------------------------
diff --git a/core/api/src/main/java/org/qi4j/api/sideeffect/SideEffects.java b/core/api/src/main/java/org/qi4j/api/sideeffect/SideEffects.java
index e218f61..bd2e525 100644
--- a/core/api/src/main/java/org/qi4j/api/sideeffect/SideEffects.java
+++ b/core/api/src/main/java/org/qi4j/api/sideeffect/SideEffects.java
@@ -23,7 +23,6 @@ import java.lang.annotation.Target;
/**
* This annotation is used by composites and mixins to declare what SideEffects
* should apply to the type or specific method.
- * <p/>
*/
@Retention( RetentionPolicy.RUNTIME )
@Target( { ElementType.TYPE, ElementType.METHOD } )
http://git-wip-us.apache.org/repos/asf/zest-qi4j/blob/3bf71dfe/core/api/src/main/java/org/qi4j/api/sideeffect/internal/SideEffectFor.java
----------------------------------------------------------------------
diff --git a/core/api/src/main/java/org/qi4j/api/sideeffect/internal/SideEffectFor.java b/core/api/src/main/java/org/qi4j/api/sideeffect/internal/SideEffectFor.java
index 3193516..1ab3383 100644
--- a/core/api/src/main/java/org/qi4j/api/sideeffect/internal/SideEffectFor.java
+++ b/core/api/src/main/java/org/qi4j/api/sideeffect/internal/SideEffectFor.java
@@ -25,36 +25,37 @@ import org.qi4j.api.injection.InjectionScope;
* This annotation is required once in each SideEffect, to mark the
* field where the element providing the invocation result should be
* injected.
- * <p/>
+ * <p>
* The type of the field must be of the same type as the SideEffect
* itself, or an InvocationHandler.
- * <p/>
- * <p/>
+ * </p>
+ * <p>
* Example;
+ * </p>
* <pre><code>
* public interface MyStuff
* {
* SomeResult doSomething();
* }
- * <p/>
+ *
* public class MyStuffSideEffect
* implements MyStuff
* {
* @SideEffectFor MyStuff next;
- * <p/>
+ *
* public SomeResult doSomething()
* {
* SomeResult result = next.doSomething();
- * <p/>
+ *
* // HERE DO THE SIDEEFFECT STUFF.
- * <p/>
+ *
* return result; // Result value is ignored, null would work too.
* }
* }
* </code></pre>
*/
-@Retention( RetentionPolicy.RUNTIME )
-@Target( { ElementType.FIELD, ElementType.PARAMETER } )
+@Retention(RetentionPolicy.RUNTIME)
+@Target({ ElementType.FIELD, ElementType.PARAMETER })
@Documented
@InjectionScope
public @interface SideEffectFor
http://git-wip-us.apache.org/repos/asf/zest-qi4j/blob/3bf71dfe/core/api/src/main/java/org/qi4j/api/unitofwork/UnitOfWork.java
----------------------------------------------------------------------
diff --git a/core/api/src/main/java/org/qi4j/api/unitofwork/UnitOfWork.java b/core/api/src/main/java/org/qi4j/api/unitofwork/UnitOfWork.java
index 68cccf6..8af1db2 100644
--- a/core/api/src/main/java/org/qi4j/api/unitofwork/UnitOfWork.java
+++ b/core/api/src/main/java/org/qi4j/api/unitofwork/UnitOfWork.java
@@ -101,12 +101,16 @@ public interface UnitOfWork extends MetaInfoHolder, AutoCloseable
// DataSet newDataSetBuilder(Specification<?>... constraints);
/**
- * Create a new Entity which implements the given mixin type. An EntityComposite
+ * Create a new Entity which implements the given mixin type.
+ * <p>
+ * An EntityComposite
* will be chosen according to what has been registered and the visibility rules
* for Modules and Layers will be considered. If several
* EntityComposites implement the type then an AmbiguousTypeException will be thrown.
- * <p/>
+ * </p>
+ * <p>
* The identity of the Entity will be generated by the IdentityGenerator of the Module of the EntityComposite.
+ * </p>
*
* @param type the mixin type that the EntityComposite must implement
*
http://git-wip-us.apache.org/repos/asf/zest-qi4j/blob/3bf71dfe/core/api/src/main/java/org/qi4j/api/unitofwork/UnitOfWorkFactory.java
----------------------------------------------------------------------
diff --git a/core/api/src/main/java/org/qi4j/api/unitofwork/UnitOfWorkFactory.java b/core/api/src/main/java/org/qi4j/api/unitofwork/UnitOfWorkFactory.java
index 10c3063..a8755d4 100644
--- a/core/api/src/main/java/org/qi4j/api/unitofwork/UnitOfWorkFactory.java
+++ b/core/api/src/main/java/org/qi4j/api/unitofwork/UnitOfWorkFactory.java
@@ -23,33 +23,31 @@ import org.qi4j.api.usecase.Usecase;
public interface UnitOfWorkFactory
{
/**
- * Create a new UnitOfWork and associate
- * it with the current thread.
- * <p/>
+ * Create a new UnitOfWork and associate it with the current thread.
+ * <p>
* The UnitOfWork will use the default Usecase settings.
- * <p/>
+ * </p>
+ * <p>
* Current time will be set to System.currentTimeMillis();
- *
+ * </p>
* @return a new UnitOfWork
*/
UnitOfWork newUnitOfWork();
/**
- * Create a new UnitOfWork and associate
- * it with the current thread.
- * <p/>
+ * Create a new UnitOfWork and associate it with the current thread.
+ * <p>
* The UnitOfWork will use the default Usecase settings.
- *
+ * </p>
* @return a new UnitOfWork
*/
UnitOfWork newUnitOfWork( long currentTime );
/**
- * Create a new UnitOfWork for the given Usecase and
- * associate it with the current thread.
- * <p/>
+ * Create a new UnitOfWork for the given Usecase and associate it with the current thread.
+ * <p>
* Current time will be set to System.currentTimeMillis();
- *
+ * </p>
* @param usecase the Usecase for this UnitOfWork
*
* @return a new UnitOfWork
@@ -57,8 +55,7 @@ public interface UnitOfWorkFactory
UnitOfWork newUnitOfWork( Usecase usecase );
/**
- * Create a new UnitOfWork for the given Usecase and
- * associate it with the current thread.
+ * Create a new UnitOfWork for the given Usecase and associate it with the current thread.
*
* @param usecase the Usecase for this UnitOfWork
*
http://git-wip-us.apache.org/repos/asf/zest-qi4j/blob/3bf71dfe/core/api/src/main/java/org/qi4j/api/unitofwork/UnitOfWorkOptions.java
----------------------------------------------------------------------
diff --git a/core/api/src/main/java/org/qi4j/api/unitofwork/UnitOfWorkOptions.java b/core/api/src/main/java/org/qi4j/api/unitofwork/UnitOfWorkOptions.java
index ee74cdb..1150854 100644
--- a/core/api/src/main/java/org/qi4j/api/unitofwork/UnitOfWorkOptions.java
+++ b/core/api/src/main/java/org/qi4j/api/unitofwork/UnitOfWorkOptions.java
@@ -2,9 +2,12 @@ package org.qi4j.api.unitofwork;
/**
* Set instances of this in MetaInfo on UnitOfWork or the associated Usecase.
- *
- * Options: <br/>
+ * <p>
+ * Options:
+ * </p>
+ * <p>
* "pruneOnPause": if true, then clear out all instances that have been loaded in the UoW but not modified
+ * </p>
*/
public class UnitOfWorkOptions
{
http://git-wip-us.apache.org/repos/asf/zest-qi4j/blob/3bf71dfe/core/api/src/main/java/org/qi4j/api/unitofwork/concern/UnitOfWorkDiscardOn.java
----------------------------------------------------------------------
diff --git a/core/api/src/main/java/org/qi4j/api/unitofwork/concern/UnitOfWorkDiscardOn.java b/core/api/src/main/java/org/qi4j/api/unitofwork/concern/UnitOfWorkDiscardOn.java
index 919683e..3668736 100644
--- a/core/api/src/main/java/org/qi4j/api/unitofwork/concern/UnitOfWorkDiscardOn.java
+++ b/core/api/src/main/java/org/qi4j/api/unitofwork/concern/UnitOfWorkDiscardOn.java
@@ -23,35 +23,39 @@ import static java.lang.annotation.RetentionPolicy.RUNTIME;
/**
* Annotation to denote the unit of work discard policy.
+ * <p>
* By default, discard is applied on any method that has {@link UnitOfWorkPropagation} and any exception is thrown.
- * <p/>
+ * </p>
+ * <p>
* Apply {@code UnitOfWorkDiscardOn} to override the default settings.
- * <p/>
- * <p/>
+ * </p>
+ * <p>
* Usage example:
+ * </p>
* <pre>
* <code>
- * <p/>
+ *
* @Concerns( UnitOfWorkConcern.class )
* public class MyBusinessServiceMixin implements BusinessService
* {
* @Structure UnitOfWorkFactory uowf;
- * <p/>
+ *
* @UnitOfWorkDiscardOn( MyBusinessException.class )
* public void myBusinessMethod()
* {
* // Must invoke current unit of work.
* UnitOfWork uow = uowf.currentUnitOfWork();
- * <p/>
+ *
* // Perform business logic
* }
* }
* </code>
* </pre>
- * <p/>
- * <p/>
+ *
+ * <p>
* The unit of work will be discarded iff {@code MyBusinessException} exceptions or its subclass is thrown from within
* {@code myBusinessMethod} method.
+ * </p>
*/
@Retention( RUNTIME )
@Target( METHOD )
http://git-wip-us.apache.org/repos/asf/zest-qi4j/blob/3bf71dfe/core/api/src/main/java/org/qi4j/api/unitofwork/concern/UnitOfWorkPropagation.java
----------------------------------------------------------------------
diff --git a/core/api/src/main/java/org/qi4j/api/unitofwork/concern/UnitOfWorkPropagation.java b/core/api/src/main/java/org/qi4j/api/unitofwork/concern/UnitOfWorkPropagation.java
index 8a8b57e..4fe78b7 100644
--- a/core/api/src/main/java/org/qi4j/api/unitofwork/concern/UnitOfWorkPropagation.java
+++ b/core/api/src/main/java/org/qi4j/api/unitofwork/concern/UnitOfWorkPropagation.java
@@ -24,23 +24,23 @@ import static java.lang.annotation.RetentionPolicy.RUNTIME;
/**
* Annotation to denote the unit of work propagation.
- * <p/>
- * <p/>
+ * <p>
* Usage example:
+ * </p>
* <pre>
* <code>
- * <p/>
+ *
* @Concerns( UnitOfWorkConcern.class )
* public class MyBusinessServiceMixin implements BusinessService
* {
* @Structure UnitOfWorkFactory uowf;
- * <p/>
+ *
* @UnitOfWorkPropagation
* public void myBusinessMethod()
* {
* // Must invoke current unit of work.
* UnitOfWork uow = uowf.currentUnitOfWork();
- * <p/>
+ *
* // Perform business logic
* }
* }
http://git-wip-us.apache.org/repos/asf/zest-qi4j/blob/3bf71dfe/core/api/src/main/java/org/qi4j/api/util/Classes.java
----------------------------------------------------------------------
diff --git a/core/api/src/main/java/org/qi4j/api/util/Classes.java b/core/api/src/main/java/org/qi4j/api/util/Classes.java
index e4ccc11..9413f9e 100644
--- a/core/api/src/main/java/org/qi4j/api/util/Classes.java
+++ b/core/api/src/main/java/org/qi4j/api/util/Classes.java
@@ -546,11 +546,12 @@ public final class Classes
/**
* Get URI for a class name.
- * <p/>
+ * <p>
* Example:
- * Class name com.example.Foo$Bar
- * is converted to
- * URI urn:qi4j:com.example.Foo-Bar
+ * </p>
+ * <p>
+ * Class name com.example.Foo$Bar is converted to URI urn:qi4j:com.example.Foo-Bar
+ * </p>
*
* @param className class name
*
http://git-wip-us.apache.org/repos/asf/zest-qi4j/blob/3bf71dfe/core/api/src/main/java/org/qi4j/api/value/ValueDeserializer.java
----------------------------------------------------------------------
diff --git a/core/api/src/main/java/org/qi4j/api/value/ValueDeserializer.java b/core/api/src/main/java/org/qi4j/api/value/ValueDeserializer.java
index d17657d..175b176 100644
--- a/core/api/src/main/java/org/qi4j/api/value/ValueDeserializer.java
+++ b/core/api/src/main/java/org/qi4j/api/value/ValueDeserializer.java
@@ -64,7 +64,7 @@ import org.qi4j.functional.Function2;
* </p>
* <p>
* Having type information in the serialized payload allows to keep actual ValueComposite types and by so
- * circumvent {@link AmbiguousTypeException} when deserializing.
+ * circumvent {@link org.qi4j.api.composite.AmbiguousTypeException} when deserializing.
* </p>
*/
public interface ValueDeserializer
http://git-wip-us.apache.org/repos/asf/zest-qi4j/blob/3bf71dfe/core/bootstrap/src/main/java/org/qi4j/bootstrap/Assembler.java
----------------------------------------------------------------------
diff --git a/core/bootstrap/src/main/java/org/qi4j/bootstrap/Assembler.java b/core/bootstrap/src/main/java/org/qi4j/bootstrap/Assembler.java
index 10be43c..5914a87 100644
--- a/core/bootstrap/src/main/java/org/qi4j/bootstrap/Assembler.java
+++ b/core/bootstrap/src/main/java/org/qi4j/bootstrap/Assembler.java
@@ -28,13 +28,13 @@ public interface Assembler
* to register objects, composites, services etc. and
* the additional metadata that may exist for these
* artifacts.
- * <p/>
+ * <p>
* An Assembler may create new Modules by calling
* {@link org.qi4j.bootstrap.ModuleAssembly#layer()} and
* then {@link LayerAssembly#module(String)} (String)}.
* This allows an Assembler to bootstrap an entire Layer with
* more Modules.
- *
+ * </p>
* @param module the Module to assemble
*
* @throws AssemblyException thrown if the assembler tries to do something illegal
http://git-wip-us.apache.org/repos/asf/zest-qi4j/blob/3bf71dfe/core/bootstrap/src/main/java/org/qi4j/bootstrap/AssemblerCollection.java
----------------------------------------------------------------------
diff --git a/core/bootstrap/src/main/java/org/qi4j/bootstrap/AssemblerCollection.java b/core/bootstrap/src/main/java/org/qi4j/bootstrap/AssemblerCollection.java
index e75c39e..670d88b 100644
--- a/core/bootstrap/src/main/java/org/qi4j/bootstrap/AssemblerCollection.java
+++ b/core/bootstrap/src/main/java/org/qi4j/bootstrap/AssemblerCollection.java
@@ -20,8 +20,9 @@ import java.util.Collection;
/**
* Assembler that delegates to a collection of Assemblers.
- * <p/>
+ * <p>
* Makes it easy to collect and compose assemblers into bigger assemblers.
+ * </p>
*/
public final class AssemblerCollection
implements Assembler
http://git-wip-us.apache.org/repos/asf/zest-qi4j/blob/3bf71dfe/core/bootstrap/src/main/java/org/qi4j/bootstrap/AssemblyVisitor.java
----------------------------------------------------------------------
diff --git a/core/bootstrap/src/main/java/org/qi4j/bootstrap/AssemblyVisitor.java b/core/bootstrap/src/main/java/org/qi4j/bootstrap/AssemblyVisitor.java
index 0bf7703..c1afb59 100644
--- a/core/bootstrap/src/main/java/org/qi4j/bootstrap/AssemblyVisitor.java
+++ b/core/bootstrap/src/main/java/org/qi4j/bootstrap/AssemblyVisitor.java
@@ -15,10 +15,13 @@
package org.qi4j.bootstrap;
/**
- * Visitor interface to visit the whole or parts of an assembly. Implement this
- * interface and call visit() on ApplicationAssembly, LayerAssembly or ModuleAssembly.
- * <p/>
+ * Visitor interface to visit the whole or parts of an assembly.
+ * <p>
+ * Implement this interface and call visit() on ApplicationAssembly, LayerAssembly or ModuleAssembly.
+ * </p>
+ * <p>
* This can be used to, for example, add metadata to all entities, add concerns on composites, or similar.
+ * </p>
*/
public interface AssemblyVisitor<ThrowableType extends Throwable>
{
http://git-wip-us.apache.org/repos/asf/zest-qi4j/blob/3bf71dfe/core/bootstrap/src/main/java/org/qi4j/bootstrap/AssociationDeclarations.java
----------------------------------------------------------------------
diff --git a/core/bootstrap/src/main/java/org/qi4j/bootstrap/AssociationDeclarations.java b/core/bootstrap/src/main/java/org/qi4j/bootstrap/AssociationDeclarations.java
index 86c0197..59724ca 100644
--- a/core/bootstrap/src/main/java/org/qi4j/bootstrap/AssociationDeclarations.java
+++ b/core/bootstrap/src/main/java/org/qi4j/bootstrap/AssociationDeclarations.java
@@ -18,7 +18,7 @@ import java.lang.reflect.AccessibleObject;
import org.qi4j.api.common.MetaInfo;
/**
- * This provides declared {@see org.qi4j.api.association.Association} information that the runtime can use.
+ * This provides declared {@link org.qi4j.api.association.Association} information that the runtime can use.
*/
public interface AssociationDeclarations
{
http://git-wip-us.apache.org/repos/asf/zest-qi4j/blob/3bf71dfe/core/bootstrap/src/main/java/org/qi4j/bootstrap/ClassScanner.java
----------------------------------------------------------------------
diff --git a/core/bootstrap/src/main/java/org/qi4j/bootstrap/ClassScanner.java b/core/bootstrap/src/main/java/org/qi4j/bootstrap/ClassScanner.java
index f3cfee9..70c2946 100644
--- a/core/bootstrap/src/main/java/org/qi4j/bootstrap/ClassScanner.java
+++ b/core/bootstrap/src/main/java/org/qi4j/bootstrap/ClassScanner.java
@@ -43,10 +43,10 @@ public class ClassScanner
{
/**
* Get all classes from the same package of the given class, and recursively in all subpackages.
- * <p/>
+ * <p>
* This only works if the seed class is loaded from a file: URL. Jar files are possible as well. Abstract classes
* are not included in the results. For further filtering use e.g. Iterables.filter.
- *
+ * </p>
* @param seedClass starting point for classpath scanning
*
* @return iterable of all concrete classes in the same package as the seedclass, and also all classes in subpackages.
@@ -162,12 +162,11 @@ public class ClassScanner
/**
* Useful specification for filtering classes based on a regular expression matching the class names.
- * <p/>
- * Example: matches(".*Model") -> match only class names that end with Model
- * <p/>
- * Example:
+ * <p>
+ * Example: matches(".*Model") -> match only class names that end with Model
+ * </p>
*
- * @param regex
+ * @param regex The regular expression to be matched.
*
* @return regex class name specification
*/
http://git-wip-us.apache.org/repos/asf/zest-qi4j/blob/3bf71dfe/core/bootstrap/src/main/java/org/qi4j/bootstrap/Energy4Java.java
----------------------------------------------------------------------
diff --git a/core/bootstrap/src/main/java/org/qi4j/bootstrap/Energy4Java.java b/core/bootstrap/src/main/java/org/qi4j/bootstrap/Energy4Java.java
index b30a19a..71dd525 100644
--- a/core/bootstrap/src/main/java/org/qi4j/bootstrap/Energy4Java.java
+++ b/core/bootstrap/src/main/java/org/qi4j/bootstrap/Energy4Java.java
@@ -24,11 +24,14 @@ import org.qi4j.api.structure.ApplicationDescriptor;
import org.qi4j.spi.Qi4jSPI;
/**
- * Main bootstrap class for starting Qi4j and creating new applications. Instantiate this
- * and call one of the factory methods to get started.
- * <p/>
+ * Main bootstrap class for starting Qi4j and creating new applications.
+ * <p>
+ * Instantiate this and call one of the factory methods to get started.
+ * </p>
+ * <p>
* This class will use the Service Loader mechanism in Java to try to locate a runtime that implements
* the Qi4jRuntime interface. This avoids a direct dependency from the bootstrap to the runtime.
+ * </p>
*/
public final class Energy4Java
{
http://git-wip-us.apache.org/repos/asf/zest-qi4j/blob/3bf71dfe/core/bootstrap/src/main/java/org/qi4j/bootstrap/EntityDeclaration.java
----------------------------------------------------------------------
diff --git a/core/bootstrap/src/main/java/org/qi4j/bootstrap/EntityDeclaration.java b/core/bootstrap/src/main/java/org/qi4j/bootstrap/EntityDeclaration.java
index 21468d5..fb00745 100644
--- a/core/bootstrap/src/main/java/org/qi4j/bootstrap/EntityDeclaration.java
+++ b/core/bootstrap/src/main/java/org/qi4j/bootstrap/EntityDeclaration.java
@@ -64,9 +64,9 @@ public interface EntityDeclaration
/**
* Declare additional mixins for these entities.
- * <p/>
+ * <p>
* This can be useful to override any default mixins from the entity interface.
- *
+ * </p>
* @param mixins The mixins that are to be added to the EntityComposite beyond the statically declared ones.
*
* @return This instance for a fluid DSL
@@ -75,10 +75,10 @@ public interface EntityDeclaration
/**
* Declare additional interfaces for these declared interfaces.
- * <p/>
+ * <p>
* This can be useful to add types that the entities should implement, but
* which you do not want to include in the entity interface itself.
- *
+ * </p>
* @param types list of interfaces to add
*
* @return This instance for a fluid DSL
http://git-wip-us.apache.org/repos/asf/zest-qi4j/blob/3bf71dfe/core/bootstrap/src/main/java/org/qi4j/bootstrap/ManyAssociationDeclarations.java
----------------------------------------------------------------------
diff --git a/core/bootstrap/src/main/java/org/qi4j/bootstrap/ManyAssociationDeclarations.java b/core/bootstrap/src/main/java/org/qi4j/bootstrap/ManyAssociationDeclarations.java
index a226582..f95a6ac 100644
--- a/core/bootstrap/src/main/java/org/qi4j/bootstrap/ManyAssociationDeclarations.java
+++ b/core/bootstrap/src/main/java/org/qi4j/bootstrap/ManyAssociationDeclarations.java
@@ -18,7 +18,7 @@ import java.lang.reflect.AccessibleObject;
import org.qi4j.api.common.MetaInfo;
/**
- * This provides declared {@see org.qi4j.api.association.ManyAssociation} information that the runtime can use.
+ * This provides declared {@link org.qi4j.api.association.ManyAssociation} information that the runtime can use.
*/
public interface ManyAssociationDeclarations
{
http://git-wip-us.apache.org/repos/asf/zest-qi4j/blob/3bf71dfe/core/bootstrap/src/main/java/org/qi4j/bootstrap/ModuleAssembly.java
----------------------------------------------------------------------
diff --git a/core/bootstrap/src/main/java/org/qi4j/bootstrap/ModuleAssembly.java b/core/bootstrap/src/main/java/org/qi4j/bootstrap/ModuleAssembly.java
index 03df5f7..805b232 100644
--- a/core/bootstrap/src/main/java/org/qi4j/bootstrap/ModuleAssembly.java
+++ b/core/bootstrap/src/main/java/org/qi4j/bootstrap/ModuleAssembly.java
@@ -24,10 +24,11 @@ import org.qi4j.api.structure.Module;
import org.qi4j.functional.Specification;
/**
- * The ModuleAssembly is used to register any information about
- * what the module should contain, such as composites, entities and services.
- * <p/>
+ * The ModuleAssembly is used to register any information about * what the module should contain, such as composites,
+ * entities and services.
+ * <p>
* Use the methods and the fluent API's to declare how the module should be constructed.
+ * </p>
*/
public interface ModuleAssembly
{
@@ -42,8 +43,9 @@ public interface ModuleAssembly
* Get an assembly for a particular Module. If this is called many times with the same names, then the same module
* is affected.
*
- * @param layerName The name of the Layer
+ * @param layerName The name of the Layer
* @param moduleName The name of the Module to retrieve or create.
+ *
* @return The ModuleAssembly for the Module.
*/
ModuleAssembly module( String layerName, String moduleName );
@@ -69,9 +71,10 @@ public interface ModuleAssembly
* Module activation and passivation.
*
* @param activators the module activators
+ *
* @return the assembly
- */
- @SuppressWarnings( { "unchecked","varargs" } )
+ */
+ @SuppressWarnings({ "unchecked", "varargs" })
ModuleAssembly withActivators( Class<? extends Activator<Module>>... activators );
/**
http://git-wip-us.apache.org/repos/asf/zest-qi4j/blob/3bf71dfe/core/bootstrap/src/main/java/org/qi4j/bootstrap/NamedAssociationDeclarations.java
----------------------------------------------------------------------
diff --git a/core/bootstrap/src/main/java/org/qi4j/bootstrap/NamedAssociationDeclarations.java b/core/bootstrap/src/main/java/org/qi4j/bootstrap/NamedAssociationDeclarations.java
index 0838632..54a4257 100644
--- a/core/bootstrap/src/main/java/org/qi4j/bootstrap/NamedAssociationDeclarations.java
+++ b/core/bootstrap/src/main/java/org/qi4j/bootstrap/NamedAssociationDeclarations.java
@@ -23,7 +23,7 @@ import java.lang.reflect.AccessibleObject;
import org.qi4j.api.common.MetaInfo;
/**
- * This provides declared {@see org.qi4j.api.association.NamedAssociation} information that the runtime can use.
+ * This provides declared {@link org.qi4j.api.association.NamedAssociation} information that the runtime can use.
*/
public interface NamedAssociationDeclarations
{
http://git-wip-us.apache.org/repos/asf/zest-qi4j/blob/3bf71dfe/core/bootstrap/src/main/java/org/qi4j/bootstrap/SingletonAssembler.java
----------------------------------------------------------------------
diff --git a/core/bootstrap/src/main/java/org/qi4j/bootstrap/SingletonAssembler.java b/core/bootstrap/src/main/java/org/qi4j/bootstrap/SingletonAssembler.java
index 93bd781..255bd29 100644
--- a/core/bootstrap/src/main/java/org/qi4j/bootstrap/SingletonAssembler.java
+++ b/core/bootstrap/src/main/java/org/qi4j/bootstrap/SingletonAssembler.java
@@ -42,7 +42,7 @@ public abstract class SingletonAssembler
*
* @throws AssemblyException Either if the model can not be created from the disk, or some inconsistency in
* the programming model makes it impossible to create it.
- * @throws
+ * @throws ActivationException If the automatic {@code activate()} method is throwing this Exception..
*/
public SingletonAssembler()
throws AssemblyException, ActivationException
http://git-wip-us.apache.org/repos/asf/zest-qi4j/blob/3bf71dfe/core/bootstrap/src/main/java/org/qi4j/bootstrap/StateDeclarations.java
----------------------------------------------------------------------
diff --git a/core/bootstrap/src/main/java/org/qi4j/bootstrap/StateDeclarations.java b/core/bootstrap/src/main/java/org/qi4j/bootstrap/StateDeclarations.java
index e615b22..39a69b8 100644
--- a/core/bootstrap/src/main/java/org/qi4j/bootstrap/StateDeclarations.java
+++ b/core/bootstrap/src/main/java/org/qi4j/bootstrap/StateDeclarations.java
@@ -18,7 +18,7 @@ import java.lang.reflect.AccessibleObject;
import org.qi4j.api.common.MetaInfo;
/**
- * This provides declared {@see org.qi4j.api.property.Property} information that the runtime can use.
+ * This provides declared {@link org.qi4j.api.property.Property} information that the runtime can use.
*/
public interface StateDeclarations
{
http://git-wip-us.apache.org/repos/asf/zest-qi4j/blob/3bf71dfe/core/functional/src/main/java/org/qi4j/functional/ForEach.java
----------------------------------------------------------------------
diff --git a/core/functional/src/main/java/org/qi4j/functional/ForEach.java b/core/functional/src/main/java/org/qi4j/functional/ForEach.java
index a209bcb..c2bbe3e 100644
--- a/core/functional/src/main/java/org/qi4j/functional/ForEach.java
+++ b/core/functional/src/main/java/org/qi4j/functional/ForEach.java
@@ -18,9 +18,12 @@ import java.util.Iterator;
/**
* When using Iterables with map() and filter() the code often reads "in reverse", with the first item last in the code.
* Example: Iterables.map(function,Iterables.filter(specification, iterable))
- * <p/>
+ * <p>
* This ForEach class reverses that order and makes the code more readable, and allows easy application of visitors on iterables.
+ * </p>
+ * <p>
* Example: forEach(iterable).filter(specification).map(function).visit(visitor)
+ * </p>
*/
public final class ForEach<T>
implements Iterable<T>