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 2020/12/13 03:38:18 UTC
[isis] 02/02: ISIS-2473: remove antora tags from sources in
applib/annotation/*
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
commit 238169005766f53b65f2b013c0631d4cc1362228
Author: Andi Huber <ah...@apache.org>
AuthorDate: Sun Dec 13 04:38:00 2020 +0100
ISIS-2473: remove antora tags from sources in applib/annotation/*
---
.../org/apache/isis/applib/annotation/Action.java | 46 +++--------
.../isis/applib/annotation/ActionLayout.java | 42 +++-------
.../isis/applib/annotation/BookmarkPolicy.java | 10 ---
.../apache/isis/applib/annotation/Bounding.java | 2 -
.../apache/isis/applib/annotation/Collection.java | 22 ++----
.../isis/applib/annotation/CollectionLayout.java | 34 ++-------
.../apache/isis/applib/annotation/Defaulted.java | 6 --
.../isis/applib/annotation/DomainObject.java | 89 +++++-----------------
.../isis/applib/annotation/DomainObjectLayout.java | 56 +++-----------
.../isis/applib/annotation/DomainService.java | 10 +--
.../applib/annotation/DomainServiceLayout.java | 14 +---
.../org/apache/isis/applib/annotation/Editing.java | 10 ---
.../isis/applib/annotation/EntityChangeKind.java | 2 -
.../isis/applib/annotation/EqualByContent.java | 2 -
.../org/apache/isis/applib/annotation/Facets.java | 6 --
.../apache/isis/applib/annotation/HomePage.java | 2 -
.../isis/applib/annotation/LabelPosition.java | 6 --
.../apache/isis/applib/annotation/MemberOrder.java | 10 +--
.../applib/annotation/MementoSerialization.java | 8 --
.../apache/isis/applib/annotation/MinLength.java | 2 -
.../org/apache/isis/applib/annotation/Module.java | 2 -
.../org/apache/isis/applib/annotation/Nature.java | 15 ----
.../isis/applib/annotation/NatureOfService.java | 8 --
.../apache/isis/applib/annotation/Navigable.java | 4 -
.../apache/isis/applib/annotation/Optionality.java | 10 ---
.../isis/applib/annotation/OrderPrecedence.java | 12 ---
.../apache/isis/applib/annotation/Parameter.java | 30 ++------
.../isis/applib/annotation/ParameterLayout.java | 34 ++-------
.../isis/applib/annotation/Programmatic.java | 2 -
.../apache/isis/applib/annotation/Projecting.java | 6 --
.../apache/isis/applib/annotation/PromptStyle.java | 18 -----
.../apache/isis/applib/annotation/Property.java | 66 ++++------------
.../isis/applib/annotation/PropertyLayout.java | 50 +++---------
.../apache/isis/applib/annotation/Publishing.java | 10 ---
.../apache/isis/applib/annotation/Redirect.java | 8 --
.../apache/isis/applib/annotation/RenderDay.java | 6 --
.../apache/isis/applib/annotation/Repainting.java | 6 --
.../apache/isis/applib/annotation/RestrictTo.java | 2 -
.../apache/isis/applib/annotation/SemanticsOf.java | 18 -----
.../org/apache/isis/applib/annotation/Title.java | 10 ---
.../org/apache/isis/applib/annotation/Value.java | 6 --
.../org/apache/isis/applib/annotation/Where.java | 36 ---------
.../isis/applib/annotation/package-info.java | 2 +-
.../isis/tooling/j2adoc/test/J2AdocTest.java | 2 +-
44 files changed, 116 insertions(+), 626 deletions(-)
diff --git a/api/applib/src/main/java/org/apache/isis/applib/annotation/Action.java b/api/applib/src/main/java/org/apache/isis/applib/annotation/Action.java
index 37da6ce..b604277 100644
--- a/api/applib/src/main/java/org/apache/isis/applib/annotation/Action.java
+++ b/api/applib/src/main/java/org/apache/isis/applib/annotation/Action.java
@@ -38,7 +38,6 @@ import org.apache.isis.applib.services.publishing.spi.ExecutionSubscriber;
* Domain semantics for domain object collection.
* @since 1.x {@index}
*/
-// tag::refguide[]
@Inherited
@Target({
ElementType.METHOD,
@@ -49,7 +48,6 @@ import org.apache.isis.applib.services.publishing.spi.ExecutionSubscriber;
@DomainObject(nature=Nature.MIXIN, mixinMethod = "act") // meta annotation, only applies at class level
public @interface Action {
- // end::refguide[]
/**
* Associates this action with a property or collection, specifying its id.
*
@@ -69,11 +67,9 @@ public @interface Action {
* (in the Wicket UI, at least).
* </p>
*/
- // tag::refguide[]
- String associateWith() // <.>
+ String associateWith()
default "";
- // end::refguide[]
/**
* Specifies the sequence/order in the UI for an action that's been associated with a property or collection.
*
@@ -86,11 +82,9 @@ public @interface Action {
* For example <code>@Action(associateWith="items", associateWithSequence="2.1")</code>
* </p>
*/
- // tag::refguide[]
- String associateWithSequence() // <.>
+ String associateWithSequence()
default "1";
- // end::refguide[]
/**
* The {@link CommandDtoProcessor} to process this command's DTO.
*
@@ -99,20 +93,16 @@ public @interface Action {
* {@link ContentMappingServiceForCommandsDto} to dynamically transform the DTOs.
* </p>
*/
- // tag::refguide[]
- Class<? extends CommandDtoProcessor> commandDtoProcessor() // <.>
+ Class<? extends CommandDtoProcessor> commandDtoProcessor()
default CommandDtoProcessor.class;
- // end::refguide[]
/**
* Whether action invocations, captured as {@link Command}s,
* should be published to {@link CommandSubscriber}s.
*/
- // tag::refguide[]
- Publishing commandPublishing() // <.>
+ Publishing commandPublishing()
default Publishing.NOT_SPECIFIED;
- // end::refguide[]
/**
* Indicates that an invocation of the action should be posted to the
* {@link org.apache.isis.applib.services.eventbus.EventBusService event bus} using a custom (subclass of)
@@ -135,20 +125,16 @@ public @interface Action {
* This subclass must provide a no-arg constructor; the fields are set reflectively.
* </p>
*/
- // tag::refguide[]
- Class<? extends ActionDomainEvent<?>> domainEvent() // <.>
+ Class<? extends ActionDomainEvent<?>> domainEvent()
default ActionDomainEvent.Default.class;
- // end::refguide[]
/**
* Whether {@link Interaction.Execution}s (triggered by action invocations), should
* be published to {@link ExecutionSubscriber}s.
*/
- // tag::refguide[]
- Publishing executionPublishing() // <.>
+ Publishing executionPublishing()
default Publishing.NOT_SPECIFIED;
- // end::refguide[]
/**
* Indicates where (in the UI) the action is not visible to the user.
*
@@ -162,11 +148,9 @@ public @interface Action {
* {@link ActionLayout#contributed()}.
* </p>
*/
- // tag::refguide[]
- Where hidden() // <.>
+ Where hidden()
default Where.NOT_SPECIFIED;
- // end::refguide[]
/**
* Whether the action is restricted to prototyping.
*
@@ -174,30 +158,24 @@ public @interface Action {
* By default there are no restrictions, with the action being available in all environments.
* </p>
*/
- // tag::refguide[]
- RestrictTo restrictTo() // <.>
+ RestrictTo restrictTo()
default RestrictTo.NOT_SPECIFIED;
- // end::refguide[]
/**
* The action semantics, either {@link SemanticsOf#SAFE_AND_REQUEST_CACHEABLE cached}, {@link SemanticsOf#SAFE safe} (query-only),
* {@link SemanticsOf#IDEMPOTENT idempotent} or
* {@link SemanticsOf#NON_IDEMPOTENT non-idempotent}.
*/
- // tag::refguide[]
- SemanticsOf semantics() // <.>
+ SemanticsOf semantics()
default SemanticsOf.NOT_SPECIFIED;
- // end::refguide[]
/**
* The type-of the elements returned by the action.
* @return
*/
- // tag::refguide[]
- Class<?> typeOf() // <.>
+ Class<?> typeOf()
default Object.class;
- // end::refguide[]
/**
* For downloading {@link Blob} or {@link Clob}, optionally restrict the files accepted (eg <tt>.xslx</tt>).
*
@@ -208,9 +186,7 @@ public @interface Action {
* @see <a href="http://www.w3schools.com/tags/att_input_accept.asp">http://www.w3schools.com</a>
*
*/
- // tag::refguide[]
- String fileAccept() // <.>
+ String fileAccept()
default "";
}
-// end::refguide[]
diff --git a/api/applib/src/main/java/org/apache/isis/applib/annotation/ActionLayout.java b/api/applib/src/main/java/org/apache/isis/applib/annotation/ActionLayout.java
index c002281..9a35846 100644
--- a/api/applib/src/main/java/org/apache/isis/applib/annotation/ActionLayout.java
+++ b/api/applib/src/main/java/org/apache/isis/applib/annotation/ActionLayout.java
@@ -33,7 +33,6 @@ import org.apache.isis.applib.layout.component.CssClassFaPosition;
* Layout hints for actions.
* @since 1.x {@index}
*/
-// tag::refguide[]
@Inherited
@Target({
ElementType.METHOD,
@@ -44,7 +43,6 @@ import org.apache.isis.applib.layout.component.CssClassFaPosition;
@DomainObject(nature=Nature.MIXIN, mixinMethod = "act") // meta annotation, only applies at class level
public @interface ActionLayout {
- // end::refguide[]
/**
* Whether (and how) this action can be bookmarked in the UI.
*
@@ -54,11 +52,9 @@ public @interface ActionLayout {
* identically).
* </p>
*/
- // tag::refguide[]
- BookmarkPolicy bookmarking() // <.>
+ BookmarkPolicy bookmarking()
default BookmarkPolicy.NOT_SPECIFIED;
- // end::refguide[]
/**
* Indicates the css class that an action should have.
*
@@ -66,53 +62,41 @@ public @interface ActionLayout {
* For the Wicket viewer, this can be a bootstrap class such as <code>btn-info</code>.
* </p>
*/
- // tag::refguide[]
- String cssClass() // <.>
+ String cssClass()
default "";
- // end::refguide[]
/**
* Indicates the <a href="http://fortawesome.github.io/Font-Awesome/">Font Awesome</a> CSS class to decorate an
* action (button or menu item).
*/
- // tag::refguide[]
- String cssClassFa() // <.>
+ String cssClassFa()
default "";
- // end::refguide[]
/**
* Indicates the position of the <a href="http://fortawesome.github.io/Font-Awesome/">Font Awesome</a>
* icon. The icon could be rendered on the left or the right of the action button
*/
- // tag::refguide[]
- CssClassFaPosition cssClassFaPosition() // <.>
+ CssClassFaPosition cssClassFaPosition()
default CssClassFaPosition.LEFT;
- // end::refguide[]
/**
* Description of this action, eg to be rendered in a tooltip.
*/
- // tag::refguide[]
- String describedAs() // <.>
+ String describedAs()
default "";
- // end::refguide[]
/**
* Indicates where in the UI the action should <i>not</i>not be visible.
*/
- // tag::refguide[]
- Where hidden() // <.>
+ Where hidden()
default Where.NOT_SPECIFIED;
- // end::refguide[]
/**
* Name of this action (overriding the name derived from its name in code).
*/
- // tag::refguide[]
- String named() // <.>
+ String named()
default "";
- // end::refguide[]
/**
* For actions that are associated with a property, indicates the positioning of the
* action's button relative to the property.
@@ -121,11 +105,9 @@ public @interface ActionLayout {
* Ignored if the action has not been associated with a property.
* </p>
*/
- // tag::refguide[]
- Position position() // <.>
+ Position position()
default Position.NOT_SPECIFIED;
- // end::refguide[]
@XmlType(namespace = "http://isis.apache.org/applib/layout/component")
enum Position {
BELOW,
@@ -138,18 +120,14 @@ public @interface ActionLayout {
/**
* How this parameters for this action are prompted, either {@link PromptStyle#DIALOG dialog} or {@link PromptStyle#INLINE inline}.
*/
- // tag::refguide[]
- PromptStyle promptStyle() // <.>
+ PromptStyle promptStyle()
default PromptStyle.AS_CONFIGURED;
- // end::refguide[]
/**
* If the action returns its target, then determines whether to update the page or
* instead to redirect (forcing a re-rendering of a new page).
*/
- // tag::refguide[]
- Redirect redirectPolicy() // <.>
+ Redirect redirectPolicy()
default Redirect.AS_CONFIGURED;
}
-// end::refguide[]
diff --git a/api/applib/src/main/java/org/apache/isis/applib/annotation/BookmarkPolicy.java b/api/applib/src/main/java/org/apache/isis/applib/annotation/BookmarkPolicy.java
index daaf720..ff32fff 100644
--- a/api/applib/src/main/java/org/apache/isis/applib/annotation/BookmarkPolicy.java
+++ b/api/applib/src/main/java/org/apache/isis/applib/annotation/BookmarkPolicy.java
@@ -25,40 +25,30 @@ import javax.xml.bind.annotation.XmlType;
*
* @since 1.x {@index}
*/
-// tag::refguide[]
@XmlType(
namespace = "http://isis.apache.org/applib/layout/component"
)
public enum BookmarkPolicy {
- // end::refguide[]
/**
* Can be bookmarked, and is a top-level 'root' (or parent) bookmark.
*/
- // tag::refguide[]
AS_ROOT,
- // end::refguide[]
/**
* Can be bookmarked, but only as a child or some other parent/root bookmark
*/
- // tag::refguide[]
AS_CHILD,
- // end::refguide[]
/**
* An unimportant entity that should never be bookmarked.
*/
- // tag::refguide[]
NEVER,
- // end::refguide[]
/**
* Ignore the value provided by this annotation (meaning that the framework will keep searching, in meta
* annotations or superclasses/interfaces).
*/
- // tag::refguide[]
NOT_SPECIFIED
}
-// end::refguide[]
diff --git a/api/applib/src/main/java/org/apache/isis/applib/annotation/Bounding.java b/api/applib/src/main/java/org/apache/isis/applib/annotation/Bounding.java
index 6c89883..e998d43 100644
--- a/api/applib/src/main/java/org/apache/isis/applib/annotation/Bounding.java
+++ b/api/applib/src/main/java/org/apache/isis/applib/annotation/Bounding.java
@@ -23,10 +23,8 @@ package org.apache.isis.applib.annotation;
*
* @since 1.x {@index}
*/
-// tag::refguide[]
public enum Bounding {
BOUNDED,
UNBOUNDED,
NOT_SPECIFIED
}
-// end::refguide[]
diff --git a/api/applib/src/main/java/org/apache/isis/applib/annotation/Collection.java b/api/applib/src/main/java/org/apache/isis/applib/annotation/Collection.java
index 5e70712..eeec4a6 100644
--- a/api/applib/src/main/java/org/apache/isis/applib/annotation/Collection.java
+++ b/api/applib/src/main/java/org/apache/isis/applib/annotation/Collection.java
@@ -32,7 +32,6 @@ import org.apache.isis.applib.events.domain.CollectionDomainEvent;
*
* @since 1.x {@index}
*/
-// tag::refguide[]
@Inherited
@Target({
ElementType.METHOD,
@@ -44,7 +43,6 @@ import org.apache.isis.applib.events.domain.CollectionDomainEvent;
@DomainObject(nature=Nature.MIXIN, mixinMethod = "coll") // meta annotation, only applies at class level
public @interface Collection {
- // end::refguide[]
/**
* Indicates that changes to the collection that should be posted to the
* {@link org.apache.isis.applib.services.eventbus.EventBusService event bus} using a custom (subclass of)
@@ -65,11 +63,9 @@ public @interface Collection {
* This subclass must provide a no-arg constructor; the fields are set reflectively.
* </p>
*/
- // tag::refguide[]
- Class<? extends CollectionDomainEvent<?,?>> domainEvent() // <.>
+ Class<? extends CollectionDomainEvent<?,?>> domainEvent()
default CollectionDomainEvent.Default.class;
- // end::refguide[]
/**
* Whether the properties of this domain object can be edited, or collections of this object be added to/removed from.
*
@@ -77,36 +73,28 @@ public @interface Collection {
* Note that non-editable objects can nevertheless have actions invoked upon them.
* </p>
*/
- // tag::refguide[]
- Editing editing() // <.>
+ Editing editing()
default Editing.NOT_SPECIFIED;
- // end::refguide[]
/**
* If {@link #editing()} is set to {@link Editing#DISABLED},
* then the reason to provide to the user as to why this property cannot be edited.
*/
- // tag::refguide[]
- String editingDisabledReason() // <.>
+ String editingDisabledReason()
default "";
- // end::refguide[]
/**
* Indicates when the collection is not visible to the user.
*/
- // tag::refguide[]
- Where hidden() // <.>
+ Where hidden()
default Where.NOT_SPECIFIED;
- // end::refguide[]
/**
* The type-of the elements held within the collection.
*
* @return
*/
- // tag::refguide[]
- Class<?> typeOf() // <.>
+ Class<?> typeOf()
default Object.class;
}
-// end::refguide[]
diff --git a/api/applib/src/main/java/org/apache/isis/applib/annotation/CollectionLayout.java b/api/applib/src/main/java/org/apache/isis/applib/annotation/CollectionLayout.java
index 9b2b863..631a648 100644
--- a/api/applib/src/main/java/org/apache/isis/applib/annotation/CollectionLayout.java
+++ b/api/applib/src/main/java/org/apache/isis/applib/annotation/CollectionLayout.java
@@ -31,7 +31,6 @@ import java.util.Comparator;
*
* @since 1.x {@index}
*/
-// tag::refguide[]
@Inherited
@Target({
ElementType.METHOD,
@@ -43,15 +42,12 @@ import java.util.Comparator;
@DomainObject(nature=Nature.MIXIN, mixinMethod = "coll") // meta annotation, only applies at class level
public @interface CollectionLayout {
- // end::refguide[]
/**
* Indicates the css class that a collection should have.
*/
- // tag::refguide[]
- String cssClass() // <.>
+ String cssClass()
default "";
- // end::refguide[]
/**
* Indicates which view is used by default to render the collection.
*
@@ -63,19 +59,15 @@ public @interface CollectionLayout {
* "<a href="https://github.com/isisaddons/isis-wicket-gmap3">map</a>".
* </p>
*/
- // tag::refguide[]
- String defaultView() // <.>
+ String defaultView()
default "";
- // end::refguide[]
/**
* Description of this collection, eg to be rendered in a tooltip.
*/
- // tag::refguide[]
- String describedAs() // <.>
+ String describedAs()
default "";
- // end::refguide[]
/**
* Indicates where in the UI the collection should <i>not</i>not be visible.
*
@@ -84,27 +76,21 @@ public @interface CollectionLayout {
* apply for collections.
* </p>
*/
- // tag::refguide[]
- Where hidden() // <.>
+ Where hidden()
default Where.NOT_SPECIFIED;
- // end::refguide[]
/**
* Name of this collection (overriding the name derived from its name in code).
*/
- // tag::refguide[]
- String named() // <.>
+ String named()
default "";
- // end::refguide[]
/**
* A flag indicating whether the value of {@linkplain #named()} should be HTML escaped or not.
*/
- // tag::refguide[]
- boolean namedEscaped() // <.>
+ boolean namedEscaped()
default true;
- // end::refguide[]
/**
* The page size for instances of this class when rendered within
* a table.
@@ -117,11 +103,9 @@ public @interface CollectionLayout {
* If annotated on a type, then the page size refers to standalone
* collections (eg as returned from a repository query).
*/
- // tag::refguide[]
- int paged() // <.>
+ int paged()
default -1;
- // end::refguide[]
/**
* Indicates that the elements in a ({@link java.util.SortedSet}) collection should be sorted according to a different order than the
* natural sort order, as defined by the specified{@link java.util.Comparator}.
@@ -141,9 +125,7 @@ public @interface CollectionLayout {
* may be sorted in an order more suitable to the context.
*/
@SuppressWarnings("rawtypes")
- // tag::refguide[]
- Class sortedBy() // <.>
+ Class sortedBy()
default Comparator.class;
}
-// end::refguide[]
diff --git a/api/applib/src/main/java/org/apache/isis/applib/annotation/Defaulted.java b/api/applib/src/main/java/org/apache/isis/applib/annotation/Defaulted.java
index b4773ff..566da4a 100644
--- a/api/applib/src/main/java/org/apache/isis/applib/annotation/Defaulted.java
+++ b/api/applib/src/main/java/org/apache/isis/applib/annotation/Defaulted.java
@@ -49,13 +49,11 @@ import org.apache.isis.applib.adapters.DefaultsProvider;
* </p>
* @since 1.x {@index}
*/
-// tag::refguide[]
@Inherited
@Target({ ElementType.TYPE })
@Retention(RetentionPolicy.RUNTIME)
public @interface Defaulted {
- // end::refguide[]
/**
* The fully qualified name of a class that implements the
* {@link DefaultsProvider} interface.
@@ -69,10 +67,8 @@ public @interface Defaulted {
* Implementation note: the default value provided here is simply an empty
* string because <tt>null</tt> is not a valid default.
*/
- // tag::refguide[]
String defaultsProviderName() default "";
- // end::refguide[]
/**
* As per {@link #defaultsProviderName()}, but specifying a class literal
* rather than a fully qualified class name.
@@ -82,8 +78,6 @@ public @interface Defaulted {
* {@link Defaulted}'s own class, because <tt>null</tt> is not a valid
* default.
*/
- // tag::refguide[]
Class<?> defaultsProviderClass() default Defaulted.class;
}
-// end::refguide[]
diff --git a/api/applib/src/main/java/org/apache/isis/applib/annotation/DomainObject.java b/api/applib/src/main/java/org/apache/isis/applib/annotation/DomainObject.java
index 2ce3ba2..a78a54a 100644
--- a/api/applib/src/main/java/org/apache/isis/applib/annotation/DomainObject.java
+++ b/api/applib/src/main/java/org/apache/isis/applib/annotation/DomainObject.java
@@ -47,7 +47,6 @@ import org.apache.isis.applib.events.lifecycle.ObjectUpdatingEvent;
*
* @since 1.x {@index}
*/
-// tag::refguide[]
@Inherited
@Target({
ElementType.TYPE,
@@ -55,27 +54,19 @@ import org.apache.isis.applib.events.lifecycle.ObjectUpdatingEvent;
})
@Retention(RetentionPolicy.RUNTIME)
@Component @Scope("prototype")
-// tag::refguide-lifecycle-events[]
-// tag::refguide-domain-events[]
public @interface DomainObject {
- // end::refguide[]
// ...
- // end::refguide-lifecycle-events[]
- // end::refguide-domain-events[]
- // end::refguide[]
/**
* The class of the domain service that provides an <code>autoComplete(String)</code> method.
*
* <p>
* It is sufficient to specify an interface rather than a concrete type.
*/
- // tag::refguide[]
- Class<?> autoCompleteRepository() // <.>
+ Class<?> autoCompleteRepository()
default Object.class;
- // end::refguide[]
/**
* The method (despite its name, not necessarily an action) to use in order to perform the auto-complete search
* (defaults to "autoComplete").
@@ -83,11 +74,9 @@ public @interface DomainObject {
* <p>
* The method is required to accept a single string parameter, and must return a list of the domain type.
*/
- // tag::refguide[]
- String autoCompleteAction() // <.>
+ String autoCompleteAction()
default "autoComplete";
- // end::refguide[]
/**
* Indicates that the class has a bounded, or finite, set of instances.
*
@@ -100,11 +89,9 @@ public @interface DomainObject {
* </p>
*
*/
- // tag::refguide[]
- Bounding bounding() // <.>
+ Bounding bounding()
default Bounding.NOT_SPECIFIED;
- // end::refguide[]
/**
* Whether the properties of this domain object can be edited, or collections of this object be added to/removed from.
*
@@ -112,20 +99,16 @@ public @interface DomainObject {
* Note that non-editable objects can nevertheless have actions invoked upon them.
* </p>
*/
- // tag::refguide[]
- Editing editing() // <.>
+ Editing editing()
default Editing.NOT_SPECIFIED;
- // end::refguide[]
/**
* If {@link #editing()} is set to {@link Editing#DISABLED},
* then the reason to provide to the user as to why the object's properties cannot be edited/collections modified.
*/
- // tag::refguide[]
- String editingDisabledReason() // <.>
+ String editingDisabledReason()
default "Disabled";
- // end::refguide[]
/**
* Whether entity changes should be published to
* {@link org.apache.isis.applib.services.publishing.spi.EntityPropertyChangeSubscriber}s
@@ -133,11 +116,9 @@ public @interface DomainObject {
* should be dispatched to {@link org.apache.isis.applib.services.publishing.spi.EntityChangesSubscriber}s.
* @apiNote does only apply to entity objects
*/
- // tag::refguide[]
- Publishing entityChangePublishing() // <.>
+ Publishing entityChangePublishing()
default Publishing.NOT_SPECIFIED;
- // end::refguide[]
/**
* Equivalent to {@link Mixin#method()}.
*
@@ -145,19 +126,15 @@ public @interface DomainObject {
* Applicable only if {@link #nature()} is {@link Nature#MIXIN}.
* </p>
*/
- // tag::refguide[]
- String mixinMethod() // <.>
+ String mixinMethod()
default "$$";
- // end::refguide[]
/**
* The nature of this domain object.
*/
- // tag::refguide[]
- Nature nature() // <.>
+ Nature nature()
default Nature.NOT_SPECIFIED;
- // end::refguide[]
/**
* Provides a unique abbreviation for the object type, eg "customer.Customer" for Customer.
*
@@ -166,11 +143,9 @@ public @interface DomainObject {
* used by the framework to unique identify an object over time (same concept as a URN).
* </p>
*/
- // tag::refguide[]
- String objectType() // <.>
+ String objectType()
default "";
- // end::refguide[]
/**
* Indicates that the loading of the domain object should be posted to the
@@ -181,12 +156,10 @@ public @interface DomainObject {
* This subclass must provide a no-arg constructor; the fields are set reflectively.
* </p>
*/
- // tag::refguide-lifecycle-events[]
Class<? extends ObjectCreatedEvent<?>>
- createdLifecycleEvent() // <.>
+ createdLifecycleEvent()
default ObjectCreatedEvent.Default.class;
- // end::refguide-lifecycle-events[]
/**
* Indicates that the loading of the domain object should be posted to the
* {@link org.apache.isis.applib.services.eventbus.EventBusService event bus} using a custom (subclass of)
@@ -196,12 +169,10 @@ public @interface DomainObject {
* This subclass must provide a no-arg constructor; the fields are set reflectively.
* </p>
*/
- // tag::refguide-lifecycle-events[]
Class<? extends ObjectPersistingEvent<?>>
- persistingLifecycleEvent() // <.>
+ persistingLifecycleEvent()
default ObjectPersistingEvent.Default.class;
- // end::refguide-lifecycle-events[]
/**
* Indicates that the loading of the domain object should be posted to the
* {@link org.apache.isis.applib.services.eventbus.EventBusService event bus} using a custom (subclass of)
@@ -211,12 +182,10 @@ public @interface DomainObject {
* This subclass must provide a no-arg constructor; the fields are set reflectively.
* </p>
*/
- // tag::refguide-lifecycle-events[]
Class<? extends ObjectPersistedEvent<?>>
- persistedLifecycleEvent() // <.>
+ persistedLifecycleEvent()
default ObjectPersistedEvent.Default.class;
- // end::refguide-lifecycle-events[]
/**
* Indicates that the loading of the domain object should be posted to the
* {@link org.apache.isis.applib.services.eventbus.EventBusService event bus} using a custom (subclass of)
@@ -226,12 +195,10 @@ public @interface DomainObject {
* This subclass must provide a no-arg constructor; the fields are set reflectively.
* </p>
*/
- // tag::refguide-lifecycle-events[]
Class<? extends ObjectLoadedEvent<?>>
- loadedLifecycleEvent() // <.>
+ loadedLifecycleEvent()
default ObjectLoadedEvent.Default.class;
- // end::refguide-lifecycle-events[]
/**
* Indicates that the loading of the domain object should be posted to the
* {@link org.apache.isis.applib.services.eventbus.EventBusService event bus} using a custom (subclass of)
@@ -241,12 +208,10 @@ public @interface DomainObject {
* This subclass must provide a no-arg constructor; the fields are set reflectively.
* </p>
*/
- // tag::refguide-lifecycle-events[]
Class<? extends ObjectUpdatingEvent<?>>
- updatingLifecycleEvent() // <.>
+ updatingLifecycleEvent()
default ObjectUpdatingEvent.Default.class;
- // end::refguide-lifecycle-events[]
/**
* Indicates that the loading of the domain object should be posted to the
* {@link org.apache.isis.applib.services.eventbus.EventBusService event bus} using a custom (subclass of)
@@ -256,12 +221,10 @@ public @interface DomainObject {
* This subclass must provide a no-arg constructor; the fields are set reflectively.
* </p>
*/
- // tag::refguide-lifecycle-events[]
Class<? extends ObjectUpdatedEvent<?>>
- updatedLifecycleEvent() // <.>
+ updatedLifecycleEvent()
default ObjectUpdatedEvent.Default.class;
- // end::refguide-lifecycle-events[]
/**
* Indicates that the loading of the domain object should be posted to the
* {@link org.apache.isis.applib.services.eventbus.EventBusService event bus} using a custom (subclass of)
@@ -271,12 +234,10 @@ public @interface DomainObject {
* This subclass must provide a no-arg constructor; the fields are set reflectively.
* </p>
*/
- // tag::refguide-lifecycle-events[]
Class<? extends ObjectRemovingEvent<?>>
- removingLifecycleEvent() // <.>
+ removingLifecycleEvent()
default ObjectRemovingEvent.Default.class;
- // end::refguide-lifecycle-events[]
/**
* Indicates that an invocation of <i>any</i> action of the domain object (that do not themselves specify their own
* <tt>@Action(domainEvent=...)</tt> should be posted to the
@@ -304,12 +265,10 @@ public @interface DomainObject {
* It must also use <tt>Object</tt> as its generic type. This is to allow mixins to also emit the same event.
* </p>
*/
- // tag::refguide-domain-events[]
Class<? extends ActionDomainEvent<?>>
- actionDomainEvent() // <.>
+ actionDomainEvent()
default ActionDomainEvent.Default.class;
- // end::refguide-domain-events[]
/**
* Indicates that changes to <i>any</i> property of the domain object (that do not themselves specify their own
* <tt>@Property(domainEvent=...)</tt> should be posted to the
@@ -332,12 +291,10 @@ public @interface DomainObject {
* It must also use <tt>Object</tt> as its generic type. This is to allow mixins to also emit the same event.
* </p>
*/
- // tag::refguide-domain-events[]
Class<? extends PropertyDomainEvent<?,?>>
- propertyDomainEvent() // <.>
+ propertyDomainEvent()
default PropertyDomainEvent.Default.class;
- // end::refguide-domain-events[]
/**
* Indicates that changes to <i>any</i> collection of the domain object (that do not themselves specify their own
* <tt>@Collection(domainEvent=...)</tt> should be posted to the
@@ -359,17 +316,9 @@ public @interface DomainObject {
* It must also use <tt>Object</tt> as its generic type. This is to allow mixins to also emit the same event.
* </p>
*/
- // tag::refguide-domain-events[]
Class<? extends CollectionDomainEvent<?,?>>
- collectionDomainEvent() // <.>
+ collectionDomainEvent()
default CollectionDomainEvent.Default.class;
- // end::refguide-domain-events[]
- // tag::refguide[]
- // tag::refguide-lifecycle-events[]
// ...
- // tag::refguide-domain-events[]
}
-// end::refguide[]
-// end::refguide-lifecycle-events[]
-// end::refguide-domain-events[]
diff --git a/api/applib/src/main/java/org/apache/isis/applib/annotation/DomainObjectLayout.java b/api/applib/src/main/java/org/apache/isis/applib/annotation/DomainObjectLayout.java
index 529292b..8a8b660 100644
--- a/api/applib/src/main/java/org/apache/isis/applib/annotation/DomainObjectLayout.java
+++ b/api/applib/src/main/java/org/apache/isis/applib/annotation/DomainObjectLayout.java
@@ -37,44 +37,34 @@ import org.apache.isis.applib.layout.component.CssClassFaPosition;
*
* @since 1.x {@index}
*/
-// tag::refguide[]
@Inherited
@Target({
ElementType.TYPE,
ElementType.ANNOTATION_TYPE
})
@Retention(RetentionPolicy.RUNTIME)
-// tag::refguide-ui-events[]
public @interface DomainObjectLayout {
- // end::refguide[]
// ...
- // end::refguide-ui-events[]
/**
* Whether (and how) this domain object can be bookmarked in the UI.
*/
- // tag::refguide[]
- BookmarkPolicy bookmarking() // <.>
+ BookmarkPolicy bookmarking()
default BookmarkPolicy.NOT_SPECIFIED;
- // end::refguide[]
/**
* Indicates the css class that a domain class (type) should have.
*/
- // tag::refguide[]
- String cssClass() // <.>
+ String cssClass()
default "";
- // end::refguide[]
/**
* Indicates the <a href="http://fortawesome.github.io/Font-Awesome/">Font Awesome</a> CSS class to decorate an
* domain object.
*/
- // tag::refguide[]
- String cssClassFa() // <.>
+ String cssClassFa()
default "";
- // end::refguide[]
/**
* Indicates the position of the <a href="http://fortawesome.github.io/Font-Awesome/">Font Awesome</a>
* icon. The icon could be rendered on the left or the right of the object's title.
@@ -83,27 +73,21 @@ public @interface DomainObjectLayout {
* This attribute is currently ignored by Isis viewers.
* </p>
*/
- // tag::refguide[]
- CssClassFaPosition cssClassFaPosition() // <.>
+ CssClassFaPosition cssClassFaPosition()
default CssClassFaPosition.LEFT;
- // end::refguide[]
/**
* Description of this class, eg to be rendered in a tooltip.
*/
- // tag::refguide[]
- String describedAs() // <.>
+ String describedAs()
default "";
- // end::refguide[]
/**
* Name of this class (overriding the name derived from its name in code).
*/
- // tag::refguide[]
- String named() // <.>
+ String named()
default "";
- // end::refguide[]
/**
* The page size for instances of this class when rendered within
* a table.
@@ -116,19 +100,15 @@ public @interface DomainObjectLayout {
* If annotated on a type, then the page size refers to standalone
* collections (eg as returned from a repository query).
*/
- // tag::refguide[]
- int paged() // <.>
+ int paged()
default -1;
- // end::refguide[]
/**
* The plural name of the class.
*/
- // tag::refguide[]
- String plural() // <.>
+ String plural()
default "";
- // end::refguide[]
/**
* Which subclass of {@link CssClassUiEvent} should be used to obtain a CSS class.
*
@@ -136,12 +116,10 @@ public @interface DomainObjectLayout {
* This subclass must provide a no-arg constructor; the fields are set reflectively.
* </p>
*/
- // tag::refguide-ui-events[]
Class<? extends CssClassUiEvent<?>>
- cssClassUiEvent() // <.>
+ cssClassUiEvent()
default CssClassUiEvent.Default.class;
- // end::refguide-ui-events[]
/**
* Which subclass of {@link IconUiEvent} should be used to obtain an icon.
*
@@ -149,12 +127,10 @@ public @interface DomainObjectLayout {
* This subclass must provide a no-arg constructor; the fields are set reflectively.
* </p>
*/
- // tag::refguide-ui-events[]
Class<? extends IconUiEvent<?>>
- iconUiEvent() // <.>
+ iconUiEvent()
default IconUiEvent.Default.class;
- // end::refguide-ui-events[]
/**
* Which subclass of {@link LayoutUiEvent} should be used to obtain a layout.
*
@@ -162,12 +138,10 @@ public @interface DomainObjectLayout {
* This subclass must provide a no-arg constructor; the fields are set reflectively.
* </p>
*/
- // tag::refguide-ui-events[]
Class<? extends LayoutUiEvent<?>>
- layoutUiEvent() // <.>
+ layoutUiEvent()
default LayoutUiEvent.Default.class;
- // end::refguide-ui-events[]
/**
* Which subclass of {@link TitleUiEvent} should be used to obtain a title.
*
@@ -175,16 +149,10 @@ public @interface DomainObjectLayout {
* This subclass must provide a no-arg constructor; the fields are set reflectively.
* </p>
*/
- // tag::refguide-ui-events[]
Class<? extends TitleUiEvent<?>>
- titleUiEvent() // <.>
+ titleUiEvent()
default TitleUiEvent.Default.class;
- // end::refguide-ui-events[]
- // tag::refguide[]
// ...
- // tag::refguide-ui-events[]
}
-// end::refguide[]
-// end::refguide-ui-events[]
diff --git a/api/applib/src/main/java/org/apache/isis/applib/annotation/DomainService.java b/api/applib/src/main/java/org/apache/isis/applib/annotation/DomainService.java
index 3e1408f..cc3eb6f 100644
--- a/api/applib/src/main/java/org/apache/isis/applib/annotation/DomainService.java
+++ b/api/applib/src/main/java/org/apache/isis/applib/annotation/DomainService.java
@@ -42,7 +42,6 @@ import org.springframework.stereotype.Service;
*
* @since 1.x {@index}
*/
-// tag::refguide[]
@Inherited
@Target({
ElementType.TYPE,
@@ -52,24 +51,19 @@ import org.springframework.stereotype.Service;
@Service @Singleton
public @interface DomainService {
- // end::refguide[]
/**
* The nature of this service, eg for menus, contributed actions, repository.
*/
- // tag::refguide[]
- NatureOfService nature() // <.>
+ NatureOfService nature()
default NatureOfService.VIEW;
- // end::refguide[]
/**
* Provides the (first part of the) unique identifier (OID) for the service (the instanceId is always "1").
*
* <p>
* If not specified then either the optional "getId()" is used, otherwise the class' name.
*/
- // tag::refguide[]
- String objectType() // <.>
+ String objectType()
default "";
}
-// end::refguide[]
diff --git a/api/applib/src/main/java/org/apache/isis/applib/annotation/DomainServiceLayout.java b/api/applib/src/main/java/org/apache/isis/applib/annotation/DomainServiceLayout.java
index 7a67669..4ca5752 100644
--- a/api/applib/src/main/java/org/apache/isis/applib/annotation/DomainServiceLayout.java
+++ b/api/applib/src/main/java/org/apache/isis/applib/annotation/DomainServiceLayout.java
@@ -34,7 +34,6 @@ import java.lang.annotation.Target;
*
* @since 1.x {@index}
*/
-// tag::refguide[]
@Inherited
@Target({
ElementType.TYPE,
@@ -43,33 +42,24 @@ import java.lang.annotation.Target;
@Retention(RetentionPolicy.RUNTIME)
public @interface DomainServiceLayout {
- // end::refguide[]
/**
* The menubar in which the menu that holds this service's actions should reside.
*/
- // tag::refguide[]
- MenuBar menuBar() // <.>
+ MenuBar menuBar()
default MenuBar.NOT_SPECIFIED;
- // end::refguide[]
/**
* Name of this class (overriding the name derived from its name in code).
*/
- // tag::refguide[]
- String named() // <.>
+ String named()
default "";
- // end::refguide[]
- // tag::refguide-menu-bar[]
public enum MenuBar {
PRIMARY,
SECONDARY,
TERTIARY,
NOT_SPECIFIED
}
- // end::refguide-menu-bar[]
- // tag::refguide[]
}
-// end::refguide[]
diff --git a/api/applib/src/main/java/org/apache/isis/applib/annotation/Editing.java b/api/applib/src/main/java/org/apache/isis/applib/annotation/Editing.java
index e5c6201..614badf 100644
--- a/api/applib/src/main/java/org/apache/isis/applib/annotation/Editing.java
+++ b/api/applib/src/main/java/org/apache/isis/applib/annotation/Editing.java
@@ -22,10 +22,8 @@ package org.apache.isis.applib.annotation;
* The available policies for editing properties and collections.
* @since 1.x {@index}
*/
-// tag::refguide[]
public enum Editing {
- // end::refguide[]
/**
* The editing of the object should be as per the default editing policy configured in <tt>application.properties</tt>.
*
@@ -33,30 +31,22 @@ public enum Editing {
* If no editing policy is configured, then the editing is enabled.
* </p>
*/
- // tag::refguide[]
AS_CONFIGURED,
- // end::refguide[]
/**
* Audit changes to this object.
*/
- // tag::refguide[]
ENABLED,
- // end::refguide[]
/**
* Do not allow the properties to be edited, or the collections to be added to/removed from.
*/
- // tag::refguide[]
DISABLED,
- // end::refguide[]
/**
* Ignore the value provided by this annotation (meaning that the framework will keep searching, in meta
* annotations or superclasses/interfaces).
*/
- // tag::refguide[]
NOT_SPECIFIED
}
-// end::refguide[]
diff --git a/api/applib/src/main/java/org/apache/isis/applib/annotation/EntityChangeKind.java b/api/applib/src/main/java/org/apache/isis/applib/annotation/EntityChangeKind.java
index 8365963..032bfd8 100644
--- a/api/applib/src/main/java/org/apache/isis/applib/annotation/EntityChangeKind.java
+++ b/api/applib/src/main/java/org/apache/isis/applib/annotation/EntityChangeKind.java
@@ -22,7 +22,6 @@ package org.apache.isis.applib.annotation;
*
* @since 1.x {@index}
*/
-// tag::refguide[]
public enum EntityChangeKind {
CREATE,
@@ -32,4 +31,3 @@ public enum EntityChangeKind {
DELETE,
}
-// end::refguide[]
diff --git a/api/applib/src/main/java/org/apache/isis/applib/annotation/EqualByContent.java b/api/applib/src/main/java/org/apache/isis/applib/annotation/EqualByContent.java
index fa8849d..f51100d 100644
--- a/api/applib/src/main/java/org/apache/isis/applib/annotation/EqualByContent.java
+++ b/api/applib/src/main/java/org/apache/isis/applib/annotation/EqualByContent.java
@@ -58,7 +58,6 @@ import java.util.HashMap;
* </p>
* @since 1.x {@index}
*/
-// tag::refguide[]
@Inherited
@Target({
ElementType.TYPE,
@@ -67,4 +66,3 @@ import java.util.HashMap;
@Retention(RetentionPolicy.RUNTIME)
public @interface EqualByContent {
}
-// end::refguide[]
diff --git a/api/applib/src/main/java/org/apache/isis/applib/annotation/Facets.java b/api/applib/src/main/java/org/apache/isis/applib/annotation/Facets.java
index b079cc0..097f9ee 100644
--- a/api/applib/src/main/java/org/apache/isis/applib/annotation/Facets.java
+++ b/api/applib/src/main/java/org/apache/isis/applib/annotation/Facets.java
@@ -34,13 +34,11 @@ import java.lang.annotation.Target;
* factory (as per {@link #facetFactoryClasses()}) should be specified.
* @since 1.x {@index}
*/
-// tag::refguide[]
@Inherited
@Target({ ElementType.TYPE })
@Retention(RetentionPolicy.RUNTIME)
public @interface Facets {
- // end::refguide[]
/**
* Array of fully qualified names of classes each implementing
* <tt>org.apache.isis.core.metamodel.facets.FacetFactory</tt>.
@@ -49,10 +47,8 @@ public @interface Facets {
* Either the array provided by this method or by
* {@link #facetFactoryClasses()} should be non-empty.
*/
- // tag::refguide[]
String[] facetFactoryNames() default {};
- // end::refguide[]
/**
* Array of {@link Class}s, each indicating a class implementing
* <tt>org.apache.isis.core.metamodel.facets.FacetFactory</tt>.
@@ -61,8 +57,6 @@ public @interface Facets {
* Either the array provided by this method or by
* {@link #facetFactoryNames()} should be non-empty.
*/
- // tag::refguide[]
Class<?>[] facetFactoryClasses() default {};
}
-// end::refguide[]
diff --git a/api/applib/src/main/java/org/apache/isis/applib/annotation/HomePage.java b/api/applib/src/main/java/org/apache/isis/applib/annotation/HomePage.java
index a5c2127..e8e4533 100644
--- a/api/applib/src/main/java/org/apache/isis/applib/annotation/HomePage.java
+++ b/api/applib/src/main/java/org/apache/isis/applib/annotation/HomePage.java
@@ -35,10 +35,8 @@ import java.lang.annotation.Target;
* </p>
* @since 2.0 {@index}
*/
-// tag::refguide[]
@Inherited
@Target({ ElementType.TYPE })
@Retention(RetentionPolicy.RUNTIME)
public @interface HomePage {
}
-// end::refguide[]
diff --git a/api/applib/src/main/java/org/apache/isis/applib/annotation/LabelPosition.java b/api/applib/src/main/java/org/apache/isis/applib/annotation/LabelPosition.java
index 818b60e..2219b82 100644
--- a/api/applib/src/main/java/org/apache/isis/applib/annotation/LabelPosition.java
+++ b/api/applib/src/main/java/org/apache/isis/applib/annotation/LabelPosition.java
@@ -27,7 +27,6 @@ import javax.xml.bind.annotation.XmlType;
* @see org.apache.isis.applib.annotation.PropertyLayout
* @see org.apache.isis.applib.annotation.ParameterLayout
*/
-// tag::refguide[]
@XmlType(
namespace = "http://isis.apache.org/applib/layout/component"
)
@@ -35,22 +34,17 @@ public enum LabelPosition {
DEFAULT,
LEFT,
- // end::refguide[]
/**
* Right position of the label for Boolean properties.
* <strong>Not supported</strong> for now for other types.
*/
- // tag::refguide[]
RIGHT,
TOP,
NONE,
- // end::refguide[]
/**
* Ignore the value provided by this annotation (meaning that the framework will keep searching, in meta
* annotations or superclasses/interfaces).
*/
- // tag::refguide[]
NOT_SPECIFIED
}
-// end::refguide[]
diff --git a/api/applib/src/main/java/org/apache/isis/applib/annotation/MemberOrder.java b/api/applib/src/main/java/org/apache/isis/applib/annotation/MemberOrder.java
index 999d08b..dcd1c1f 100644
--- a/api/applib/src/main/java/org/apache/isis/applib/annotation/MemberOrder.java
+++ b/api/applib/src/main/java/org/apache/isis/applib/annotation/MemberOrder.java
@@ -34,13 +34,11 @@ import java.lang.annotation.Target;
* </p>
* @since 1.x {@index}
*/
-// tag::refguide[]
@Inherited
@Target({ ElementType.METHOD, ElementType.FIELD })
@Retention(RetentionPolicy.RUNTIME)
public @interface MemberOrder {
- // end::refguide[]
/**
* Groups or associate members with each other.
*
@@ -50,18 +48,14 @@ public @interface MemberOrder {
* <li>For collections, currently has no meaning</li>
* </ul>
*/
- // tag::refguide[]
- String name() // <.>
+ String name()
default "";
- // end::refguide[]
/**
* The order of this member relative to other members in the same group, in
* Dewey-decimal notation. For collections this is relative to each other
* (collections aren't grouped).
*/
- // tag::refguide[]
- String sequence(); // <.>
+ String sequence();
}
-// end::refguide[]
diff --git a/api/applib/src/main/java/org/apache/isis/applib/annotation/MementoSerialization.java b/api/applib/src/main/java/org/apache/isis/applib/annotation/MementoSerialization.java
index c7f8a8a..cf670a6 100644
--- a/api/applib/src/main/java/org/apache/isis/applib/annotation/MementoSerialization.java
+++ b/api/applib/src/main/java/org/apache/isis/applib/annotation/MementoSerialization.java
@@ -22,18 +22,14 @@ package org.apache.isis.applib.annotation;
* Whether the property or collection is included if the domain object is serialized into a memento.
* @since 1.x {@index}
*/
-// tag::refguide[]
public enum MementoSerialization {
- // end::refguide[]
/**
* Property or collection is included in any mementos.
* This is the fallback/default if not explicitly excluded.
*/
- // tag::refguide[]
INCLUDED,
- // end::refguide[]
/**
* Property or collection's state is excluded from any mementos.
*
@@ -41,16 +37,12 @@ public enum MementoSerialization {
* Corresponds to <tt>@Property(notPersisted=true)</tt> or <tt>@Collection(notPersisted=true)</tt> prior to Isis 2.x
* </p>
*/
- // tag::refguide[]
EXCLUDED,
- // end::refguide[]
/**
* Ignore the value provided by this annotation (meaning that the framework will keep searching, in meta
* annotations or superclasses/interfaces).
*/
- // tag::refguide[]
NOT_SPECIFIED
}
-// end::refguide[]
diff --git a/api/applib/src/main/java/org/apache/isis/applib/annotation/MinLength.java b/api/applib/src/main/java/org/apache/isis/applib/annotation/MinLength.java
index 9f4c824..2afcfc2 100644
--- a/api/applib/src/main/java/org/apache/isis/applib/annotation/MinLength.java
+++ b/api/applib/src/main/java/org/apache/isis/applib/annotation/MinLength.java
@@ -29,11 +29,9 @@ import java.lang.annotation.Target;
* Specify the minimum number of characters for an autocomplete search argument.
* @since 1.x {@index}
*/
-// tag::refguide[]
@Inherited
@Target({ ElementType.PARAMETER })
@Retention(RetentionPolicy.RUNTIME)
public @interface MinLength {
int value();
}
-// end::refguide[]
diff --git a/api/applib/src/main/java/org/apache/isis/applib/annotation/Module.java b/api/applib/src/main/java/org/apache/isis/applib/annotation/Module.java
index 92528cf..6d6d2ee 100644
--- a/api/applib/src/main/java/org/apache/isis/applib/annotation/Module.java
+++ b/api/applib/src/main/java/org/apache/isis/applib/annotation/Module.java
@@ -50,7 +50,6 @@ import org.springframework.context.annotation.Import;
* scanning more classes than are needed. It is therefore not used within the framework code, but is
* provided as a convenience by domain applications.
*/
-// tag::refguide[]
@Inherited
@Target({ ElementType.TYPE })
@Retention(RetentionPolicy.RUNTIME)
@@ -59,4 +58,3 @@ import org.springframework.context.annotation.Import;
@ComponentScan
public @interface Module {
}
-// end::refguide[]
diff --git a/api/applib/src/main/java/org/apache/isis/applib/annotation/Nature.java b/api/applib/src/main/java/org/apache/isis/applib/annotation/Nature.java
index 22615f8..648963d 100644
--- a/api/applib/src/main/java/org/apache/isis/applib/annotation/Nature.java
+++ b/api/applib/src/main/java/org/apache/isis/applib/annotation/Nature.java
@@ -29,19 +29,15 @@ import javax.xml.bind.annotation.XmlRootElement;
* </p>
* @since 1.x {@index}
*/
-// tag::refguide[]
public enum Nature {
- // end::refguide[]
/**
* The default; allows the programmer to combine <tt>@DomainObject</tt> annotation with the
* {@link ViewModel} annotation, or the {@link XmlRootElement} annotation, or by implementing the
* {@link org.apache.isis.applib.ViewModel} interface.
*/
- // tag::refguide[]
NOT_SPECIFIED,
- // end::refguide[]
/**
* A domain entity whose persistence is managed internally by Isis, using JDO as the persistence implementation.
* Domain entities are considered to be part of the domain model layer.
@@ -54,10 +50,8 @@ public enum Nature {
* Currently implies no additional semantics other than documentation.
* </p>
*/
- // tag::refguide[]
JDO_ENTITY,
- // end::refguide[]
/**
* A domain entity whose persistence is managed internally by Isis, using JPA as the persistence implementation.
* Domain entities are considered to be part of the domain model layer.
@@ -70,10 +64,8 @@ public enum Nature {
* Currently implies no additional semantics other than documentation.
* </p>
*/
- // tag::refguide[]
JPA_ENTITY,
- // end::refguide[]
/**
* An object that is conceptually part of the application layer, and which surfaces behavior and/or state that
* is aggregate of one or more domain entity.
@@ -93,27 +85,21 @@ public enum Nature {
*
* @see ViewModel
*/
- // tag::refguide[]
VIEW_MODEL,
- // end::refguide[]
/**
* An object that acts as a mix-in to some other object, contributing behavior and/or derived state based on the
* domain object.
*
* @see Mixin
*/
- // tag::refguide[]
MIXIN,
- // end::refguide[]
/**
* An object that is entirely managed by the underlying IoC container.
* @apiNote EXPERIMENTAL
*/
- // tag::refguide[]
BEAN,
- // end::refguide[]
;
public boolean isEntity() {
@@ -122,6 +108,5 @@ public enum Nature {
}
- // tag::refguide[]
}
//end::refguide[]
diff --git a/api/applib/src/main/java/org/apache/isis/applib/annotation/NatureOfService.java b/api/applib/src/main/java/org/apache/isis/applib/annotation/NatureOfService.java
index 8e05cb6..f4e0550 100644
--- a/api/applib/src/main/java/org/apache/isis/applib/annotation/NatureOfService.java
+++ b/api/applib/src/main/java/org/apache/isis/applib/annotation/NatureOfService.java
@@ -22,9 +22,7 @@ package org.apache.isis.applib.annotation;
* The different sorts of domain services recognized by Isis, as specified in {@link DomainService#nature()}
* @since 1.x {@index}
*/
-// tag::refguide[]
public enum NatureOfService {
- // end::refguide[]
/**
* The service's actions appear in the REST API and in 'viewers', eg. in the menu bar.
*
@@ -32,15 +30,11 @@ public enum NatureOfService {
* Contributing actions to the 'viewer' implies, that these must also be exposed to the REST API,
* simply because alternative viewers might be solely based on the provided REST end-points.
*/
- // tag::refguide[]
VIEW,
- // end::refguide[]
/**
* The service's actions should only be visible in the REST API exposed by the Restful Objects viewer.
*/
- // tag::refguide[]
REST,
- // end::refguide[]
;
@@ -62,7 +56,5 @@ public enum NatureOfService {
return this == REST;
}
- // tag::refguide[]
}
-// end::refguide[]
diff --git a/api/applib/src/main/java/org/apache/isis/applib/annotation/Navigable.java b/api/applib/src/main/java/org/apache/isis/applib/annotation/Navigable.java
index 6ffa291..00ed67f 100644
--- a/api/applib/src/main/java/org/apache/isis/applib/annotation/Navigable.java
+++ b/api/applib/src/main/java/org/apache/isis/applib/annotation/Navigable.java
@@ -25,20 +25,16 @@ package org.apache.isis.applib.annotation;
*
* @since 2.0 {@index}
*/
-// tag::refguide[]
public enum Navigable {
NOT_SPECIFIED,
IGNORE,
PARENT,
- // end::refguide[]
;
public boolean isParent() {
return this == PARENT;
}
- // tag::refguide[]
}
-// end::refguide[]
diff --git a/api/applib/src/main/java/org/apache/isis/applib/annotation/Optionality.java b/api/applib/src/main/java/org/apache/isis/applib/annotation/Optionality.java
index c19616c..fcbc434 100644
--- a/api/applib/src/main/java/org/apache/isis/applib/annotation/Optionality.java
+++ b/api/applib/src/main/java/org/apache/isis/applib/annotation/Optionality.java
@@ -22,10 +22,8 @@ package org.apache.isis.applib.annotation;
* Whether the property or parameter is optional or is required (aka mandatory).
* @since 1.x {@index}
*/
-// tag::refguide[]
public enum Optionality {
- // end::refguide[]
/**
* Default, usually meaning mandatory for properties and always meaning mandatory for parameters.
*
@@ -34,17 +32,13 @@ public enum Optionality {
* <code>javax.jdo.annotations.Column#allowsNull()</code> set to <code>true</code>.
* </p>
*/
- // tag::refguide[]
DEFAULT,
- // end::refguide[]
/**
* Indicates that the property or parameter is not required.
*/
- // tag::refguide[]
OPTIONAL,
- // end::refguide[]
/**
* Indicates that the property is required (even if the JDO <code>javax.jdo.annotations.Column</code> annotation
* says otherwise).
@@ -63,16 +57,12 @@ public enum Optionality {
* is unable to do so.
* </p>
*/
- // tag::refguide[]
MANDATORY,
- // end::refguide[]
/**
* Ignore the value provided by this annotation (meaning that the framework will keep searching, in meta
* annotations or superclasses/interfaces).
*/
- // tag::refguide[]
NOT_SPECIFIED
}
-// end::refguide[]
diff --git a/api/applib/src/main/java/org/apache/isis/applib/annotation/OrderPrecedence.java b/api/applib/src/main/java/org/apache/isis/applib/annotation/OrderPrecedence.java
index 98b394c..8c2a72e 100644
--- a/api/applib/src/main/java/org/apache/isis/applib/annotation/OrderPrecedence.java
+++ b/api/applib/src/main/java/org/apache/isis/applib/annotation/OrderPrecedence.java
@@ -27,11 +27,9 @@ import lombok.experimental.UtilityClass;
*
* @since 1.x {@index}
*/
-// tag::refguide[]
@UtilityClass
public class OrderPrecedence {
- // end::refguide[]
/**
* For domain services with the highest precedence value.
* No framework services use this constant, but some very fundamental services (eg for security)
@@ -40,40 +38,30 @@ public class OrderPrecedence {
* @see java.lang.Integer#MIN_VALUE
* @see Ordered#HIGHEST_PRECEDENCE
*/
- // tag::refguide[]
public static final int FIRST = Ordered.HIGHEST_PRECEDENCE;
- // end::refguide[]
/**
* For framework for services that are unlikely to be overridden by application code.
*/
- // tag::refguide[]
public static final int EARLY = FIRST / 2;
- // end::refguide[]
/**
* For framework for services that could be overridden by application code (though not commonly).
*/
- // tag::refguide[]
public static final int MIDPOINT = 0;
- // end::refguide[]
/**
* For framework services that are expected to be overridden by application code, or that act as a fallback.
*/
- // tag::refguide[]
public static final int LATE = OrderPrecedence.LAST / 2;
- // end::refguide[]
/**
* For domain services that act as a fallback, and which will typically be overridden.
*
* @see java.lang.Integer#MAX_VALUE
* @see Ordered#LOWEST_PRECEDENCE
*/
- // tag::refguide[]
public static final int LAST = Ordered.LOWEST_PRECEDENCE;
}
-// end::refguide[]
diff --git a/api/applib/src/main/java/org/apache/isis/applib/annotation/Parameter.java b/api/applib/src/main/java/org/apache/isis/applib/annotation/Parameter.java
index 14ae1c6..dfac135 100644
--- a/api/applib/src/main/java/org/apache/isis/applib/annotation/Parameter.java
+++ b/api/applib/src/main/java/org/apache/isis/applib/annotation/Parameter.java
@@ -33,7 +33,6 @@ import org.apache.isis.applib.value.Clob;
* Domain semantics for domain object collection.
* @since 1.x {@index}
*/
-// tag::refguide[]
@Inherited
@Target({
ElementType.PARAMETER,
@@ -42,7 +41,6 @@ import org.apache.isis.applib.value.Clob;
@Retention(RetentionPolicy.RUNTIME)
public @interface Parameter {
- // end::refguide[]
/**
* For uploading {@link Blob} or {@link Clob}, optionally restrict the files accepted (eg <tt>.xslx</tt>).
*
@@ -52,11 +50,9 @@ public @interface Parameter {
*
* @see <a href="http://www.w3schools.com/tags/att_input_accept.asp">http://www.w3schools.com</a>
*/
- // tag::refguide[]
- String fileAccept() // <.>
+ String fileAccept()
default "";
- // end::refguide[]
/**
* The maximum entry length of a field.
*
@@ -64,11 +60,9 @@ public @interface Parameter {
* The default value (<code>-1</code>) indicates that no maxLength has been specified.
* </p>
*/
- // tag::refguide[]
- int maxLength() // <.>
+ int maxLength()
default -1;
- // end::refguide[]
/**
* The {@link org.apache.isis.applib.spec.Specification}(s) to be satisfied by this parameter.
*
@@ -76,11 +70,9 @@ public @interface Parameter {
* If more than one is provided, then all must be satisfied (in effect "AND"ed together).
* </p>
*/
- // tag::refguide[]
- Class<? extends Specification>[] mustSatisfy() // <.>
+ Class<? extends Specification>[] mustSatisfy()
default {};
- // end::refguide[]
/**
* Whether this parameter is optional or is mandatory (ie required).
*
@@ -89,19 +81,15 @@ public @interface Parameter {
* to mean that the parameter is required.
* </p>
*/
- // tag::refguide[]
- Optionality optionality() // <.>
+ Optionality optionality()
default Optionality.NOT_SPECIFIED;
- // end::refguide[]
/**
* Regular expression pattern that a value should conform to, and can be formatted as.
*/
- // tag::refguide[]
- String regexPattern() // <.>
+ String regexPattern()
default "";
- // end::refguide[]
/**
* Pattern flags, as per {@link java.util.regex.Pattern#compile(String, int)} .
*
@@ -109,18 +97,14 @@ public @interface Parameter {
* The default value, <code>0</code>, means that no flags have been specified.
* </p>
*/
- // tag::refguide[]
- int regexPatternFlags() // <.>
+ int regexPatternFlags()
default 0;
- // end::refguide[]
/**
* Replacement text for the pattern in generated error message.
*/
- // tag::refguide[]
- String regexPatternReplacement() // <.>
+ String regexPatternReplacement()
default "Doesn't match pattern";
}
-// end::refguide[]
diff --git a/api/applib/src/main/java/org/apache/isis/applib/annotation/ParameterLayout.java b/api/applib/src/main/java/org/apache/isis/applib/annotation/ParameterLayout.java
index 3972fd4..f149a1a 100644
--- a/api/applib/src/main/java/org/apache/isis/applib/annotation/ParameterLayout.java
+++ b/api/applib/src/main/java/org/apache/isis/applib/annotation/ParameterLayout.java
@@ -31,7 +31,6 @@ import java.lang.annotation.Target;
* @since 1.x {@index}
* @see org.apache.isis.applib.annotation.PropertyLayout
*/
-// tag::refguide[]
@Inherited
@Target({
ElementType.PARAMETER,
@@ -40,23 +39,18 @@ import java.lang.annotation.Target;
@Retention(RetentionPolicy.RUNTIME)
public @interface ParameterLayout {
- // end::refguide[]
/**
* Indicates the css class that a parameter should have.
*/
- // tag::refguide[]
- String cssClass() // <.>
+ String cssClass()
default "";
- // end::refguide[]
/**
* Description of this property, eg to be rendered in a tooltip.
*/
- // tag::refguide[]
- String describedAs() // <.>
+ String describedAs()
default "";
- // end::refguide[]
/**
* In forms, positioning of the label (left, top or none) relative to the parameter value.
*
@@ -64,35 +58,27 @@ public @interface ParameterLayout {
* If not specified, the default depends upon the parameter value's datatype.
* </p>
*/
- // tag::refguide[]
- LabelPosition labelPosition() // <.>
+ LabelPosition labelPosition()
default LabelPosition.NOT_SPECIFIED;
- // end::refguide[]
/**
* Name of this action parameter.
*/
- // tag::refguide[]
- String named() // <.>
+ String named()
default "";
- // end::refguide[]
/**
* A flag indicating whether the value of {@linkplain #named()} should be HTML escaped or not.
*/
- // tag::refguide[]
- boolean namedEscaped() // <.>
+ boolean namedEscaped()
default true;
- // end::refguide[]
/**
* For string parameters (and properties), whether to render as a text area over multiple lines.
*/
- // tag::refguide[]
- int multiLine() // <.>
+ int multiLine()
default -1;
- // end::refguide[]
/**
* For date parameters (and properties) only, instructs the viewer that the date should be rendered as one day
* prior to the actually stored date.
@@ -117,17 +103,13 @@ public @interface ParameterLayout {
* In the domain object, itself, however, the value stored is 1-jun-2013.
* </p>
*/
- // tag::refguide[]
- RenderDay renderDay() // <.>
+ RenderDay renderDay()
default RenderDay.NOT_SPECIFIED;
- // end::refguide[]
/**
* The typical entry length of a field, use to determine the optimum width for display
*/
- // tag::refguide[]
- int typicalLength() // <.>
+ int typicalLength()
default -1;
}
-// end::refguide[]
diff --git a/api/applib/src/main/java/org/apache/isis/applib/annotation/Programmatic.java b/api/applib/src/main/java/org/apache/isis/applib/annotation/Programmatic.java
index 3ef620c..4a7efb1 100644
--- a/api/applib/src/main/java/org/apache/isis/applib/annotation/Programmatic.java
+++ b/api/applib/src/main/java/org/apache/isis/applib/annotation/Programmatic.java
@@ -40,7 +40,6 @@ import java.lang.annotation.Target;
* that end up on the classpath of integration tests but should otherwise be ignored.
* @since 1.x {@index}
*/
-// tag::refguide[]
@Inherited
@Target({
ElementType.METHOD,
@@ -50,4 +49,3 @@ import java.lang.annotation.Target;
@Retention(RetentionPolicy.RUNTIME)
public @interface Programmatic {
}
-// end::refguide[]
diff --git a/api/applib/src/main/java/org/apache/isis/applib/annotation/Projecting.java b/api/applib/src/main/java/org/apache/isis/applib/annotation/Projecting.java
index 90ca55a..a06df65 100644
--- a/api/applib/src/main/java/org/apache/isis/applib/annotation/Projecting.java
+++ b/api/applib/src/main/java/org/apache/isis/applib/annotation/Projecting.java
@@ -22,22 +22,16 @@ package org.apache.isis.applib.annotation;
*
* @since 1.x {@index}
*/
-// tag::refguide[]
public enum Projecting {
- // end::refguide[]
/**
* The property holds the underlying domain object of which this (view model) object is a projection.
*/
- // tag::refguide[]
PROJECTED,
- // end::refguide[]
/**
* The property
*/
- // tag::refguide[]
NOT_SPECIFIED;
}
-// end::refguide[]
diff --git a/api/applib/src/main/java/org/apache/isis/applib/annotation/PromptStyle.java b/api/applib/src/main/java/org/apache/isis/applib/annotation/PromptStyle.java
index ac5b95f..2ca00ca 100644
--- a/api/applib/src/main/java/org/apache/isis/applib/annotation/PromptStyle.java
+++ b/api/applib/src/main/java/org/apache/isis/applib/annotation/PromptStyle.java
@@ -24,12 +24,10 @@ import javax.xml.bind.annotation.XmlType;
* How prompting for new values of a property/arguments for an action should be performed
* @since 1.x {@index}
*/
-// tag::refguide[]
@XmlType(
namespace = "http://isis.apache.org/applib/layout/component"
)
public enum PromptStyle {
- // end::refguide[]
/**
* Prompt using the style configured by <tt>isis.viewer.wicket.promptStyle</tt>.
*
@@ -37,9 +35,7 @@ public enum PromptStyle {
* If no style is configured, then {@link #INLINE} is assumed.
* </p>
*/
- // tag::refguide[]
AS_CONFIGURED,
- // end::refguide[]
/**
* Use a dialog for the prompt.
*
@@ -49,27 +45,19 @@ public enum PromptStyle {
* <code>isis.viweer.wicket.dialogMode</code> configuration property.
* </p>
*/
- // tag::refguide[]
DIALOG,
- // end::refguide[]
/**
* Use a dialog for the prompt, rendered in a sidebar.
*/
- // tag::refguide[]
DIALOG_SIDEBAR,
- // end::refguide[]
/**
* Use a dialog for the prompt, rendered in a modal dialog.
*/
- // tag::refguide[]
DIALOG_MODAL,
- // end::refguide[]
/**
* Show the form inline, temporarily replacing the rendering of the property.
*/
- // tag::refguide[]
INLINE,
- // end::refguide[]
/**
* Applies only to actions, show the form inline, invoked as if editing the property.
*
@@ -89,21 +77,15 @@ public enum PromptStyle {
* </p>
*
*/
- // tag::refguide[]
INLINE_AS_IF_EDIT,
- // end::refguide[]
/**
* Ignore the value provided by this annotation (meaning that the framework will keep searching, in meta
* annotations or superclasses/interfaces).
*/
- // tag::refguide[]
NOT_SPECIFIED;
- // end::refguide[]
public boolean isDialog() { return this == DIALOG || this == DIALOG_MODAL || this == DIALOG_SIDEBAR; }
public boolean isInline() { return this == INLINE; }
public boolean isInlineAsIfEdit() { return this == INLINE_AS_IF_EDIT; }
public boolean isInlineOrInlineAsIfEdit() { return this == INLINE || this == INLINE_AS_IF_EDIT; }
- // tag::refguide[]
}
-// end::refguide[]
diff --git a/api/applib/src/main/java/org/apache/isis/applib/annotation/Property.java b/api/applib/src/main/java/org/apache/isis/applib/annotation/Property.java
index ecf483c..1308583 100644
--- a/api/applib/src/main/java/org/apache/isis/applib/annotation/Property.java
+++ b/api/applib/src/main/java/org/apache/isis/applib/annotation/Property.java
@@ -41,7 +41,6 @@ import org.apache.isis.applib.value.Clob;
* Domain semantics for domain object property.
* @since 1.x {@index}
*/
-// tag::refguide[]
@Inherited
@Target({
ElementType.METHOD,
@@ -53,7 +52,6 @@ import org.apache.isis.applib.value.Clob;
@DomainObject(nature=Nature.MIXIN, mixinMethod = "prop") // meta annotation, only applies at class level
public @interface Property {
- // end::refguide[]
/**
* The {@link CommandDtoProcessor} to process this command's DTO.
*
@@ -62,20 +60,16 @@ public @interface Property {
* {@link ContentMappingServiceForCommandsDto} to dynamically transform the DTOs.
* </p>
*/
- // tag::refguide[]
- Class<? extends CommandDtoProcessor> commandDtoProcessor() // <.>
+ Class<? extends CommandDtoProcessor> commandDtoProcessor()
default CommandDtoProcessor.class;
- // end::refguide[]
/**
* Whether property edits, captured as {@link Command}s,
* should be published to {@link CommandSubscriber}s.
*/
- // tag::refguide[]
- Publishing commandPublishing() // <.>
+ Publishing commandPublishing()
default Publishing.NOT_SPECIFIED;
- // end::refguide[]
/**
* Indicates that changes to the property that should be posted to the
* {@link org.apache.isis.applib.services.eventbus.EventBusService event bus} using a custom (subclass of)
@@ -95,11 +89,9 @@ public @interface Property {
* This subclass must provide a no-arg constructor; the fields are set reflectively.
* </p>
*/
- // tag::refguide[]
- Class<? extends PropertyDomainEvent<?,?>> domainEvent() // <.>
+ Class<? extends PropertyDomainEvent<?,?>> domainEvent()
default PropertyDomainEvent.Default.class;
- // end::refguide[]
/**
* Whether the properties of this domain object can be edited, or collections of this object be added to/removed from.
*
@@ -107,30 +99,24 @@ public @interface Property {
* Note that non-editable objects can nevertheless have actions invoked upon them.
* </p>
*/
- // tag::refguide[]
- Editing editing() // <.>
+ Editing editing()
default Editing.NOT_SPECIFIED;
- // end::refguide[]
/**
* If {@link #editing()} is set to {@link Editing#DISABLED},
* then the reason to provide to the user as to why this property cannot be edited.
*/
- // tag::refguide[]
- String editingDisabledReason() // <.>
+ String editingDisabledReason()
default "";
- // end::refguide[]
/**
* Whether {@link Interaction.Execution}s
* (triggered property edits), should be dispatched to
* {@link ExecutionSubscriber}s.
*/
- // tag::refguide[]
- Publishing executionPublishing() // <.>
+ Publishing executionPublishing()
default Publishing.NOT_SPECIFIED;
- // end::refguide[]
/**
* For uploading {@link Blob} or {@link Clob}, optionally restrict the files accepted (eg <tt>.xslx</tt>).
*
@@ -140,19 +126,15 @@ public @interface Property {
*
* @see <a href="http://www.w3schools.com/tags/att_input_accept.asp">http://www.w3schools.com</a>
*/
- // tag::refguide[]
- String fileAccept() // <.>
+ String fileAccept()
default "";
- // end::refguide[]
/**
* Indicates where the property is not visible to the user.
*/
- // tag::refguide[]
- Where hidden() // <.>
+ Where hidden()
default Where.NOT_SPECIFIED;
- // end::refguide[]
/**
* The maximum entry length of a field.
*
@@ -160,11 +142,9 @@ public @interface Property {
* The default value (<code>-1</code>) indicates that no maxLength has been specified.
* </p>
*/
- // tag::refguide[]
- int maxLength() // <.>
+ int maxLength()
default -1;
- // end::refguide[]
/**
* Indicates whether the property should be included or excluded from mementos.
*
@@ -173,11 +153,9 @@ public @interface Property {
* <code>javax.jdo.annotations.NotPersistent</code>
* </p>
*/
- // tag::refguide[]
- MementoSerialization mementoSerialization() // <.>
+ MementoSerialization mementoSerialization()
default MementoSerialization.NOT_SPECIFIED;
- // end::refguide[]
/**
* The {@link org.apache.isis.applib.spec.Specification}(s) to be satisfied by this property.
*
@@ -185,11 +163,9 @@ public @interface Property {
* If more than one is provided, then all must be satisfied (in effect "AND"ed together).
* </p>
*/
- // tag::refguide[]
- Class<? extends Specification>[] mustSatisfy() // <.>
+ Class<? extends Specification>[] mustSatisfy()
default {};
- // end::refguide[]
/**
* Whether this property is optional or is mandatory (ie required).
*
@@ -199,11 +175,9 @@ public @interface Property {
* with its <code>javax.jdo.annotations.Column#allowsNull()</code> attribute set to true.
* </p>
*/
- // tag::refguide[]
- Optionality optionality() // <.>
+ Optionality optionality()
default Optionality.NOT_SPECIFIED;
- // end::refguide[]
/**
* If set to {@link Projecting#PROJECTED projected}, then indicates that the owner of this property is a view model
* which is a projection of some other entity, and that the property holds a reference to that
@@ -218,19 +192,15 @@ public @interface Property {
* Only one such property should be marked as being a projection with a view model.
* </p>
*/
- // tag::refguide[]
- Projecting projecting() // <.>
+ Projecting projecting()
default Projecting.NOT_SPECIFIED;
- // end::refguide[]
/**
* Regular expression pattern that a value should conform to, and can be formatted as.
*/
- // tag::refguide[]
- String regexPattern() // <.>
+ String regexPattern()
default "";
- // end::refguide[]
/**
* Pattern flags, as per {@link java.util.regex.Pattern#compile(String, int)} .
*
@@ -238,17 +208,13 @@ public @interface Property {
* The default value, <code>0</code>, means that no flags have been specified.
* </p>
*/
- // tag::refguide[]
- int regexPatternFlags() // <.>
+ int regexPatternFlags()
default 0;
- // end::refguide[]
/**
* Replacement text for the pattern in generated error message.
*/
- // tag::refguide[]
- String regexPatternReplacement() // <.>
+ String regexPatternReplacement()
default "Doesn't match pattern";
}
-// end::refguide[]
diff --git a/api/applib/src/main/java/org/apache/isis/applib/annotation/PropertyLayout.java b/api/applib/src/main/java/org/apache/isis/applib/annotation/PropertyLayout.java
index 6d8a1f7..1735571 100644
--- a/api/applib/src/main/java/org/apache/isis/applib/annotation/PropertyLayout.java
+++ b/api/applib/src/main/java/org/apache/isis/applib/annotation/PropertyLayout.java
@@ -31,38 +31,30 @@ import java.lang.annotation.Target;
* @since 1.x {@index}
* @see org.apache.isis.applib.annotation.ParameterLayout
*/
-// tag::refguide[]
@Inherited
@Target({ ElementType.METHOD, ElementType.FIELD, ElementType.TYPE, ElementType.ANNOTATION_TYPE })
@Retention(RetentionPolicy.RUNTIME)
@DomainObject(nature=Nature.MIXIN, mixinMethod = "prop") // meta annotation, only applies at class level
public @interface PropertyLayout {
- // end::refguide[]
/**
* Indicates the css class that a property should have.
*/
- // tag::refguide[]
- String cssClass() // <.>
+ String cssClass()
default "";
- // end::refguide[]
/**
* Description of this property, eg to be rendered in a tooltip.
*/
- // tag::refguide[]
- String describedAs() // <.>
+ String describedAs()
default "";
- // end::refguide[]
/**
* Indicates where in the UI the property should <i>not</i>not be visible.
*/
- // tag::refguide[]
- Where hidden() // <.>
+ Where hidden()
default Where.NOT_SPECIFIED;
- // end::refguide[]
/**
* In forms, positioning of the label (left, top or none) relative to the property value.
*
@@ -70,35 +62,27 @@ public @interface PropertyLayout {
* If not specified, the default depends upon the property value's datatype.
* </p>
*/
- // tag::refguide[]
- LabelPosition labelPosition() // <.>
+ LabelPosition labelPosition()
default LabelPosition.NOT_SPECIFIED;
- // end::refguide[]
/**
* For string properties (and parameters), render as a text area over specified number of lines.
*/
- // tag::refguide[]
- int multiLine() // <.>
+ int multiLine()
default -1;
- // end::refguide[]
/**
* Name of this property (overriding the name derived from its name in code).
*/
- // tag::refguide[]
- String named() // <.>
+ String named()
default "";
- // end::refguide[]
/**
* A flag indicating whether the value of {@linkplain #named()} should be HTML escaped or not.
*/
- // tag::refguide[]
- boolean namedEscaped() // <.>
+ boolean namedEscaped()
default true;
- // end::refguide[]
/**
* Whether this property should be used to construct the navigable chain of breadcrumbs in the UI.
*
@@ -108,19 +92,15 @@ public @interface PropertyLayout {
*
* @return
*/
- // tag::refguide[]
- Navigable navigable() // <.>
+ Navigable navigable()
default Navigable.NOT_SPECIFIED;
- // end::refguide[]
/**
* How the properties of this domain object are be edited, either {@link PromptStyle#DIALOG dialog} or {@link PromptStyle#INLINE inline}.
*/
- // tag::refguide[]
- PromptStyle promptStyle() // <.>
+ PromptStyle promptStyle()
default PromptStyle.NOT_SPECIFIED;
- // end::refguide[]
/**
* For date properties (and parameters) only, instructs the viewer that the date should be rendered as one day
* prior to the actually stored date.
@@ -146,11 +126,9 @@ public @interface PropertyLayout {
* In the domain object, itself, however, the value stored is 1-jun-2013.
* </p>
*/
- // tag::refguide[]
- RenderDay renderDay() // <.>
+ RenderDay renderDay()
default RenderDay.NOT_SPECIFIED;
- // end::refguide[]
/**
* Indicates that the value held by the property never changes over time, even when other properties of the object
* do change.
@@ -173,18 +151,14 @@ public @interface PropertyLayout {
* within the framework than simply a hint for rendering.
* </p>
*/
- // tag::refguide[]
- Repainting repainting() // <.>
+ Repainting repainting()
default Repainting.NOT_SPECIFIED;
- // end::refguide[]
/**
* The typical entry length of a field, use to determine the optimum width for display
*/
- // tag::refguide[]
- int typicalLength() // <.>
+ int typicalLength()
default -1;
}
-// end::refguide[]
diff --git a/api/applib/src/main/java/org/apache/isis/applib/annotation/Publishing.java b/api/applib/src/main/java/org/apache/isis/applib/annotation/Publishing.java
index 7d63091..e329608 100644
--- a/api/applib/src/main/java/org/apache/isis/applib/annotation/Publishing.java
+++ b/api/applib/src/main/java/org/apache/isis/applib/annotation/Publishing.java
@@ -39,10 +39,8 @@ import org.apache.isis.applib.services.publishing.spi.ExecutionSubscriber;
* </ul>
* @since 1.x {@index}
*/
-// tag::refguide[]
public enum Publishing {
- // end::refguide[]
/**
* Publishing of data triggered by interaction with this object
* should be handled as per the default publishing policy
@@ -50,31 +48,23 @@ public enum Publishing {
* <p>
* If no publishing policy is configured, then publishing is disabled.
*/
- // tag::refguide[]
AS_CONFIGURED,
- // end::refguide[]
/**
* Do publish data triggered by interaction with this object.
*/
- // tag::refguide[]
ENABLED,
- // end::refguide[]
/**
* Do <b>not</b> publish data triggered by interaction with this object
* (even if otherwise configured to enable publishing).
*/
- // tag::refguide[]
DISABLED,
- // end::refguide[]
/**
* Ignore the value provided by this annotation (meaning that the framework will keep searching, in meta
* annotations or super-classes/interfaces).
*/
- // tag::refguide[]
NOT_SPECIFIED
}
-// end::refguide[]
diff --git a/api/applib/src/main/java/org/apache/isis/applib/annotation/Redirect.java b/api/applib/src/main/java/org/apache/isis/applib/annotation/Redirect.java
index 9674630..25df719 100644
--- a/api/applib/src/main/java/org/apache/isis/applib/annotation/Redirect.java
+++ b/api/applib/src/main/java/org/apache/isis/applib/annotation/Redirect.java
@@ -25,24 +25,18 @@ import javax.xml.bind.annotation.XmlType;
* (in other words, an action that returns "this").
* @since 1.x {@index}
*/
-// tag::refguide[]
@XmlType(
namespace = "http://isis.apache.org/applib/layout/component"
)
public enum Redirect {
- // end::refguide[]
/**
* As defined by configuration property <code>isis.viewer.wicket.redirectEvenIfSameObject</code>
*/
- // tag::refguide[]
AS_CONFIGURED,
- // end::refguide[]
/**
* Redirect (meaning render a new page) even if the result of the action is the same as the target.
*/
- // tag::refguide[]
EVEN_IF_SAME,
- // end::refguide[]
/**
* Don't redirect if the result is the same as the target, instead just update the existing page.
*
@@ -50,7 +44,5 @@ public enum Redirect {
* Of course, a redirect is still performed if the result of the action is different from the target.
* </p>
*/
- // tag::refguide[]
ONLY_IF_DIFFERS,
}
-// end::refguide[]
diff --git a/api/applib/src/main/java/org/apache/isis/applib/annotation/RenderDay.java b/api/applib/src/main/java/org/apache/isis/applib/annotation/RenderDay.java
index 9fc7713..82f2e72 100644
--- a/api/applib/src/main/java/org/apache/isis/applib/annotation/RenderDay.java
+++ b/api/applib/src/main/java/org/apache/isis/applib/annotation/RenderDay.java
@@ -24,7 +24,6 @@ import javax.xml.bind.annotation.XmlType;
* How to render days.
* @since 1.x {@index}
*/
-// tag::refguide[]
@XmlType(
namespace = "http://isis.apache.org/applib/layout/component"
)
@@ -32,20 +31,15 @@ public enum RenderDay {
AS_DAY,
- // end::refguide[]
/**
* Equivalent to <tt>@PropertyLayout(renderAsDayBefore=true)</tt> prior to Isis 2.x
*/
- // tag::refguide[]
AS_DAY_BEFORE,
- // end::refguide[]
/**
* Ignore the value provided by this annotation (meaning that the framework will keep searching, in meta
* annotations or superclasses/interfaces).
*/
- // tag::refguide[]
NOT_SPECIFIED
}
-// end::refguide[]
diff --git a/api/applib/src/main/java/org/apache/isis/applib/annotation/Repainting.java b/api/applib/src/main/java/org/apache/isis/applib/annotation/Repainting.java
index 14d731c..992c514 100644
--- a/api/applib/src/main/java/org/apache/isis/applib/annotation/Repainting.java
+++ b/api/applib/src/main/java/org/apache/isis/applib/annotation/Repainting.java
@@ -24,7 +24,6 @@ import javax.xml.bind.annotation.XmlType;
* Whether a component is unchanging and so does not require repainting.
* @since 1.x {@index}
*/
-// tag::refguide[]
@XmlType(
namespace = "http://isis.apache.org/applib/layout/component"
)
@@ -32,20 +31,15 @@ public enum Repainting {
REPAINT,
- // end::refguide[]
/**
* Equivalent to <tt>@PropertyLayout(unchanging=true)</tt> prior to Isis 2.x
*/
- // tag::refguide[]
NO_REPAINT,
- // end::refguide[]
/**
* Ignore the value provided by this annotation (meaning that the framework will keep searching, in meta
* annotations or superclasses/interfaces).
*/
- // tag::refguide[]
NOT_SPECIFIED
}
-// end::refguide[]
diff --git a/api/applib/src/main/java/org/apache/isis/applib/annotation/RestrictTo.java b/api/applib/src/main/java/org/apache/isis/applib/annotation/RestrictTo.java
index 0b976a6..156b09b 100644
--- a/api/applib/src/main/java/org/apache/isis/applib/annotation/RestrictTo.java
+++ b/api/applib/src/main/java/org/apache/isis/applib/annotation/RestrictTo.java
@@ -22,7 +22,6 @@ package org.apache.isis.applib.annotation;
* Whether an action is restricted to development mode, or available in all.
* @since 1.x {@index}
*/
-// tag::refguide[]
public enum RestrictTo {
PROTOTYPING,
@@ -32,4 +31,3 @@ public enum RestrictTo {
NOT_SPECIFIED;
}
-// end::refguide[]
diff --git a/api/applib/src/main/java/org/apache/isis/applib/annotation/SemanticsOf.java b/api/applib/src/main/java/org/apache/isis/applib/annotation/SemanticsOf.java
index 34f2321..126bf00 100644
--- a/api/applib/src/main/java/org/apache/isis/applib/annotation/SemanticsOf.java
+++ b/api/applib/src/main/java/org/apache/isis/applib/annotation/SemanticsOf.java
@@ -24,10 +24,8 @@ import org.apache.isis.applib.util.Enums;
* @since 1.x {@index}
* @see <a href="https://isis.apache.org/guides/rgant/rgant.html#_rgant-Action_semantics">Reference Guide</a>
*/
-// tag::refguide[]
public enum SemanticsOf {
- // end::refguide[]
/**
* Safe, with no side effects, and caching the returned value when invoked multiple times in the same request.
* <ul>
@@ -37,10 +35,8 @@ public enum SemanticsOf {
* (within a given request scope).</li>
* </ul>
*/
- // tag::refguide[]
SAFE_AND_REQUEST_CACHEABLE,
- // end::refguide[]
/**
* Safe, with no side-effects. In other words, a query-only action.
* <ul>
@@ -50,10 +46,8 @@ public enum SemanticsOf {
* (within a given request scope).</li>
* </ul>
*/
- // tag::refguide[]
SAFE,
- // end::refguide[]
/**
* Post-conditions are always the same, irrespective as to how many times called.
* <ul>
@@ -63,10 +57,8 @@ public enum SemanticsOf {
* (eg sets a property or adds of same item to a Set).</li>
* </ul>
*/
- // tag::refguide[]
IDEMPOTENT,
- // end::refguide[]
/**
* Neither safe nor idempotent; every invocation is likely to change the state of the object.
* <ul>
@@ -77,10 +69,8 @@ public enum SemanticsOf {
* <li>Example: Increasing the quantity of a line item in an Order by 1.</li>
* </ul>
*/
- // tag::refguide[]
NON_IDEMPOTENT,
- // end::refguide[]
/**
* Post-conditions are always the same, irrespective as to how many times called.
* <p>
@@ -92,10 +82,8 @@ public enum SemanticsOf {
* (eg sets a property or adds of same item to a Set).</li>
* </ul>
*/
- // tag::refguide[]
IDEMPOTENT_ARE_YOU_SURE,
- // end::refguide[]
/**
* Neither safe nor idempotent; every invocation is likely to change the state of the object.
* <p>
@@ -107,18 +95,14 @@ public enum SemanticsOf {
* (eg increments a counter or adds to a List).</li>
* <li>Example: Increasing the quantity of a line item in an Order by 1.</li>
*/
- // tag::refguide[]
NON_IDEMPOTENT_ARE_YOU_SURE,
- // end::refguide[]
/**
* Ignore the value provided by this annotation (meaning that the framework will keep searching, in meta
* annotations or superclasses/interfaces).
*/
- // tag::refguide[]
NOT_SPECIFIED
- // end::refguide[]
;
public String getFriendlyName() {
@@ -159,7 +143,5 @@ public enum SemanticsOf {
return this == IDEMPOTENT_ARE_YOU_SURE || this == NON_IDEMPOTENT_ARE_YOU_SURE;
}
- // tag::refguide[]
}
-// end::refguide[]
diff --git a/api/applib/src/main/java/org/apache/isis/applib/annotation/Title.java b/api/applib/src/main/java/org/apache/isis/applib/annotation/Title.java
index 1bf90a7..9851e9c 100644
--- a/api/applib/src/main/java/org/apache/isis/applib/annotation/Title.java
+++ b/api/applib/src/main/java/org/apache/isis/applib/annotation/Title.java
@@ -29,7 +29,6 @@ import java.lang.annotation.Target;
* domain object instance. It is used as a marker.
* @since 1.x {@index}
*/
-// tag::refguide[]
@Retention(RetentionPolicy.RUNTIME)
@Target({
ElementType.METHOD,
@@ -37,36 +36,27 @@ import java.lang.annotation.Target;
})
public @interface Title {
- // end::refguide[]
/**
* The order (in Dewey decimal notation) that the property annotated with
* {@link Title} appears with respect to other properties also annotated
* with {@link Title}.
*/
- // tag::refguide[]
String sequence() default "1.0";
- // end::refguide[]
/**
* The string to use to separate this property from any preceding properties
* in the title.
*/
- // tag::refguide[]
String prepend() default " ";
- // end::refguide[]
/**
* The string to append to this property if non-empty.
*/
- // tag::refguide[]
String append() default "";
- // end::refguide[]
/**
* The length to abbreviate this title element to.
*/
- // tag::refguide[]
int abbreviatedTo() default Integer.MAX_VALUE;
}
-// end::refguide[]
diff --git a/api/applib/src/main/java/org/apache/isis/applib/annotation/Value.java b/api/applib/src/main/java/org/apache/isis/applib/annotation/Value.java
index 904a43a..fa423a6 100644
--- a/api/applib/src/main/java/org/apache/isis/applib/annotation/Value.java
+++ b/api/applib/src/main/java/org/apache/isis/applib/annotation/Value.java
@@ -55,13 +55,11 @@ import org.apache.isis.applib.adapters.ValueSemanticsProvider;
* Note: This annotation is only incompletely recognized by the framework, and may be deprecated in the future.
* </p>
*/
-// tag::refguide[]
@Inherited
@Target({ ElementType.TYPE })
@Retention(RetentionPolicy.RUNTIME)
public @interface Value {
- // end::refguide[]
/**
* The fully qualified name of a class that implements the
* {@link ValueSemanticsProvider} interface.
@@ -85,10 +83,8 @@ public @interface Value {
* Implementation note: the default value provided here is simply an empty
* string because <tt>null</tt> is not a valid default.
*/
- // tag::refguide[]
String semanticsProviderName() default "";
- // end::refguide[]
/**
* As per {@link #semanticsProviderName()}, but specifying a class literal
* rather than a fully qualified class name.
@@ -97,8 +93,6 @@ public @interface Value {
* Implementation note: the default value provided here is simply the
* {@link Value}'s own class, because <tt>null</tt> is not a valid default.
*/
- // tag::refguide[]
Class<?> semanticsProviderClass() default Value.class;
}
-// end::refguide[]
diff --git a/api/applib/src/main/java/org/apache/isis/applib/annotation/Where.java b/api/applib/src/main/java/org/apache/isis/applib/annotation/Where.java
index d834eb7..cd0573c 100644
--- a/api/applib/src/main/java/org/apache/isis/applib/annotation/Where.java
+++ b/api/applib/src/main/java/org/apache/isis/applib/annotation/Where.java
@@ -41,63 +41,51 @@ import org.apache.isis.applib.util.Enums;
* the framework developer should only use those values that represent concrete locations.
* @since 1.x {@index}
*/
-// tag::refguide[]
@XmlType(
namespace = "http://isis.apache.org/applib/layout/component"
)
public enum Where {
- // end::refguide[]
/**
* The member should be disabled/hidden everywhere.
*
* <p>
* Synonym for {@link #ANYWHERE}.
*/
- // tag::refguide[]
EVERYWHERE {
- // end::refguide[]
@Override
public boolean includes(Where context) {
return true;
}
- // tag::refguide[]
// ...
},
- // end::refguide[]
/**
* The member should be disabled/hidden everywhere.
*
* <p>
* Synonym for {@link #EVERYWHERE}.
*/
- // tag::refguide[]
ANYWHERE {
- // end::refguide[]
@Override
public boolean includes(Where context) {
return true;
}
- // tag::refguide[]
// ...
},
- // end::refguide[]
/**
* The member should be disabled/hidden when displayed within an object form.
*
* <p>
* For most viewers, this applies to property and collection members, not actions.
*/
- // tag::refguide[]
OBJECT_FORMS,
- // end::refguide[]
/**
* The member should be disabled/hidden when displayed as a column of a table
* within parent object's collection, and references that parent.
@@ -105,10 +93,8 @@ public enum Where {
* <p>
* For most (all?) viewers, this will have meaning only if applied to a property member.
*/
- // tag::refguide[]
REFERENCES_PARENT,
- // end::refguide[]
/**
* The member should be disabled/hidden when displayed as a column of a table within
* a parent object's collection.
@@ -116,10 +102,8 @@ public enum Where {
* <p>
* For most (all?) viewers, this will have meaning only if applied to a property member.
*/
- // tag::refguide[]
PARENTED_TABLES ,
- // end::refguide[]
/**
* The member should be disabled/hidden when displayed as a column of a table showing a standalone list
* of objects, for example as returned by a repository query.
@@ -127,10 +111,8 @@ public enum Where {
* <p>
* For most (all?) viewers, this will have meaning only if applied to a property member.
*/
- // tag::refguide[]
STANDALONE_TABLES,
- // end::refguide[]
/**
* The member should be disabled/hidden when displayed as a column of a table, either an object's
* collection or a standalone list.
@@ -138,40 +120,32 @@ public enum Where {
* <p>
* This combines {@link #PARENTED_TABLES} and {@link #STANDALONE_TABLES}.
*/
- // tag::refguide[]
ALL_TABLES {
- // end::refguide[]
@Override
public boolean includes(Where context) {
return context == this || context == PARENTED_TABLES || context == STANDALONE_TABLES;
}
- // tag::refguide[]
// ...
},
- // end::refguide[]
/**
* The member should be disabled/hidden except when displayed as a column of a standalone table.
*
* <p>
* This is the inverse of {@link #STANDALONE_TABLES}.
*/
- // tag::refguide[]
ALL_EXCEPT_STANDALONE_TABLES {
- // end::refguide[]
@Override
public boolean includes(Where context) {
return context != STANDALONE_TABLES;
}
- // tag::refguide[]
// ...
},
- // end::refguide[]
/**
* To act as an override if a member would normally be hidden as a result of some other convention.
*
@@ -179,37 +153,29 @@ public enum Where {
* For example, if a property is annotated with <tt>@Title</tt>, then normally this should be hidden
* from all tables. Additionally annotating with <tt>@Hidden(where=Where.NOWHERE)</tt> overrides this.
*/
- // tag::refguide[]
NOWHERE {
- // end::refguide[]
@Override
public boolean includes(Where context) {
return false;
}
- // tag::refguide[]
// ...
},
- // end::refguide[]
/**
* Acts as the default no-op value for {@link PropertyLayout#hidden()}, {@link CollectionLayout#hidden()} and {@link ActionLayout#hidden()}.
*/
- // tag::refguide[]
NOT_SPECIFIED {
- // end::refguide[]
@Override
public boolean includes(Where context) {
return false;
}
- // tag::refguide[]
// ...
};
- // end::refguide[]
public String getFriendlyName() {
return Enums.getFriendlyNameOf(this);
}
@@ -232,7 +198,5 @@ public enum Where {
return context == this;
}
- // tag::refguide[]
}
-// end::refguide[]
diff --git a/api/applib/src/main/java/org/apache/isis/applib/annotation/package-info.java b/api/applib/src/main/java/org/apache/isis/applib/annotation/package-info.java
index 1b64fdd..6c6509f 100644
--- a/api/applib/src/main/java/org/apache/isis/applib/annotation/package-info.java
+++ b/api/applib/src/main/java/org/apache/isis/applib/annotation/package-info.java
@@ -20,4 +20,4 @@
/**
*
*/
-package org.apache.isis.applib.annotation;
\ No newline at end of file
+package org.apache.isis.applib.annotation;
diff --git a/tooling/java2adoc/src/test/java/org/apache/isis/tooling/j2adoc/test/J2AdocTest.java b/tooling/java2adoc/src/test/java/org/apache/isis/tooling/j2adoc/test/J2AdocTest.java
index f7d73e5..ebc1910 100644
--- a/tooling/java2adoc/src/test/java/org/apache/isis/tooling/j2adoc/test/J2AdocTest.java
+++ b/tooling/java2adoc/src/test/java/org/apache/isis/tooling/j2adoc/test/J2AdocTest.java
@@ -110,7 +110,7 @@ class J2AdocTest {
analyzerConfig.getSources(JAVA)
.stream()
.peek(source->System.out.println("parsing source: " + source))
- .filter(source->source.toString().contains("\\applib\\services\\"))
+ .filter(source->source.toString().contains("\\applib\\annotation\\"))
.forEach(AsciiDocIncludeTagFilter::removeAdocExampleTags);
}