You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@isis.apache.org by ah...@apache.org on 2022/06/29 05:40:30 UTC
[isis] branch master updated: ISIS-3073: simplify java-doc
This is an automated email from the ASF dual-hosted git repository.
ahuber pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/isis.git
The following commit(s) were added to refs/heads/master by this push:
new a98086e831 ISIS-3073: simplify java-doc
a98086e831 is described below
commit a98086e8319ab64b17fec2ade2a46c402eb973fa
Author: Andi Huber <ah...@apache.org>
AuthorDate: Wed Jun 29 07:40:22 2022 +0200
ISIS-3073: simplify java-doc
- also update site-index
- also adds missing license header
---
.../docs/modules/resources/pages/eventbus_domain.adoc | 4 +++-
.../docs/modules/resources/pages/eventbus_persistence.adoc | 4 +++-
.../docs/modules/resources/pages/eventbus_ui.adoc | 4 +++-
.../components/docs/modules/resources/pages/metamodel.adoc | 3 +++
.../docs/modules/resources/pages/metamodel_terminology.adoc | 4 +++-
.../modules/applib/pages/index/annotation/Action.adoc | 4 ++--
.../applib/pages/index/events/domain/ActionDomainEvent.adoc | 13 +++----------
.../pages/index/events/domain/CollectionDomainEvent.adoc | 8 ++------
.../pages/index/events/domain/PropertyDomainEvent.adoc | 8 ++------
.../pages/index/services/i18n/TranslationContext.adoc | 1 -
.../apache/isis/applib/events/domain/ActionDomainEvent.java | 13 ++++++++-----
.../isis/applib/events/domain/CollectionDomainEvent.java | 11 +++++++----
.../isis/applib/events/domain/PropertyDomainEvent.java | 11 +++++++----
core/adoc/modules/_overview/pages/about.adoc | 13 +++++++++----
14 files changed, 55 insertions(+), 46 deletions(-)
diff --git a/antora/components/docs/modules/resources/pages/eventbus_domain.adoc b/antora/components/docs/modules/resources/pages/eventbus_domain.adoc
index e5bb08958a..e4f80fbd2e 100644
--- a/antora/components/docs/modules/resources/pages/eventbus_domain.adoc
+++ b/antora/components/docs/modules/resources/pages/eventbus_domain.adoc
@@ -1,5 +1,7 @@
-:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
# eventbus_domain
+
+:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
+
.eventbus_domain
[plantuml,file="eventbus_domain.png"]
diff --git a/antora/components/docs/modules/resources/pages/eventbus_persistence.adoc b/antora/components/docs/modules/resources/pages/eventbus_persistence.adoc
index 54743388b1..bca638d71b 100644
--- a/antora/components/docs/modules/resources/pages/eventbus_persistence.adoc
+++ b/antora/components/docs/modules/resources/pages/eventbus_persistence.adoc
@@ -1,5 +1,7 @@
-:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
# eventbus_persistence
+
+:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
+
.eventbus_persistence
[plantuml,file="eventbus_persistence.png"]
--
diff --git a/antora/components/docs/modules/resources/pages/eventbus_ui.adoc b/antora/components/docs/modules/resources/pages/eventbus_ui.adoc
index d5071a65e7..c1481c069a 100644
--- a/antora/components/docs/modules/resources/pages/eventbus_ui.adoc
+++ b/antora/components/docs/modules/resources/pages/eventbus_ui.adoc
@@ -1,5 +1,7 @@
-:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
# eventbus_ui
+
+:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
+
.eventbus_ui
[plantuml,file="eventbus_ui.png"]
--
diff --git a/antora/components/docs/modules/resources/pages/metamodel.adoc b/antora/components/docs/modules/resources/pages/metamodel.adoc
index f689babc5e..005716c252 100644
--- a/antora/components/docs/modules/resources/pages/metamodel.adoc
+++ b/antora/components/docs/modules/resources/pages/metamodel.adoc
@@ -1,4 +1,7 @@
# metamodel
+
+:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
+
.metamodel
[plantuml,file="metamodel.png"]
--
diff --git a/antora/components/docs/modules/resources/pages/metamodel_terminology.adoc b/antora/components/docs/modules/resources/pages/metamodel_terminology.adoc
index 4158515464..35fe6740a0 100644
--- a/antora/components/docs/modules/resources/pages/metamodel_terminology.adoc
+++ b/antora/components/docs/modules/resources/pages/metamodel_terminology.adoc
@@ -1,5 +1,7 @@
-:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
# metamodel_terminology
+
+:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
+
.metamodel_terminology
[plantuml,file="metamodel_terminology.png"]
--
diff --git a/antora/components/refguide-index/modules/applib/pages/index/annotation/Action.adoc b/antora/components/refguide-index/modules/applib/pages/index/annotation/Action.adoc
index 5216100156..e9dc151a06 100644
--- a/antora/components/refguide-index/modules/applib/pages/index/annotation/Action.adoc
+++ b/antora/components/refguide-index/modules/applib/pages/index/annotation/Action.adoc
@@ -26,7 +26,7 @@ void.class; // <.>
<.> xref:#choicesFrom[choicesFrom]
+
--
-References a collection of a certain element type, for an action with a collection parameter of that element type; the action's choices will be automatically populated from checkboxes rendered in the collection.
+References a collection of a certain element type (by its member-id), for an action with scalar or collection parameters of that element type; the action's choices will be automatically populated from checkboxes rendered in the collection (multi-select).
--
<.> xref:#commandDtoProcessor[commandDtoProcessor]
+
@@ -79,7 +79,7 @@ For downloading xref:refguide:applib:index/value/Blob.adoc[Blob] or xref:refguid
[#choicesFrom]
=== choicesFrom
-References a collection of a certain element type, for an action with a collection parameter of that element type; the action's choices will be automatically populated from checkboxes rendered in the collection.
+References a collection of a certain element type (by its member-id), for an action with scalar or collection parameters of that element type; the action's choices will be automatically populated from checkboxes rendered in the collection (multi-select).
This will also result in the action being rendered near to the collection, similar to the way in which _ActionLayout#associateWith()_ does.
diff --git a/antora/components/refguide-index/modules/applib/pages/index/events/domain/ActionDomainEvent.adoc b/antora/components/refguide-index/modules/applib/pages/index/events/domain/ActionDomainEvent.adoc
index 6eafa31aa1..12fa3af563 100644
--- a/antora/components/refguide-index/modules/applib/pages/index/events/domain/ActionDomainEvent.adoc
+++ b/antora/components/refguide-index/modules/applib/pages/index/events/domain/ActionDomainEvent.adoc
@@ -38,9 +38,6 @@ Subtypes can define a no-arg constructor; the framework sets state via (non-API)
+
--
Subtypes can define a one-arg constructor; the framework sets state via (non-API) setters.
-This is useful where the domain event is declared in a mixin, which itself is nested as a non-static class within a parent type.
-In such a case the Java compiler implicitly adds a one-arg constructor of the parent type to the mixin, which means that the mixin contributes to its parent.
-The domain event defined within the mixin must also be non-static, and the compiler will again implicit add a one-arg constructor taking the mixin instance as its source.
--
<.> xref:#setReturnValue__Object[setReturnValue(Object)]
+
@@ -57,18 +54,14 @@ Set by the framework.
[#ActionDomainEvent__]
=== ActionDomainEvent()
-Subtypes can define a one-arg constructor; the framework sets state via (non-API) setters.
-This is useful where the domain event is declared in a mixin, which itself is nested as a non-static class within a parent type.
-In such a case the Java compiler implicitly adds a one-arg constructor of the parent type to the mixin, which means that the mixin contributes to its parent.
-The domain event defined within the mixin must also be non-static, and the compiler will again implicit add a one-arg constructor taking the mixin instance as its source.
+Subtypes can define a no-arg constructor; the framework sets state via (non-API) setters.
[#ActionDomainEvent__S]
=== ActionDomainEvent(S)
Subtypes can define a one-arg constructor; the framework sets state via (non-API) setters.
-This is useful where the domain event is declared in a mixin, which itself is nested as a non-static class within a parent type.
-In such a case the Java compiler implicitly adds a one-arg constructor of the parent type to the mixin, which means that the mixin contributes to its parent.
-The domain event defined within the mixin must also be non-static, and the compiler will again implicit add a one-arg constructor taking the mixin instance as its source.
+
+A one-arg constructor is particularly useful in the context of non-static DomainEvent class nesting.
[#setReturnValue__Object]
=== setReturnValue(Object)
diff --git a/antora/components/refguide-index/modules/applib/pages/index/events/domain/CollectionDomainEvent.adoc b/antora/components/refguide-index/modules/applib/pages/index/events/domain/CollectionDomainEvent.adoc
index fcfda27d01..a7a6c6c729 100644
--- a/antora/components/refguide-index/modules/applib/pages/index/events/domain/CollectionDomainEvent.adoc
+++ b/antora/components/refguide-index/modules/applib/pages/index/events/domain/CollectionDomainEvent.adoc
@@ -28,9 +28,6 @@ Subtypes can define a no-arg constructor; the framework sets state via (non-API)
+
--
Subtypes can define a one-arg constructor; the framework sets state via (non-API) setters.
-This is useful where the domain event is declared in a mixin, which itself is nested as a non-static class within a parent type.
-In such a case the Java compiler implicitly adds a one-arg constructor of the parent type to the mixin, which means that the mixin contributes to its parent.
-The domain event defined within the mixin must also be non-static, and the compiler will again implicit add a one-arg constructor taking the mixin instance as its source.
--
== Members
@@ -44,6 +41,5 @@ Subtypes can define a no-arg constructor; the framework sets state via (non-API)
=== CollectionDomainEvent(S)
Subtypes can define a one-arg constructor; the framework sets state via (non-API) setters.
-This is useful where the domain event is declared in a mixin, which itself is nested as a non-static class within a parent type.
-In such a case the Java compiler implicitly adds a one-arg constructor of the parent type to the mixin, which means that the mixin contributes to its parent.
-The domain event defined within the mixin must also be non-static, and the compiler will again implicit add a one-arg constructor taking the mixin instance as its source.
+
+A one-arg constructor is particularly useful in the context of non-static DomainEvent class nesting.
diff --git a/antora/components/refguide-index/modules/applib/pages/index/events/domain/PropertyDomainEvent.adoc b/antora/components/refguide-index/modules/applib/pages/index/events/domain/PropertyDomainEvent.adoc
index 5e24f47c10..a94e32ccfa 100644
--- a/antora/components/refguide-index/modules/applib/pages/index/events/domain/PropertyDomainEvent.adoc
+++ b/antora/components/refguide-index/modules/applib/pages/index/events/domain/PropertyDomainEvent.adoc
@@ -32,9 +32,6 @@ Subtypes can define a no-arg constructor; the framework sets state via (non-API)
+
--
Subtypes can define a one-arg constructor; the framework sets state via (non-API) setters.
-This is useful where the domain event is declared in a mixin, which itself is nested as a non-static class within a parent type.
-In such a case the Java compiler implicitly adds a one-arg constructor of the parent type to the mixin, which means that the mixin contributes to its parent.
-The domain event defined within the mixin must also be non-static, and the compiler will again implicit add a one-arg constructor taking the mixin instance as its source.
--
== Members
@@ -48,6 +45,5 @@ Subtypes can define a no-arg constructor; the framework sets state via (non-API)
=== PropertyDomainEvent(S)
Subtypes can define a one-arg constructor; the framework sets state via (non-API) setters.
-This is useful where the domain event is declared in a mixin, which itself is nested as a non-static class within a parent type.
-In such a case the Java compiler implicitly adds a one-arg constructor of the parent type to the mixin, which means that the mixin contributes to its parent.
-The domain event defined within the mixin must also be non-static, and the compiler will again implicit add a one-arg constructor taking the mixin instance as its source.
+
+A one-arg constructor is particularly useful in the context of non-static DomainEvent class nesting.
diff --git a/antora/components/refguide-index/modules/applib/pages/index/services/i18n/TranslationContext.adoc b/antora/components/refguide-index/modules/applib/pages/index/services/i18n/TranslationContext.adoc
index e526d79da1..284203dc37 100644
--- a/antora/components/refguide-index/modules/applib/pages/index/services/i18n/TranslationContext.adoc
+++ b/antora/components/refguide-index/modules/applib/pages/index/services/i18n/TranslationContext.adoc
@@ -7,7 +7,6 @@
.TranslationContext.java
----
class TranslationContext {
- TranslationContext forTranslationContextHolder(HasTranslationContext hasTranslationContext)
TranslationContext forClassName(Class<?> contextClass)
TranslationContext forMethod(Class<?> contextClass, String contextMethodName)
TranslationContext forMethod(Method method)
diff --git a/api/applib/src/main/java/org/apache/isis/applib/events/domain/ActionDomainEvent.java b/api/applib/src/main/java/org/apache/isis/applib/events/domain/ActionDomainEvent.java
index 83df669ed0..de847398bf 100644
--- a/api/applib/src/main/java/org/apache/isis/applib/events/domain/ActionDomainEvent.java
+++ b/api/applib/src/main/java/org/apache/isis/applib/events/domain/ActionDomainEvent.java
@@ -94,10 +94,13 @@ public abstract class ActionDomainEvent<S> extends AbstractDomainEvent<S> {
}
/**
- * Subtypes can define a one-arg constructor; the framework sets state via (non-API) setters.
- * This is useful where the domain event is declared in a mixin, which itself is nested as a non-static class within a parent type.
- * In such a case the Java compiler implicitly adds a one-arg constructor of the parent type to the mixin, which means that the mixin contributes to its parent.
- * The domain event defined within the mixin must also be non-static, and the compiler will again implicit add a one-arg constructor taking the mixin instance as <i>its</i> source.
+ * Subtypes can define a one-arg constructor; the framework sets state
+ * via (non-API) setters.
+ * <p>
+ * A one-arg constructor is particularly useful in the context of non-static
+ * DomainEvent class nesting.
+ * @apiNote The Java compiler implicitly adds a constructor
+ * to the non-static nested class, receiving the parent type as single argument.
*/
public ActionDomainEvent(final S source) {
super(source);
@@ -190,7 +193,7 @@ public abstract class ActionDomainEvent<S> extends AbstractDomainEvent<S> {
/**
* @apiNote : NOT API, set by the framework
*/
- public void setSemantics(SemanticsOf semantics) {
+ public void setSemantics(final SemanticsOf semantics) {
this.semantics = semantics;
}
/**
diff --git a/api/applib/src/main/java/org/apache/isis/applib/events/domain/CollectionDomainEvent.java b/api/applib/src/main/java/org/apache/isis/applib/events/domain/CollectionDomainEvent.java
index 7a32784a48..64b81adde9 100644
--- a/api/applib/src/main/java/org/apache/isis/applib/events/domain/CollectionDomainEvent.java
+++ b/api/applib/src/main/java/org/apache/isis/applib/events/domain/CollectionDomainEvent.java
@@ -74,10 +74,13 @@ public abstract class CollectionDomainEvent<S,T> extends AbstractDomainEvent<S>
}
/**
- * Subtypes can define a one-arg constructor; the framework sets state via (non-API) setters.
- * This is useful where the domain event is declared in a mixin, which itself is nested as a non-static class within a parent type.
- * In such a case the Java compiler implicitly adds a one-arg constructor of the parent type to the mixin, which means that the mixin contributes to its parent.
- * The domain event defined within the mixin must also be non-static, and the compiler will again implicit add a one-arg constructor taking the mixin instance as <i>its</i> source.
+ * Subtypes can define a one-arg constructor; the framework sets state
+ * via (non-API) setters.
+ * <p>
+ * A one-arg constructor is particularly useful in the context of non-static
+ * DomainEvent class nesting.
+ * @apiNote The Java compiler implicitly adds a constructor
+ * to the non-static nested class, receiving the parent type as single argument.
*/
public CollectionDomainEvent(final S source) {
super(source);
diff --git a/api/applib/src/main/java/org/apache/isis/applib/events/domain/PropertyDomainEvent.java b/api/applib/src/main/java/org/apache/isis/applib/events/domain/PropertyDomainEvent.java
index b3efae1ff8..f37d54034c 100644
--- a/api/applib/src/main/java/org/apache/isis/applib/events/domain/PropertyDomainEvent.java
+++ b/api/applib/src/main/java/org/apache/isis/applib/events/domain/PropertyDomainEvent.java
@@ -87,10 +87,13 @@ public abstract class PropertyDomainEvent<S,T> extends AbstractDomainEvent<S> {
}
/**
- * Subtypes can define a one-arg constructor; the framework sets state via (non-API) setters.
- * This is useful where the domain event is declared in a mixin, which itself is nested as a non-static class within a parent type.
- * In such a case the Java compiler implicitly adds a one-arg constructor of the parent type to the mixin, which means that the mixin contributes to its parent.
- * The domain event defined within the mixin must also be non-static, and the compiler will again implicit add a one-arg constructor taking the mixin instance as <i>its</i> source.
+ * Subtypes can define a one-arg constructor; the framework sets state
+ * via (non-API) setters.
+ * <p>
+ * A one-arg constructor is particularly useful in the context of non-static
+ * DomainEvent class nesting.
+ * @apiNote The Java compiler implicitly adds a constructor
+ * to the non-static nested class, receiving the parent type as single argument.
*/
public PropertyDomainEvent(final S source) {
super(source);
diff --git a/core/adoc/modules/_overview/pages/about.adoc b/core/adoc/modules/_overview/pages/about.adoc
index c06680e093..1b30860ba8 100644
--- a/core/adoc/modules/_overview/pages/about.adoc
+++ b/core/adoc/modules/_overview/pages/about.adoc
@@ -568,7 +568,7 @@ Directory: /testing/specsupport/applib
io.cucumber:cucumber-java:jar:<managed> +
io.cucumber:cucumber-junit-platform-engine:jar:<managed> +
io.cucumber:cucumber-spring:jar:<managed> +
-io.cucumber:messages:jar:19.0.0 +
+io.cucumber:messages:jar:19.1.2 +
org.apache.isis.testing:isis-testing-fakedata-applib:jar:<managed> +
org.apache.isis.testing:isis-testing-fixtures-applib:jar:<managed> +
org.apache.isis.testing:isis-testing-integtestsupport-applib:jar:<managed> +
@@ -866,6 +866,10 @@ demoapp.dom.types.javalang.doubles.jdo.WrapperDoubleJdoEntities +
demoapp.dom.types.javalang.doubles.jpa.WrapperDoubleJpaEntities +
demoapp.dom.types.javalang.doubles.persistence.WrapperDoubleSeeding +
demoapp.dom.types.javalang.doubles.samples.WrapperDoubleSamples +
+demoapp.dom.types.javalang.enums.jdo.JavaLangEnumJdoEntities +
+demoapp.dom.types.javalang.enums.jpa.JavaLangEnumJpaEntities +
+demoapp.dom.types.javalang.enums.persistence.JavaLangEnumSeeding +
+demoapp.dom.types.javalang.enums.samples.JavaLangEnumSamples +
demoapp.dom.types.javalang.floats.jdo.WrapperFloatJdoEntities +
demoapp.dom.types.javalang.floats.jpa.WrapperFloatJpaEntities +
demoapp.dom.types.javalang.floats.persistence.WrapperFloatSeeding +
@@ -1283,6 +1287,7 @@ com.fasterxml.jackson.core:jackson-databind:jar:<managed> +
com.fasterxml.jackson.module:jackson-module-jaxb-annotations:jar:<managed> +
org.apache.isis.core:isis-jdk-supplemental:pom:<managed> +
org.jdom:jdom2:jar:<managed> +
+org.jsoup:jsoup:jar:<managed> +
org.junit.jupiter:junit-jupiter-api:jar:<managed> +
org.junit.jupiter:junit-jupiter-engine:jar:<managed> +
org.junit.jupiter:junit-jupiter-params:jar:<managed> +
@@ -2644,7 +2649,7 @@ o.a.i.viewer.common.model.userprofile.UserProfileUiModelProviderDefault +
****
org.apache.isis.core:isis-core-internaltestsupport:jar:<managed> +
org.apache.isis.core:isis-core-runtime:jar:<managed> +
-org.webjars:font-awesome:jar:6.1.0 +
+org.webjars:font-awesome:jar:6.1.1 +
****
.Document Index Entries
@@ -5415,11 +5420,11 @@ eg. code mining, automated documentation.
.Dependencies
****
-org.checkerframework:checker-qual:jar:3.22.1 +
+org.checkerframework:checker-qual:jar:3.22.2 +
org.junit.jupiter:junit-jupiter-api:jar:<managed> +
org.junit.jupiter:junit-jupiter-engine:jar:<managed> +
org.junit.vintage:junit-vintage-engine:jar:<managed> +
-org.mapstruct:mapstruct-processor:jar:1.5.1.Final +
+org.mapstruct:mapstruct-processor:jar:1.5.2.Final +
org.projectlombok:lombok:jar:<managed> +
org.slf4j:slf4j-api:jar:<managed> +
org.springframework.boot:spring-boot-starter-log4j2:jar:<managed> +