You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@isis.apache.org by da...@apache.org on 2018/08/21 19:55:56 UTC
[isis] 03/04: ISIS-1810: tidies up formatting of migration notes
This is an automated email from the ASF dual-hosted git repository.
danhaywood pushed a commit to branch maint-2.0.0-M1
in repository https://gitbox.apache.org/repos/asf/isis.git
commit 7de9a4f888355cfb3444ea4467698e272b40176e
Author: danhaywood <da...@haywood-associates.co.uk>
AuthorDate: Tue Aug 14 00:30:56 2018 +0200
ISIS-1810: tidies up formatting of migration notes
---
...on-notes_1.16.0-to-2.0.0-M1_legacy-modules.adoc | 158 ++++++++++----------
...ion-notes_1.16.0-to-2.0.0-M1_other-changes.adoc | 95 ++++++------
...tes_1.16.0-to-2.0.0-M1_removed-annotations.adoc | 164 ++++++++++-----------
...-2.0.0-M1_removed-configuration-properties.adoc | 10 +-
...ion-notes_1.16.0-to-2.0.0-M1_removed-types.adoc | 10 +-
...n-notes_1.16.0-to-2.0.0-M1_updated-classes.adoc | 32 ++--
6 files changed, 236 insertions(+), 233 deletions(-)
diff --git a/adocs/documentation/src/main/asciidoc/migration-notes/_migration-notes_1.16.0-to-2.0.0-M1_legacy-modules.adoc b/adocs/documentation/src/main/asciidoc/migration-notes/_migration-notes_1.16.0-to-2.0.0-M1_legacy-modules.adoc
index e0083d4..bf17bc7 100644
--- a/adocs/documentation/src/main/asciidoc/migration-notes/_migration-notes_1.16.0-to-2.0.0-M1_legacy-modules.adoc
+++ b/adocs/documentation/src/main/asciidoc/migration-notes/_migration-notes_1.16.0-to-2.0.0-M1_legacy-modules.adoc
@@ -10,6 +10,11 @@ Deprecated types have been moved into new "legacy" modules.
For example, applib types have been moved into `org.apache.isis.core:isis-core-applib-legacy` module.
Generally speaking these types remain in the same package; in some cases they have been renamed.
+[WARNING]
+====
+These modules will be removed for the final release of 2.0.0.
+====
+
== applib-legacy
@@ -19,134 +24,133 @@ Deprecated types have been moved into a new `org.apache.isis.core:isis-core-appl
The most significant type that has been deprecated is the `DomainObjectContainer` type, but there are several others also.
.Legacy types under `org.apache.isis.applib`
-[cols="1l,1l,3", options="header"]
+[cols="3a,3a,3a", options="header"]
|===
| Package
| Type
| Use instead
-|o.a.i.applib
-|DomainObjectContainer
+|`o.a.i.applib`
+|`DomainObjectContainer`
|Use `RepositoryService`, `FactoryService`, `UserService`, `MessageService` instead etc.
-.1+|o.a.i.applib.
-annotation
-|Encodable
+.2+|`o.a.i.applib. +
+annotation`
+|`Encodable`
|No replacement
-|
-|Parseable
+
+|`Parseable`
|No replacement
-.1+|o.a.i.applib.
-fixtures
-|AbstractFixture
+.5+|`o.a.i.applib. +
+fixtures`
+|`AbstractFixture`
|Use `FixtureScript` instead
-|
-|AbstractFixtureSusa
+
+|`AbstractFixtureSusa`
|Use fixture with injected `SudoService`
-|
-|BaseFixture
+
+|`BaseFixture`
|Derive from `FixtureScript`
-|
-|DateFixture
+
+|`DateFixture`
|Use `TickingClockFixture` instead
-|
-|SwitchUserFixture
+
+|`SwitchUserFixture`
|Use fixture with injected `SudoService` instead
-.1+|o.a.i.applib.
+.2+|o.a.i.applib.
switchuser
|SwitchUserService
|`SudoService`
-|
-|SwitchUserServiceAware
+
+|`SwitchUserServiceAware`
|No replacement
-.1+|o.a.i.applib.
-layout.component
-|CollectionLayoutData_legacy
+.2+|`o.a.i.applib. +
+layout.component`
+|`CollectionLayoutData_legacy`
|Renamed from `CollectionLayoutData`, provides trivial utility functions.
No replacement.
-|
-|FieldSetData_legacy
+|`FieldSetData_legacy`
|Renamed from `FieldSet`, provides trivial utility functions.
No replacement.
-|o.a.i.applib.
-services.background
-|BackgroundCommandService2
+.2+|`o.a.i.applib. +
+services.background`
+|`BackgroundCommandService2`
|Use `BackgroundCommandService` instead
-|
-|BackgroundService2
+
+|`BackgroundService2`
|Use `BackgroundService` instead
-|o.a.i.applib.
-services.exceprecog
-|ExceptionRecognizer
-AbstractLegacy
+.2+|`o.a.i.applib. +
+services.exceprecog`
+|`ExceptionRecognizer +
+AbstractLegacy`
|Copy of the 1.16.x version of `ExceptionRecognizerAbstract`, with the original dependency on guava.
Refactor to use the new `ExceptionRecognizerAbstract` (which uses Java 8 predicates etc. instead)
-|
-|ExceptionRecognizer
-ForTypeLegacy
+
+|`ExceptionRecognizer +
+ForTypeLegacy`
|Copy of the 1.16.x version of `ExceptionRecognizerForType`, but with the original dependency on guava.
Replace with the new `ExceptionRecognizerForType` which uses Java 8 predicates etc.
-|o.a.i.applib.
-services.memento
-|MementoService
+|`o.a.i.applib. +
+services.memento`
+|`MementoService`
|No replacement.
Originally provided as a utility to view models that implemented `ViewModel` interface (as opposed to the newer approaches of annotating with `@ViewModel` or as a JAXB DTO class.
Note that the framework-provided implementation, `MementoServiceDefault`, has been moved out to the corresponding `runtime-legacy` module.
-|o.a.i.applib.
-services.repository
-|RepositoryServiceLegacy
+|`o.a.i.applib. +
+services.repository`
+|`RepositoryServiceLegacy`
|Copy of the 1.16.x version of `RepositoryService`, with the original dependency on guava.
Refactor to use the new `RepositoryService` (which uses Java 8 predicates etc. instead).
Note that the framework-provided implementation, `RepositoryServiceLegacyInternalDefault`, has been moved out to the corresponding `metamodel-legacy` module.
-|o.a.i.applib.
-services.urlencoding
-|UrlEncodingService
-UsingBaseEncoding
-WithSupportForLargeUrlsAbstract
+|`o.a.i.applib. +
+services.urlencoding`
+|`UrlEncodingService +
+UsingBaseEncoding +
+WithSupportForLargeUrlsAbstract`
|The `UrlEncodingServiceWithCompression` (provided as the default implementation by the core framework) can be used in most cases.
-|o.a.i.applib.
-util
-|ObjectContractsLegacy
+|`o.a.i.applib. +
+util`
+|`ObjectContractsLegacy`
|Copy of the 1.16.x version of `ObjectContracts`, which heavily uses reflection.
Use `ObjectContracts` instead.
This provides a new API that does not require reflection and instead encourages a different coding style, but does also still support the old API.
-|o.a.i.applib.
-value
-|Date
-DateTime
+.3+|`o.a.i.applib. +
+value`
+|`Date` +
+`DateTime`
|Use JDK8 `LocalDate`, `LocalDateTime` or Joda `DateTime` or `LocalDate` or `LocalDateTime`
-|
-|Time
+
+|`Time`
|Use JDK8 `LocalTime` or Joda `LocalTime`
-|
-|Timestamp
+
+|`Timestamp`
|Use `java.sql.Timestamp` or JDK8 `DateTime` or Joda `DateTime` instead
|===
@@ -159,31 +163,31 @@ See also `transition-1-2` module, below, for further discussion of background se
== integtestsupport-legacy
.Legacy types under `org.apache.isis.applib`
-[cols="1l,1l,3", options="header"]
+[cols="3a,3a,3a", options="header"]
|===
| Package
| Type
| Use instead
-|o.a.i.core.
-integtestsupport
-|IntegrationTestAbstract
+.3+|`o.a.i.core. +
+integtestsupport`
+|`IntegrationTestAbstract`
|Use `IntegrationTestAbstract3` instead
-|
-|IntegrationTestAbstract2
+
+|`IntegrationTestAbstract2`
|Use `IntegrationTestAbstract3` instead
-|
-|IsisSystemForTest
+
+|`IsisSystemForTest`
|Helper class used only by other classes in this module.
No replacement.
-|o.a.i.core.
-integtestsupport.
-scenarios
-|ScenarioExecutionForIntegration
+|`o.a.i.core. +
+integtestsupport. +
+scenarios`
+|`ScenarioExecutionForIntegration`
|Subclass spec "glue" from `HeadlessWithBootstrappingAbstract` (the common superclass of `IntegrationTestAbstract3`) instead, and inject services into glue.
@@ -192,12 +196,11 @@ scenarios
== unittestupport-legacy
-
-
+TODO
== transition-1-2
-
+TODO
== metamodel-legacy
@@ -222,8 +225,9 @@ Finally, it also contains these framework-provided service implementations:
== runtime-legacy
-
+TODO
== viewer-wicket-ui-legacy
+TODO
diff --git a/adocs/documentation/src/main/asciidoc/migration-notes/_migration-notes_1.16.0-to-2.0.0-M1_other-changes.adoc b/adocs/documentation/src/main/asciidoc/migration-notes/_migration-notes_1.16.0-to-2.0.0-M1_other-changes.adoc
index 20d233b..9d6a0b9 100644
--- a/adocs/documentation/src/main/asciidoc/migration-notes/_migration-notes_1.16.0-to-2.0.0-M1_other-changes.adoc
+++ b/adocs/documentation/src/main/asciidoc/migration-notes/_migration-notes_1.16.0-to-2.0.0-M1_other-changes.adoc
@@ -83,7 +83,7 @@ The plugin architecture uses the JDK `ServiceLoader` API, whereby a Maven module
The plugin interface types themselves are defined in various of the Maven modules, broadly depending on what consumes them.
.Plugin types
-[cols="1l,1l,3a,3a", options="header"]
+[cols="2a,4a,4a,3a", options="header"]
|===
| Defined in
@@ -91,21 +91,20 @@ The plugin interface types themselves are defined in various of the Maven module
| Used for
| Implementations
-|isis-core-commons
-|o.a.i.core.plugins.
-classdiscovery.
-ClassDiscoveryPlugin
+.3+|`isis-core-commons`
+|`o.a.i.core.plugins. +
+classdiscovery. +
+ClassDiscoveryPlugin`
|Obtain a plugin to finding types on the classpath with certain characteristics, eg annotated with certain annotations
-Include only one implementation on classpath,
+Include only one implementation on classpath.
-|`ClassDiscoveryPluginUsingReflections` uses the `org.reflections` open source library
+|`ClassDiscoveryPluginUsingReflections` uses the `org.reflections` open source library (which depends in turn on guava).
-|isis-core-commons
-|o.a.i.core.plugins.
-codegen.
-ProxyFactoryPlugin
+|`o.a.i.core.plugins. +
+codegen. +
+ProxyFactoryPlugin`
|Obtain a plugin acting as a factory to proxy types (as used by the `WrapperFactory` domain service).
Include only one implementation on classpath,
@@ -116,16 +115,16 @@ ProxyFactoryPluginUsingByteBuddy` (using ByteBuddy)
`o.a.i.core.plugins.codegen.
ProxyFactoryPluginUsingJavassist` (using Javassist).
-|isis-core-commons
-|o.a.i.core.plugins.
-eventbus.
-EventBusPlugin
-|Obtain a plugin for finding event bus implementations.
-This removes the need to explicitly specify the implementation using the `isis.services.eventbus.implementation` config property; it can be left as simply "auto".
+|`o.a.i.core.plugins. +
+eventbus. +
+EventBusPlugin`
+|Obtain a plugin for finding event bus implementations.
+
+This removes the need to explicitly specify the implementation using the `isis.services.eventbus.implementation` config property; it can be left as simply "auto".
|`o.a.i.core.plugins.eventbus.
EventBusPluginForAxon` (using Axon Framework)
@@ -134,10 +133,10 @@ EventBusPluginForAxon` (using Axon Framework)
EventBusPluginForGuava` (using Guava)
-|isis-core-metamodel
-|org.apache.isis.core.
-metamodel.progmodel.
-ProgrammingModelPlugin
+.3+|`isis-core-metamodel`
+|`org.apache.isis.core. +
+metamodel.progmodel. +
+ProgrammingModelPlugin`
|Obtain plugins that can provide implementations of Isis' own `FacetFactory` SPI (which is used to build up the metamodel).
There can be multiple implementations on the classpath.
@@ -145,11 +144,10 @@ There can be multiple implementations on the classpath.
|`org.apache.isis.progmodels.
plugins.ProgrammingModelIsisTimePlugin` (in `metamodel-legacy`) contributes facet factories for the applib value types that have been moved to applib-legacy.
-|isis-core-metamodel
-|org.apache.isis.core.
-metamodel.services.
-swagger.internal.
-ValuePropertyPlugin
+|`org.apache.isis.core. +
+metamodel.services. +
+swagger.internal. +
+ValuePropertyPlugin`
|Obtain plugins that can provide implementations of Isis' own `ValuePropertyFactory` SPI (which is used to build up Swagger representations).
There can be multiple implementations on the classpath.
@@ -159,10 +157,10 @@ services.swagger.plugins.
IsisTimeValuePropertyPlugin` (in `metamodel-legacy`)
contributes factories for the applib value types that have been moved to applib-legacy.
-|isis-core-metamodel
-|o.a.i.core.
-metamodel.
-IsisJdoMetamodelPlugin
+
+|`o.a.i.core. +
+metamodel. +
+IsisJdoMetamodelPlugin`
|Decouples the metamodel module from a particular implementation of DataNucleus.
Include only one implementation on classpath,
@@ -172,10 +170,10 @@ Include only one implementation on classpath,
`o.a.i.plugins.jdo.dn5.IsisJdoSupportPlugin5`
-|isis-core-runtime
-|o.a.i.core.
-metamodel.
-IsisJdoRuntimePlugin
+|`isis-core-runtime`
+|`o.a.i.core. +
+metamodel. +
+IsisJdoRuntimePlugin`
|Decouples the runtime module from a particular implementation of DataNucleus.
Include only one implementation on classpath,
@@ -185,39 +183,40 @@ Include only one implementation on classpath,
`o.a.i.plugins.jdo.dn5.IsisJdoSupportPlugin5`
-|isis-core-viewer-restfulobjects-applib
-|o.a.i.viewer.
-restfulobjects.
-applib.client.
-UriBuilderPlugin
+|`isis-core-viewer-restfulobjects-applib`
+|`o.a.i.viewer. +
+restfulobjects. +
+applib.client. +
+UriBuilderPlugin`
|Plugin to obtain a `UriBuilder` to create uri templates.
Include only one implementation on classpath,
-|`o.a.i.plugins.
+|`o.a.i.plugins. +
jaxrs.resteasy.IsisResteasy3Plugin`
or
-`o.a.i.plugins.
+`o.a.i.plugins. +
jaxrs.resteasy.IsisResteasy4Plugin`
-|isis-core-viewer-restfulobjects-server
-|o.a.i.viewer.
-restfulobjects.
-server.
-IsisJaxrsServerPlugin
+
+|`isis-core-viewer-restfulobjects-server`
+|`o.a.i.viewer. +
+restfulobjects. +
+server. +
+IsisJaxrsServerPlugin`
|Plugin to configure the JAX-RS runtime.
Include only one implementation on classpath.
-|`o.a.i.plugins.
+|`o.a.i.plugins. +
jaxrs.resteasy.IsisResteasy3Plugin`
or
-`o.a.i.plugins.
+`o.a.i.plugins. +
jaxrs.resteasy.IsisResteasy4Plugin`
diff --git a/adocs/documentation/src/main/asciidoc/migration-notes/_migration-notes_1.16.0-to-2.0.0-M1_removed-annotations.adoc b/adocs/documentation/src/main/asciidoc/migration-notes/_migration-notes_1.16.0-to-2.0.0-M1_removed-annotations.adoc
index 00f2040..93809bf 100644
--- a/adocs/documentation/src/main/asciidoc/migration-notes/_migration-notes_1.16.0-to-2.0.0-M1_removed-annotations.adoc
+++ b/adocs/documentation/src/main/asciidoc/migration-notes/_migration-notes_1.16.0-to-2.0.0-M1_removed-annotations.adoc
@@ -11,194 +11,194 @@
The following annotations, or attributes of annotations, have been removed
.Removed annotations/attributes
-[cols="1l,1l,3a", options="header"]
+[cols="1a,1a,3a", options="header"]
|===
| Annotation
| Attribute
| Use instead
-|@Action
-|publishingPayloadFactory()
+|`@Action`
+|`publishingPayloadFactory()`
|Removed, use the simpler link:https://isis.apache.org/versions/2.0.0-M1/guides/rgsvc/rgsvc.html#PublisherService[PublisherService] SPI instead.
-|@ActionInteraction
+|`@ActionInteraction`
|
|link:https://isis.apache.org/versions/2.0.0-M1/guides/rgant/rgant.html#_rgant_Action_domainEvent[`@Action#domainEvent()`]
-|@ActionOrder
+|`@ActionOrder`
|
|link:https://isis.apache.org/versions/2.0.0-M1/guides/rgant/rgant.html#_rgant_MemberOrder[`@MemberOrder()`]
-|@Aggregated
+|`@Aggregated`
|
|Never implemented internally in Isis 1.x so no replacement.
-|@Auditable
+|`@Auditable`
(JDO applib)
|
|link:https://isis.apache.org/versions/2.0.0-M1/guides/rgant/rgant.html#_rgant_DomainObject_audited[`@DomainObject#auditing()`]
-|@Audited
+|`@Audited`
|
|link:https://isis.apache.org/versions/2.0.0-M1/guides/rgant/rgant.html#_rgant_DomainObject_audited[`@DomainObject#auditing()`]
-|@AutoComplete
+|`@AutoComplete`
|
|link:https://isis.apache.org/versions/2.0.0-M1/guides/rgant/rgant.html#_rgant_DomainObject_autoComplete[`@DomainObject#autoComplete()`]
-|@ActionSemantics
+|`@ActionSemantics`
|
|link:https://isis.apache.org/versions/2.0.0-M1/guides/rgant/rgant.html#_rgant_Action_semantics[`@Action#semantics()`]
-|@Bookmarkable
+|`@Bookmarkable`
|
|link:https://isis.apache.org/versions/2.0.0-M1/guides/rgant/rgant.html#_rgant_DomainObject_bookmarking[`@DomainObject#bookmarking()`]
-|@Bounded
+|`@Bounded`
|
|link:https://isis.apache.org/versions/2.0.0-M1/guides/rgant/rgant.html#_rgant_DomainObject_bounding[`@DomainObject#bounding()`]
-|@Bulk
+|`@Bulk`
|
|link:https://isis.apache.org/versions/2.0.0-M1/guides/rgant/rgant.html#_rgant_Action_invokeOn[`@Action#invokeOn()`]
Similarly, the `Bulk.InteractionContext` domain service is replaced with the link:https://isis.apache.org/versions/2.0.0-M1/guides/rgsvc/rgsvc.html#ActionInvocationContext[ActionInvocationContext] domain service.
-|@Collection
-| notPersisted
+|`@Collection`
+|`notPersisted`
| Removed, replaced with link:https://isis.apache.org/versions/2.0.0-M1/guides/rgant/rgant.html#_rgant_Collection_mementoSerialization[`@Collection#mementoSerialization()`]
-|@CollectionInteraction
+|`@CollectionInteraction`
|
| link:https://isis.apache.org/versions/2.0.0-M1/guides/rgant/rgant.html#_rgant_Collection_domainEvent[`@Collection
#domainEvent()`]
-|@CollectionLayout
-|render()
+|`@CollectionLayout`
+|`render`
|link:https://isis.apache.org/versions/2.0.0-M1/guides/rgant/rgant.html#_rgant_CollectionLayout_defaultView[`@CollectionLayout#defaultView()`]
-|@Command
+|`@Command`
|
|link:https://isis.apache.org/versions/2.0.0-M1/guides/rgant/rgant.html#_rgant_Action_command[`@Action#command()`]
-|@CssClass
+|`@CssClass`
|
|Either link:https://isis.apache.org/versions/2.0.0-M1/guides/rgant/rgant.html#_rgant_ActionLayout_cssClass[`@ActionLayout#cssClass()`], link:https://isis.apache.org/versions/2.0.0-M1/guides/rgant/rgant.html#_rgant_PropertyLayout_cssClass[`@PropertyLayout#cssClass()`], link:https://isis.apache.org/versions/2.0.0-M1/guides/rgant/rgant.html#_rgant_CollectionLayout_cssClass[`@CollectionLayout#cssClass()`], link:https://isis.apache.org/versions/2.0.0-M1/guides/rgant/rgant.html#_rgant_Paramet [...]
-|@CssClassFa
+|`@CssClassFa`
|
|Either link:https://isis.apache.org/versions/2.0.0-M1/guides/rgant/rgant.html#_rgant_ActionLayout_cssClassFa[`@ActionLayout#cssClassFa()`], link:https://isis.apache.org/versions/2.0.0-M1/guides/rgant/rgant.html#_rgant_DomainObjectLayout_cssClassFa[`@DomainObjectLayout#cssClassFa()`] or link:https://isis.apache.org/versions/2.0.0-M1/guides/rgant/rgant.html#_rgant_ViewModelLayout_cssClassFa[`@ViewModelLayout#cssClassFa()`].
-|@Debug
+|`@Debug`
|
|link:https://isis.apache.org/versions/2.0.0-M1/guides/rgant/rgant.html#_rgant_Action_restrictTo[`@Action#restrictTo()`]
-|@DescribedAs
+|`@DescribedAs`
|
|Either link:https://isis.apache.org/versions/2.0.0-M1/guides/rgant/rgant.html#_rgant_ActionLayout_describedAs[`@ActionLayout#describedAs()`], link:https://isis.apache.org/versions/2.0.0-M1/guides/rgant/rgant.html#_rgant_PropertyLayout_describedAs[`@PropertyLayout#describedAs()`], link:https://isis.apache.org/versions/2.0.0-M1/guides/rgant/rgant.html#_rgant_CollectionLayout_describedAs[`@CollectionLayout#describedAs()`], link:https://isis.apache.org/versions/2.0.0-M1/guides/rgant/rgant.h [...]
-|@Disabled
+|`@Disabled`
|
|link:https://isis.apache.org/versions/2.0.0-M1/guides/rgant/rgant.html#_rgant_Property_editingDisabledReason[`@Property#editingDisabledReason()`]
-.2+|@DomainObject
-|bounded
+.2+|`@DomainObject`
+|`bounded`
|Deleted (was a boolean attribute), replaced by link:https://isis.apache.org/versions/2.0.0-M1/guides/rgant/rgant.html#_rgant_DomainObject_bounding[`@Property#bounding`]
-|publishingPayloadFactory
+|`publishingPayloadFactory`
|Removed, use the simpler link:https://isis.apache.org/versions/2.0.0-M1/guides/rgsvc/rgsvc.html#PublisherService[PublisherService] SPI instead.
-|@Exploration
+|`@Exploration`
|
|link:https://isis.apache.org/versions/2.0.0-M1/guides/rgant/rgant.html#_rgant_Action_restrictTo[`@Action#restrictTo()`]
-|@FieldOrder
+|`@FieldOrder`
|
|link:https://isis.apache.org/versions/2.0.0-M1/guides/rgant/rgant.html#_rgant_MemberOrder[`@MemberOrder()`]
-|@Hidden
+|`@Hidden`
|
|For actions by either link:https://isis.apache.org/versions/2.0.0-M1/guides/rgant/rgant.html#_rgant_Action_hidden[`@Action#hidden()`] or link:https://isis.apache.org/versions/2.0.0-M1/guides/rgant/rgant.html#_rgant_ActionLayout_hidden[`@ActionLayout#hidden()`], for properties by either link:https://isis.apache.org/versions/2.0.0-M1/guides/rgant/rgant.html#_rgant_Property_hidden[`@Property#hidden()`] or link:https://isis.apache.org/versions/2.0.0-M1/guides/rgant/rgant.html#_rgant_Propert [...]
-|@Idempotent
+|`@Idempotent`
|
|link:https://isis.apache.org/versions/2.0.0-M1/guides/rgant/rgant.html#_rgant_Action_semantics[`@Action#semantics()`]
-|@Ignore
+|`@Ignore`
|
|link:https://isis.apache.org/versions/2.0.0-M1/guides/rgant/rgant.html#_rgant_Programmatic[`@Programmatic`]
-|@Immutable
+|`@Immutable`
|
|link:https://isis.apache.org/versions/2.0.0-M1/guides/rgant/rgant.html#_rgant_DomainObject_editing[`@DomainObject#editing()`]
-|@Mandatory
+|`@Mandatory`
|
|Either link:https://isis.apache.org/versions/2.0.0-M1/guides/rgant/rgant.html#_rgant_Property_optionality[`@Property#optionality()`] or link:https://isis.apache.org/versions/2.0.0-M1/guides/rgant/rgant.html#_rgant_Parameter_optionality[`@Parameter#optionality()`].
For properties, can also use link:https://isis.apache.org/versions/2.0.0-M1/guides/rgant/rgant.html#_rgant_Column_allowsNull[`@Column#allowsNull()`]
Can also use link:https://isis.apache.org/versions/2.0.0-M1/guides/rgant/rgant.html#_rgant_Nullable[`@Nullable`] for either properties or parameters.
-|@Mask
+|`@Mask`
|
|Removed, never implemented internally in Isis 1.x so no replacement.
-|@MaxLength
+|`@MaxLength`
|
|Either link:https://isis.apache.org/versions/2.0.0-M1/guides/rgant/rgant.html#_rgant_Property_maxLength[`@Property#maxLength()`] or link:https://isis.apache.org/versions/2.0.0-M1/guides/rgant/rgant.html#_rgant_Parameter_maxLength[`@Parameter#maxLength()`].
For properties, can also use link:https://isis.apache.org/versions/2.0.0-M1/guides/rgant/rgant.html#_rgant_Column_length[`@Column#length()`]
-|@MemberGroups
+|`@MemberGroups`
|
|link:https://isis.apache.org/versions/2.0.0-M1/guides/ugvw/ugvw.html#_ugvw_layout_file-based[.layout.xml] file instead.
-|@MultiLine
+|`@MultiLine`
|
|Either link:https://isis.apache.org/versions/2.0.0-M1/guides/rgant/rgant.html#_rgant_PropertyLayout_multiLine[`@PropertyLayout#multiLine()`] or link:https://isis.apache.org/versions/2.0.0-M1/guides/rgant/rgant.html#_rgant_ParameterLayout_multiLine[`@ParameterLayout#multiLine()`].
-|@MustSatisfy
+|`@MustSatisfy`
|
|Either link:https://isis.apache.org/versions/2.0.0-M1/guides/rgant/rgant.html#_rgant_Property_mustSatisfy[`@Property#mustSatisfy()`] or link:https://isis.apache.org/versions/2.0.0-M1/guides/rgant/rgant.html#_rgant_Parameter_mustSatisfy[`@Parameter#mustSatisfy()`].
-|@NotPersisted
+|`@NotPersisted`
|
|link:https://isis.apache.org/versions/2.0.0-M1/guides/rgant/rgant.html#_rgant_Property_notPersisted[`@Property#notPersisted()`].
-|@Optional
+|`@Optional`
|
|Either link:https://isis.apache.org/versions/2.0.0-M1/guides/rgant/rgant.html#_rgant_Property_optionality[`@Property#optionality()`] or link:https://isis.apache.org/versions/2.0.0-M1/guides/rgant/rgant.html#_rgant_Parameter_optionality[`@Parameter#optionality()`].
For properties, can also use link:https://isis.apache.org/versions/2.0.0-M1/guides/rgant/rgant.html#_rgant_Column_allowsNull[`@Column#allowsNull()`]
Can also use link:https://isis.apache.org/versions/2.0.0-M1/guides/rgant/rgant.html#_rgant_Nullable[`@Nullable`] for either properties or parameters.
-|@Named
+|`@Named`
|
|Either link:https://isis.apache.org/versions/2.0.0-M1/guides/rgant/rgant.html#_rgant_ActionLayout_named[`@ActionLayout#named()`], link:https://isis.apache.org/versions/2.0.0-M1/guides/rgant/rgant.html#_rgant_PropertyLayout_named[`@PropertyLayout#named()`], link:https://isis.apache.org/versions/2.0.0-M1/guides/rgant/rgant.html#_rgant_CollectionLayout_named[`@CollectionLayout#named()`], link:https://isis.apache.org/versions/2.0.0-M1/guides/rgant/rgant.html#_rgant_ParameterLayout_named[`@P [...]
-|@NotInServiceMenu
+|`@NotInServiceMenu`
|
|link:https://isis.apache.org/versions/2.0.0-M1/guides/rgant/rgant.html#_rgant_DomainService_nature[`@DomainService#nature()`]
Specify nature of `VIEW_CONTRIBUTIONS_ONLY`.
Alternatively, use a link:https://isis.apache.org/versions/2.0.0-M1/guides/rgant/rgant.html#_rgant_Mixin[mixin].
-|@NotContributed
+|`@NotContributed`
|
|link:https://isis.apache.org/versions/2.0.0-M1/guides/rgant/rgant.html#_rgant_DomainService_nature[`@DomainService#nature()`]
Specify nature of `VIEW_MENU_ONLY`.
-|@NotPersistable
+|`@NotPersistable`
|
|Never implemented internally in Isis 1.x so no replacement.
-|@ObjectType
+|`@ObjectType`
|
|Removed, link:https://isis.apache.org/versions/2.0.0-M1/guides/rgant/rgant.html#_rgant_DomainObject_objectType[`@DomainObject#objectType()`] or link:https://isis.apache.org/versions/2.0.0-M1/guides/rgant/rgant.html#_rgant_DomainService_objectType[`@DomainService#objectType()`]
@@ -207,116 +207,116 @@ Alternatively, for domain entities either:
* the link:https://isis.apache.org/versions/2.0.0-M1/guides/rgant/rgant.html#_rgant_Discriminator[`@Discriminator`] annotation can be specified; the value is used as the object type, or
* the link:https://isis.apache.org/versions/2.0.0-M1/guides/rgant/rgant.html#_rgant_PersistenceCapable_schema[`@PersistenceCapable#schema()`] can be specified; the value is used as the concatenated with the class name to create a two part object type.
-|@Parameter
-|minLength()
+|`@Parameter`
+|`minLength`
|Never implemented internally in Isis 1.x so no replacement.
Note that the link:https://isis.apache.org/versions/2.0.0-M1/guides/rgant/rgant.html#_rgant_MinLength[`@MinLength`] annotation is for use with autocomplete supporting methods (specifying the minimum number of characters to enter before an auto-complete search is performed).
-|@Paged
+|`@Paged`
|
|Either link:https://isis.apache.org/versions/2.0.0-M1/guides/rgant/rgant.html#_rgant_CollectionLayout_paged[`@CollectionLayout#paged()`] (for parented collections), or link:https://isis.apache.org/versions/2.0.0-M1/guides/rgant/rgant.html#_rgant_DomainObject_paged[`@DomainObject#paged()`] (for standalone collections)
-|@ParameterLayout
+|`@ParameterLayout`
| renderedAsDayBefore
|Deleted (was a boolean attribute), replaced by link:https://isis.apache.org/versions/2.0.0-M1/guides/rgant/rgant.html#_rgant_ParameterLayout_renderDay[`@ParameterLayout#renderDay`].
-|@Plural
+|`@Plural`
|
|link:https://isis.apache.org/versions/2.0.0-M1/guides/rgant/rgant.html#_rgant_DomainObjectLayout_plural[`@DomainObjectLayout#plural()`]
-|@PostsAction
-InvokedEvent
+|`@PostsAction +
+InvokedEvent`
|
| link:https://isis.apache.org/versions/2.0.0-M1/guides/rgant/rgant.html#_rgant_Action_domainEvent[`@Action#domainEvent()`]
-|@PostsCollection
-AddedToEvent
+|`@PostsCollection +
+AddedToEvent`
|
|link:https://isis.apache.org/versions/2.0.0-M1/guides/rgant/rgant.html#_rgant_Collection_domainEvent[`@Collection#domainEvent()`]
-|@PostsCollection
-RemovedFromEvent
+|`@PostsCollection +
+RemovedFromEvent`
|
|link:https://isis.apache.org/versions/2.0.0-M1/guides/rgant/rgant.html#_rgant_Collection_domainEvent[`@Collection#domainEvent()`]
-|@PostsProperty
-ChangedEvent
+|`@PostsProperty +
+ChangedEvent`
|
| link:https://isis.apache.org/versions/2.0.0-M1/guides/rgant/rgant.html#_rgant_Property_domainEvent[`@Property#domainEvent()`]
-|@Property
-| notPersisted
+|`@Property`
+|`notPersisted`
| Removed, replaced with link:https://isis.apache.org/versions/2.0.0-M1/guides/rgant/rgant.html#_rgant_Collection_mementoSerialization[`@Collection#mementoSerialization()`]
-|@PropertyInteraction
+|`@PropertyInteraction`
|
| link:https://isis.apache.org/versions/2.0.0-M1/guides/rgant/rgant.html#_rgant_Property_domainEvent[`@Property#domainEvent()`]
-.2+|@PropertyLayout
-| renderedAsDayBefore
+.2+|`@PropertyLayout`
+|`renderedAsDayBefore`
|Deleted (was a boolean attribute), replaced by link:https://isis.apache.org/versions/2.0.0-M1/guides/rgant/rgant.html#_rgant_PropertyLayout_renderDay[`@PropertyLayout#renderDay`].
-| unchanging
-| Deleted (was a boolean attribute), replaced by by link:https://isis.apache.org/versions/2.0.0-M1/guides/rgant/rgant.html#_rgant_PropertyLayout_repainting[`@PropertyLayout#repainting`].
+|`unchanging`
+|Deleted (was a boolean attribute), replaced by link:https://isis.apache.org/versions/2.0.0-M1/guides/rgant/rgant.html#_rgant_PropertyLayout_repainting[`@PropertyLayout#repainting`].
-|@Prototype
+|`@Prototype`
|
|link:https://isis.apache.org/versions/2.0.0-M1/guides/rgant/rgant.html#_rgant_Action_restrictTo[`@Action#restrictTo()`]
-|@PublishedAction
+|`@PublishedAction`
|
|Removed, use link:https://isis.apache.org/versions/2.0.0-M1/guides/rgant/rgant.html#_rgant-Action_publishing[@Action#publishing()]
-|@PublishedObject
+|`@PublishedObject`
|
|Removed, use link:https://isis.apache.org/versions/2.0.0-M1/guides/rgant/rgant.html#_rgant-DomainObject_publishing[@DomainObject#publishing()]
-|@PublishingPayload
-FactoryForAction
+|`@PublishingPayload
+FactoryForAction`
|
|Removed, use the simpler link:https://isis.apache.org/versions/2.0.0-M1/guides/rgsvc/rgsvc.html#PublisherService[PublisherService] SPI instead.
-|PublishingPayload
-FactoryForObject
+|`PublishingPayload
+FactoryForObject`
|
|Removed, use the simpler link:https://isis.apache.org/versions/2.0.0-M1/guides/rgsvc/rgsvc.html#PublisherService[PublisherService] SPI instead.
-|@QueryOnly
+|`@QueryOnly`
|
|link:https://isis.apache.org/versions/2.0.0-M1/guides/rgant/rgant.html#_rgant_Action_semantics[`@Action#semantics()`]
-|@Regex
+|`@Regex`
|
|Either link:https://isis.apache.org/versions/2.0.0-M1/guides/rgant/rgant.html#_rgant_Property_regexPattern[`@Property#regexPattern()`] or link:https://isis.apache.org/versions/2.0.0-M1/guides/rgant/rgant.html#_rgant_Parameter_regexPattern[`@Parameter#regexPattern()`].
-|@Render
+|`@Render`
|
|link:https://isis.apache.org/versions/2.0.0-M1/guides/rgant/rgant.html#_rgant_CollectionLayout_defaultView[`@CollectionLayout#defaultView()`]
Supporting `RenderType` enum also removed.
-|@RenderedAs
-DayBefore
+|`@RenderedAs +
+DayBefore`
|
|Either link:https://isis.apache.org/versions/2.0.0-M1/guides/rgant/rgant.html#_rgant_Property_renderDay[`@Property#renderDay()`] or link:https://isis.apache.org/versions/2.0.0-M1/guides/rgant/rgant.html#_rgant_Parameter_renderDay[`@Parameter#renderDay()`].
-|@Resolve
+|`@Resolve`
|
|link:https://isis.apache.org/versions/2.0.0-M1/guides/rgant/rgant.html#_rgant_CollectionLayout_defaultView[`@CollectionLayout#defaultView()`]
-|@SortedBy
+|`@SortedBy`
|
|link:https://isis.apache.org/versions/2.0.0-M1/guides/rgant/rgant.html#_rgant_CollectionLayout_sortedBy[`@CollectionLayout#sortedBy()`]
-|@TypeOf
+|`@TypeOf`
|
|Either link:https://isis.apache.org/versions/2.0.0-M1/guides/rgant/rgant.html#_rgant_CollectionLayout_typeOf[`@CollectionLayout#typeOf()`] (for parented collections), or link:https://isis.apache.org/versions/2.0.0-M1/guides/rgant/rgant.html#_rgant_ActionLayout_typeOf[`@ActionLayout#typeOf()`] (for actions returning a standalone collection).
-|@TypicalLength
+|`@TypicalLength`
|
|link:https://isis.apache.org/versions/2.0.0-M1/guides/rgant/rgant.html#_rgant_PropertyLayout_typicalLength[`@PropertyLayout#typicalLength()`].
diff --git a/adocs/documentation/src/main/asciidoc/migration-notes/_migration-notes_1.16.0-to-2.0.0-M1_removed-configuration-properties.adoc b/adocs/documentation/src/main/asciidoc/migration-notes/_migration-notes_1.16.0-to-2.0.0-M1_removed-configuration-properties.adoc
index 9da2185..9f4cede 100644
--- a/adocs/documentation/src/main/asciidoc/migration-notes/_migration-notes_1.16.0-to-2.0.0-M1_removed-configuration-properties.adoc
+++ b/adocs/documentation/src/main/asciidoc/migration-notes/_migration-notes_1.16.0-to-2.0.0-M1_removed-configuration-properties.adoc
@@ -11,16 +11,16 @@ The following configuration properties are no longer recognised.
.Removed configuration properties
-[cols="2l,4a", options="header"]
+[cols="3a,3a", options="header"]
|===
| Configuration property
| Description
-|isis.persistor.
-datanucleus.
-PublishingService.
-serializedForm
+|`isis.persistor. +
+datanucleus. +
+PublishingService. +
+serializedForm`
|`PublishingService` has been removed.
Use link:https://isis.apache.org/versions/2.0.0-M1/guides/rgsvc/rgsvc.html#_rgsvc_persistence-layer-spi_PublisherService[`PublisherService`] instead.
diff --git a/adocs/documentation/src/main/asciidoc/migration-notes/_migration-notes_1.16.0-to-2.0.0-M1_removed-types.adoc b/adocs/documentation/src/main/asciidoc/migration-notes/_migration-notes_1.16.0-to-2.0.0-M1_removed-types.adoc
index e210a28..3817e74 100644
--- a/adocs/documentation/src/main/asciidoc/migration-notes/_migration-notes_1.16.0-to-2.0.0-M1_removed-types.adoc
+++ b/adocs/documentation/src/main/asciidoc/migration-notes/_migration-notes_1.16.0-to-2.0.0-M1_removed-types.adoc
@@ -11,22 +11,22 @@
The following adapter classes have been removed.
.Removed adapter classes
-[cols="1l,3a", options="header"]
+[cols=3a,3a", options="header"]
|===
| Removed class
| Replaced with
-|AbstractContainedObject
+|`AbstractContainedObject`
| No replacement.
-|AbstractDomainObject
+|`AbstractDomainObject`
| No replacement.
-|AbstractFactoryAndRepository
+|`AbstractFactoryAndRepository`
| No replacement.
-|AbstractHomePageDashboardService
+|`AbstractHomePageDashboardService`
| No replacement.
|===
diff --git a/adocs/documentation/src/main/asciidoc/migration-notes/_migration-notes_1.16.0-to-2.0.0-M1_updated-classes.adoc b/adocs/documentation/src/main/asciidoc/migration-notes/_migration-notes_1.16.0-to-2.0.0-M1_updated-classes.adoc
index 2676193..761fbec 100644
--- a/adocs/documentation/src/main/asciidoc/migration-notes/_migration-notes_1.16.0-to-2.0.0-M1_updated-classes.adoc
+++ b/adocs/documentation/src/main/asciidoc/migration-notes/_migration-notes_1.16.0-to-2.0.0-M1_updated-classes.adoc
@@ -10,54 +10,54 @@
The following classes have been updated.
.Updated classes
-[cols="2l,2a,3a", options="header"]
+[cols="3a,3a,3a", options="header"]
|===
| Updated class
| Method
| Nature of change
-|IsisAppModule.
-ActionDomainEvent
+|`IsisAppModule. +
+ActionDomainEvent`
|N-arg constructor
|removed; just use the 0-arg ones
-|IsisAppModule.
-CollectionDomainEvent
+|`IsisAppModule. +
+CollectionDomainEvent`
|N-arg constructor
|removed; just use the 0-arg ones
-|IsisAppModule.
-PropertyDomainEvent
+|`IsisAppModule. +
+PropertyDomainEvent`
|N-arg constructor
|removed; just use the 0-arg ones
-|FixtureScript
+|`FixtureScript`
|`asKeyValueMap(String)`
|Removed; this shouldn't have had public visibility.
-|FixtureScript
+|`FixtureScript`
|`execute(...)`
`executeChild(...)`
`executeIfNotAlready(...)`
`run(...)`
-|All removed or no longer public; use `FixtureScript.ExecutionContext#executeChild(...)` instead.
+|All removed or no longer public; use ``FixtureScript.ExecutionContext``'s `#executeChild(...)` instead.
-|FixtureScript
+|`FixtureScript`
|`lookup(...)`
|Removed; use `FixtureScript.ExecutionContext#lookup(...)` instead.
-|FixtureScript.
-ExecutionContext
+|`FixtureScript. +
+ExecutionContext`
|`add(...)`
|Removed; use `addResult(...)` instead.
-|FixtureScripts
+|`FixtureScripts`
|deprecated constructors
|Removed
-|FixtureScripts.
-MultipleExecutionStrategy
+|`FixtureScripts. +
+MultipleExecutionStrategy`
|`IGNORE`
|Removed, use `EXECUTE_ONCE_PER_CLASS` instead