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 2021/06/10 13:38:28 UTC
[isis] 02/04: ISIS-2442: improves base subdomain docs a little more
This is an automated email from the ASF dual-hosted git repository.
danhaywood pushed a commit to branch ISIS-2442
in repository https://gitbox.apache.org/repos/asf/isis.git
commit 58ab1994bff81869be28822b20747d2a1423a7db
Author: danhaywood <da...@haywood-associates.co.uk>
AuthorDate: Thu Jun 10 11:24:42 2021 +0100
ISIS-2442: improves base subdomain docs a little more
---
.../applib/services/calendar/CalendarService.adoc | 46 +++++++++++++---------
.../types/{NameType.adoc => Description.adoc} | 10 +++--
.../types/{DescriptionType.adoc => Fqcn.adoc} | 9 +++--
.../applib/types/{FqcnType.adoc => Money.adoc} | 9 +++--
.../base/applib/types/{NameType.adoc => Name.adoc} | 9 +++--
.../applib/types/{NameType.adoc => Notes.adoc} | 10 +++--
.../pages/index/base/applib/types/NotesType.adoc | 12 ------
.../types/{NameType.adoc => ObjectIdentifier.adoc} | 9 +++--
.../base/applib/types/ObjectIdentifierType.adoc | 12 ------
.../types/{NameType.adoc => Percentage.adoc} | 9 +++--
.../index/base/applib/types/PercentageType.adoc | 12 ------
.../types/{NameType.adoc => ProperName.adoc} | 9 +++--
.../index/base/applib/types/ProperNameType.adoc | 12 ------
.../applib/types/{NameType.adoc => Reference.adoc} | 11 ++++--
.../index/base/applib/types/ReferenceType.adoc | 12 ------
.../applib/types/{MoneyType.adoc => Title.adoc} | 9 +++--
.../pages/index/base/applib/types/TitleType.adoc | 12 ------
.../types/{NameType.adoc => UrlTemplate.adoc} | 9 +++--
.../index/base/applib/types/UrlTemplateType.adoc | 12 ------
.../index/base/applib/types/UserNameType.adoc | 12 ------
.../applib/types/{NameType.adoc => Username.adoc} | 9 +++--
.../pages/index/base/applib/types/XxxType.adoc | 12 ------
core/adoc/modules/_overview/pages/about.adoc | 4 +-
subdomains/base/adoc/modules/base/pages/about.adoc | 34 ++++++++--------
24 files changed, 120 insertions(+), 184 deletions(-)
diff --git a/antora/components/refguide-index/modules/subdomains/pages/index/base/applib/services/calendar/CalendarService.adoc b/antora/components/refguide-index/modules/subdomains/pages/index/base/applib/services/calendar/CalendarService.adoc
index f4c809e..0ffa385 100644
--- a/antora/components/refguide-index/modules/subdomains/pages/index/base/applib/services/calendar/CalendarService.adoc
+++ b/antora/components/refguide-index/modules/subdomains/pages/index/base/applib/services/calendar/CalendarService.adoc
@@ -7,35 +7,43 @@
.CalendarService.java
----
class CalendarService {
- CalendarService(ClockService clockService)
- LocalDate beginningOfMonth()
+ LocalDate beginningOfMonth() // <.>
LocalDate beginningOfMonth(final LocalDate date)
- LocalDate beginningOfQuarter()
- LocalDate beginningOfNextQuarter()
+ LocalDate beginningOfQuarter() // <.>
+ LocalDate beginningOfNextQuarter() // <.>
LocalDate beginningOfQuarter(final LocalDate date)
- long timestamp() // <.>
}
----
-<.> xref:#timestamp__[timestamp()]
+<.> xref:#beginningOfMonth__[beginningOfMonth()]
+
--
-[WARNING]
-====
-[red]#_deprecated:_#
-
-- use _ClockService#getClock()_ .getEpochMillis()
-====
+Returns the date corresponding to the beginning of the current month.
+--
+<.> xref:#beginningOfQuarter__[beginningOfQuarter()]
++
+--
+Returns the date corresponding to the beginning of the current quarter (typically: January, April, July or October).
+--
+<.> xref:#beginningOfNextQuarter__[beginningOfNextQuarter()]
++
+--
+Returns the date corresponding to the beginning of the quarter following this one.
--
== Members
-[#timestamp__]
-=== timestamp()
+[#beginningOfMonth__]
+=== beginningOfMonth()
+
+Returns the date corresponding to the beginning of the current month.
+
+[#beginningOfQuarter__]
+=== beginningOfQuarter()
+
+Returns the date corresponding to the beginning of the current quarter (typically: January, April, July or October).
-[WARNING]
-====
-[red]#_deprecated:_#
+[#beginningOfNextQuarter__]
+=== beginningOfNextQuarter()
-- use _ClockService#getClock()_ .getEpochMillis()
-====
+Returns the date corresponding to the beginning of the quarter following this one.
diff --git a/antora/components/refguide-index/modules/subdomains/pages/index/base/applib/types/NameType.adoc b/antora/components/refguide-index/modules/subdomains/pages/index/base/applib/types/Description.adoc
similarity index 81%
copy from antora/components/refguide-index/modules/subdomains/pages/index/base/applib/types/NameType.adoc
copy to antora/components/refguide-index/modules/subdomains/pages/index/base/applib/types/Description.adoc
index 452c3db..0701c9f 100644
--- a/antora/components/refguide-index/modules/subdomains/pages/index/base/applib/types/NameType.adoc
+++ b/antora/components/refguide-index/modules/subdomains/pages/index/base/applib/types/Description.adoc
@@ -1,12 +1,16 @@
-= NameType
+= @Description
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
+Meta-annotation for a _String_ property or parameter representing a description of some sort.
+
== API
[source,java]
-.NameType.java
+.Description.java
----
-class NameType {
+@interface Description {
+ int MAX_LEN;
+ int MULTI_LINE;
}
----
diff --git a/antora/components/refguide-index/modules/subdomains/pages/index/base/applib/types/DescriptionType.adoc b/antora/components/refguide-index/modules/subdomains/pages/index/base/applib/types/Fqcn.adoc
similarity index 84%
rename from antora/components/refguide-index/modules/subdomains/pages/index/base/applib/types/DescriptionType.adoc
rename to antora/components/refguide-index/modules/subdomains/pages/index/base/applib/types/Fqcn.adoc
index ede2e31..53f9bb1 100644
--- a/antora/components/refguide-index/modules/subdomains/pages/index/base/applib/types/DescriptionType.adoc
+++ b/antora/components/refguide-index/modules/subdomains/pages/index/base/applib/types/Fqcn.adoc
@@ -1,12 +1,15 @@
-= DescriptionType
+= @Fqcn
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
+Meta-annotation for a _String_ property or parameter representing a fully qualified class name
+
== API
[source,java]
-.DescriptionType.java
+.Fqcn.java
----
-class DescriptionType {
+@interface Fqcn {
+ int MAX_LEN;
}
----
diff --git a/antora/components/refguide-index/modules/subdomains/pages/index/base/applib/types/FqcnType.adoc b/antora/components/refguide-index/modules/subdomains/pages/index/base/applib/types/Money.adoc
similarity index 83%
rename from antora/components/refguide-index/modules/subdomains/pages/index/base/applib/types/FqcnType.adoc
rename to antora/components/refguide-index/modules/subdomains/pages/index/base/applib/types/Money.adoc
index d50f9a8..58d638c 100644
--- a/antora/components/refguide-index/modules/subdomains/pages/index/base/applib/types/FqcnType.adoc
+++ b/antora/components/refguide-index/modules/subdomains/pages/index/base/applib/types/Money.adoc
@@ -1,12 +1,15 @@
-= FqcnType
+= @Money
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
+Meta-annotation for a _java.math.BigDecimal_ property or parameter representing a monetary amount.
+
== API
[source,java]
-.FqcnType.java
+.Money.java
----
-class FqcnType {
+@interface Money {
+ int SCALE;
}
----
diff --git a/antora/components/refguide-index/modules/subdomains/pages/index/base/applib/types/NameType.adoc b/antora/components/refguide-index/modules/subdomains/pages/index/base/applib/types/Name.adoc
similarity index 85%
copy from antora/components/refguide-index/modules/subdomains/pages/index/base/applib/types/NameType.adoc
copy to antora/components/refguide-index/modules/subdomains/pages/index/base/applib/types/Name.adoc
index 452c3db..b738171 100644
--- a/antora/components/refguide-index/modules/subdomains/pages/index/base/applib/types/NameType.adoc
+++ b/antora/components/refguide-index/modules/subdomains/pages/index/base/applib/types/Name.adoc
@@ -1,12 +1,15 @@
-= NameType
+= @Name
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
+Meta-annotation for a _String_ property or parameter representing a name of some sort.
+
== API
[source,java]
-.NameType.java
+.Name.java
----
-class NameType {
+@interface Name {
+ int MAX_LEN;
}
----
diff --git a/antora/components/refguide-index/modules/subdomains/pages/index/base/applib/types/NameType.adoc b/antora/components/refguide-index/modules/subdomains/pages/index/base/applib/types/Notes.adoc
similarity index 81%
copy from antora/components/refguide-index/modules/subdomains/pages/index/base/applib/types/NameType.adoc
copy to antora/components/refguide-index/modules/subdomains/pages/index/base/applib/types/Notes.adoc
index 452c3db..0f20f4e 100644
--- a/antora/components/refguide-index/modules/subdomains/pages/index/base/applib/types/NameType.adoc
+++ b/antora/components/refguide-index/modules/subdomains/pages/index/base/applib/types/Notes.adoc
@@ -1,12 +1,16 @@
-= NameType
+= @Notes
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
+Meta-annotation for a _String_ property or parameter representing a notes or comments about some object.
+
== API
[source,java]
-.NameType.java
+.Notes.java
----
-class NameType {
+@interface Notes {
+ int MAX_LEN;
+ int MULTI_LINE;
}
----
diff --git a/antora/components/refguide-index/modules/subdomains/pages/index/base/applib/types/NotesType.adoc b/antora/components/refguide-index/modules/subdomains/pages/index/base/applib/types/NotesType.adoc
deleted file mode 100644
index 3e72428..0000000
--- a/antora/components/refguide-index/modules/subdomains/pages/index/base/applib/types/NotesType.adoc
+++ /dev/null
@@ -1,12 +0,0 @@
-= NotesType
-:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
-
-== API
-
-[source,java]
-.NotesType.java
-----
-class NotesType {
-}
-----
-
diff --git a/antora/components/refguide-index/modules/subdomains/pages/index/base/applib/types/NameType.adoc b/antora/components/refguide-index/modules/subdomains/pages/index/base/applib/types/ObjectIdentifier.adoc
similarity index 77%
copy from antora/components/refguide-index/modules/subdomains/pages/index/base/applib/types/NameType.adoc
copy to antora/components/refguide-index/modules/subdomains/pages/index/base/applib/types/ObjectIdentifier.adoc
index 452c3db..9f59cb3 100644
--- a/antora/components/refguide-index/modules/subdomains/pages/index/base/applib/types/NameType.adoc
+++ b/antora/components/refguide-index/modules/subdomains/pages/index/base/applib/types/ObjectIdentifier.adoc
@@ -1,12 +1,15 @@
-= NameType
+= @ObjectIdentifier
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
+Meta-annotation for a _String_ property or parameter representing a the identity of a domain object (with respect to its logical type).
+
== API
[source,java]
-.NameType.java
+.ObjectIdentifier.java
----
-class NameType {
+@interface ObjectIdentifier {
+ int MAX_LEN;
}
----
diff --git a/antora/components/refguide-index/modules/subdomains/pages/index/base/applib/types/ObjectIdentifierType.adoc b/antora/components/refguide-index/modules/subdomains/pages/index/base/applib/types/ObjectIdentifierType.adoc
deleted file mode 100644
index 6e8c2dd..0000000
--- a/antora/components/refguide-index/modules/subdomains/pages/index/base/applib/types/ObjectIdentifierType.adoc
+++ /dev/null
@@ -1,12 +0,0 @@
-= ObjectIdentifierType
-:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
-
-== API
-
-[source,java]
-.ObjectIdentifierType.java
-----
-class ObjectIdentifierType {
-}
-----
-
diff --git a/antora/components/refguide-index/modules/subdomains/pages/index/base/applib/types/NameType.adoc b/antora/components/refguide-index/modules/subdomains/pages/index/base/applib/types/Percentage.adoc
similarity index 79%
copy from antora/components/refguide-index/modules/subdomains/pages/index/base/applib/types/NameType.adoc
copy to antora/components/refguide-index/modules/subdomains/pages/index/base/applib/types/Percentage.adoc
index 452c3db..ab6b410 100644
--- a/antora/components/refguide-index/modules/subdomains/pages/index/base/applib/types/NameType.adoc
+++ b/antora/components/refguide-index/modules/subdomains/pages/index/base/applib/types/Percentage.adoc
@@ -1,12 +1,15 @@
-= NameType
+= @Percentage
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
+Meta-annotation for a numeric property or parameter representing a the identity of a domain object (with respect to its logical type).
+
== API
[source,java]
-.NameType.java
+.Percentage.java
----
-class NameType {
+@interface Percentage {
+ int SCALE;
}
----
diff --git a/antora/components/refguide-index/modules/subdomains/pages/index/base/applib/types/PercentageType.adoc b/antora/components/refguide-index/modules/subdomains/pages/index/base/applib/types/PercentageType.adoc
deleted file mode 100644
index e17ff6f..0000000
--- a/antora/components/refguide-index/modules/subdomains/pages/index/base/applib/types/PercentageType.adoc
+++ /dev/null
@@ -1,12 +0,0 @@
-= PercentageType
-:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
-
-== API
-
-[source,java]
-.PercentageType.java
-----
-class PercentageType {
-}
-----
-
diff --git a/antora/components/refguide-index/modules/subdomains/pages/index/base/applib/types/NameType.adoc b/antora/components/refguide-index/modules/subdomains/pages/index/base/applib/types/ProperName.adoc
similarity index 81%
copy from antora/components/refguide-index/modules/subdomains/pages/index/base/applib/types/NameType.adoc
copy to antora/components/refguide-index/modules/subdomains/pages/index/base/applib/types/ProperName.adoc
index 452c3db..a7a353a 100644
--- a/antora/components/refguide-index/modules/subdomains/pages/index/base/applib/types/NameType.adoc
+++ b/antora/components/refguide-index/modules/subdomains/pages/index/base/applib/types/ProperName.adoc
@@ -1,12 +1,15 @@
-= NameType
+= @ProperName
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
+Meta-annotation for a _String_ property or parameter representing the "proper" (or formal) name of some sort.
+
== API
[source,java]
-.NameType.java
+.ProperName.java
----
-class NameType {
+@interface ProperName {
+ int MAX_LEN;
}
----
diff --git a/antora/components/refguide-index/modules/subdomains/pages/index/base/applib/types/ProperNameType.adoc b/antora/components/refguide-index/modules/subdomains/pages/index/base/applib/types/ProperNameType.adoc
deleted file mode 100644
index 9f9e1e0..0000000
--- a/antora/components/refguide-index/modules/subdomains/pages/index/base/applib/types/ProperNameType.adoc
+++ /dev/null
@@ -1,12 +0,0 @@
-= ProperNameType
-:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
-
-== API
-
-[source,java]
-.ProperNameType.java
-----
-class ProperNameType {
-}
-----
-
diff --git a/antora/components/refguide-index/modules/subdomains/pages/index/base/applib/types/NameType.adoc b/antora/components/refguide-index/modules/subdomains/pages/index/base/applib/types/Reference.adoc
similarity index 78%
copy from antora/components/refguide-index/modules/subdomains/pages/index/base/applib/types/NameType.adoc
copy to antora/components/refguide-index/modules/subdomains/pages/index/base/applib/types/Reference.adoc
index 452c3db..9430f4b 100644
--- a/antora/components/refguide-index/modules/subdomains/pages/index/base/applib/types/NameType.adoc
+++ b/antora/components/refguide-index/modules/subdomains/pages/index/base/applib/types/Reference.adoc
@@ -1,12 +1,17 @@
-= NameType
+= @Reference
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
+Meta-annotation for a _String_ property or parameter representing A unique reference code of some sort.
+
== API
[source,java]
-.NameType.java
+.Reference.java
----
-class NameType {
+@interface Reference {
+ int MAX_LEN;
+ String REGEX;
+ String REGEX_DESCRIPTION;
}
----
diff --git a/antora/components/refguide-index/modules/subdomains/pages/index/base/applib/types/ReferenceType.adoc b/antora/components/refguide-index/modules/subdomains/pages/index/base/applib/types/ReferenceType.adoc
deleted file mode 100644
index 16b1477..0000000
--- a/antora/components/refguide-index/modules/subdomains/pages/index/base/applib/types/ReferenceType.adoc
+++ /dev/null
@@ -1,12 +0,0 @@
-= ReferenceType
-:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
-
-== API
-
-[source,java]
-.ReferenceType.java
-----
-class ReferenceType {
-}
-----
-
diff --git a/antora/components/refguide-index/modules/subdomains/pages/index/base/applib/types/MoneyType.adoc b/antora/components/refguide-index/modules/subdomains/pages/index/base/applib/types/Title.adoc
similarity index 83%
rename from antora/components/refguide-index/modules/subdomains/pages/index/base/applib/types/MoneyType.adoc
rename to antora/components/refguide-index/modules/subdomains/pages/index/base/applib/types/Title.adoc
index 01189c8..6156a11 100644
--- a/antora/components/refguide-index/modules/subdomains/pages/index/base/applib/types/MoneyType.adoc
+++ b/antora/components/refguide-index/modules/subdomains/pages/index/base/applib/types/Title.adoc
@@ -1,12 +1,15 @@
-= MoneyType
+= @Title
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
+Meta-annotation for a _String_ property or parameter representing a title (or perhaps label) of some sort.
+
== API
[source,java]
-.MoneyType.java
+.Title.java
----
-class MoneyType {
+@interface Title {
+ int MAX_LEN;
}
----
diff --git a/antora/components/refguide-index/modules/subdomains/pages/index/base/applib/types/TitleType.adoc b/antora/components/refguide-index/modules/subdomains/pages/index/base/applib/types/TitleType.adoc
deleted file mode 100644
index 8997a98..0000000
--- a/antora/components/refguide-index/modules/subdomains/pages/index/base/applib/types/TitleType.adoc
+++ /dev/null
@@ -1,12 +0,0 @@
-= TitleType
-:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
-
-== API
-
-[source,java]
-.TitleType.java
-----
-class TitleType {
-}
-----
-
diff --git a/antora/components/refguide-index/modules/subdomains/pages/index/base/applib/types/NameType.adoc b/antora/components/refguide-index/modules/subdomains/pages/index/base/applib/types/UrlTemplate.adoc
similarity index 76%
copy from antora/components/refguide-index/modules/subdomains/pages/index/base/applib/types/NameType.adoc
copy to antora/components/refguide-index/modules/subdomains/pages/index/base/applib/types/UrlTemplate.adoc
index 452c3db..d1abe04 100644
--- a/antora/components/refguide-index/modules/subdomains/pages/index/base/applib/types/NameType.adoc
+++ b/antora/components/refguide-index/modules/subdomains/pages/index/base/applib/types/UrlTemplate.adoc
@@ -1,12 +1,15 @@
-= NameType
+= @UrlTemplate
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
+Meta-annotation for a _String_ property or parameter representing a URL template, for example for an entity that holds configuration data to access external systems.
+
== API
[source,java]
-.NameType.java
+.UrlTemplate.java
----
-class NameType {
+@interface UrlTemplate {
+ int MAX_LEN;
}
----
diff --git a/antora/components/refguide-index/modules/subdomains/pages/index/base/applib/types/UrlTemplateType.adoc b/antora/components/refguide-index/modules/subdomains/pages/index/base/applib/types/UrlTemplateType.adoc
deleted file mode 100644
index 167c2e0..0000000
--- a/antora/components/refguide-index/modules/subdomains/pages/index/base/applib/types/UrlTemplateType.adoc
+++ /dev/null
@@ -1,12 +0,0 @@
-= UrlTemplateType
-:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
-
-== API
-
-[source,java]
-.UrlTemplateType.java
-----
-class UrlTemplateType {
-}
-----
-
diff --git a/antora/components/refguide-index/modules/subdomains/pages/index/base/applib/types/UserNameType.adoc b/antora/components/refguide-index/modules/subdomains/pages/index/base/applib/types/UserNameType.adoc
deleted file mode 100644
index f7057aa..0000000
--- a/antora/components/refguide-index/modules/subdomains/pages/index/base/applib/types/UserNameType.adoc
+++ /dev/null
@@ -1,12 +0,0 @@
-= UserNameType
-:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
-
-== API
-
-[source,java]
-.UserNameType.java
-----
-class UserNameType {
-}
-----
-
diff --git a/antora/components/refguide-index/modules/subdomains/pages/index/base/applib/types/NameType.adoc b/antora/components/refguide-index/modules/subdomains/pages/index/base/applib/types/Username.adoc
similarity index 80%
rename from antora/components/refguide-index/modules/subdomains/pages/index/base/applib/types/NameType.adoc
rename to antora/components/refguide-index/modules/subdomains/pages/index/base/applib/types/Username.adoc
index 452c3db..450d857 100644
--- a/antora/components/refguide-index/modules/subdomains/pages/index/base/applib/types/NameType.adoc
+++ b/antora/components/refguide-index/modules/subdomains/pages/index/base/applib/types/Username.adoc
@@ -1,12 +1,15 @@
-= NameType
+= @Username
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
+Meta-annotation for a _String_ property or parameter representing the unique username (or login name) of a user of the system.
+
== API
[source,java]
-.NameType.java
+.Username.java
----
-class NameType {
+@interface Username {
+ int MAX_LEN;
}
----
diff --git a/antora/components/refguide-index/modules/subdomains/pages/index/base/applib/types/XxxType.adoc b/antora/components/refguide-index/modules/subdomains/pages/index/base/applib/types/XxxType.adoc
deleted file mode 100644
index bd1d67d..0000000
--- a/antora/components/refguide-index/modules/subdomains/pages/index/base/applib/types/XxxType.adoc
+++ /dev/null
@@ -1,12 +0,0 @@
-= XxxType
-:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
-
-== API
-
-[source,java]
-.XxxType.java
-----
-class XxxType {
-}
-----
-
diff --git a/core/adoc/modules/_overview/pages/about.adoc b/core/adoc/modules/_overview/pages/about.adoc
index f18088f..8786da7 100644
--- a/core/adoc/modules/_overview/pages/about.adoc
+++ b/core/adoc/modules/_overview/pages/about.adoc
@@ -4469,7 +4469,6 @@ o.a.i.extensions.secman.jdo.util.RegexReplacer +
.Dependencies
****
org.apache.isis.core:isis-core-runtime:jar:<managed> +
-org.apache.isis.extensions:isis-extensions-secman-applib:jar:<managed> +
org.apache.isis.extensions:isis-extensions-secman-integration:jar:<managed> +
org.apache.isis.persistence:isis-persistence-jdo-applib:jar:<managed> +
org.apache.isis.persistence:isis-persistence-jdo-datanucleus:jar:<managed> +
@@ -4501,7 +4500,6 @@ o.a.i.extensions.secman.jpa.util.RegexReplacer +
.Dependencies
****
org.apache.isis.core:isis-core-runtime:jar:<managed> +
-org.apache.isis.extensions:isis-extensions-secman-applib:jar:<managed> +
org.apache.isis.extensions:isis-extensions-secman-integration:jar:<managed> +
org.apache.isis.persistence:isis-persistence-jpa-applib:jar:<managed> +
org.apache.isis.testing:isis-testing-fixtures-applib:jar:<managed> +
@@ -5256,7 +5254,7 @@ org.datanucleus:javax.jdo:jar:<managed> +
.Document Index Entries
****
-xref:refguide:subdomains:index/base/applib/Chained.adoc[Chained], xref:refguide:subdomains:index/base/applib/Dflt.adoc[Dflt], xref:refguide:subdomains:index/base/applib/IsisModuleSubdomainsBaseApplib.adoc[IsisModuleSubdomainsBaseApplib], xref:refguide:subdomains:index/base/applib/PowerType.adoc[PowerType], xref:refguide:subdomains:index/base/applib/Titled.adoc[Titled], xref:refguide:subdomains:index/base/applib/TitledEnum.adoc[TitledEnum], xref:refguide:subdomains:index/base/applib/servi [...]
+xref:refguide:subdomains:index/base/applib/Chained.adoc[Chained], xref:refguide:subdomains:index/base/applib/Dflt.adoc[Dflt], xref:refguide:subdomains:index/base/applib/IsisModuleSubdomainsBaseApplib.adoc[IsisModuleSubdomainsBaseApplib], xref:refguide:subdomains:index/base/applib/PowerType.adoc[PowerType], xref:refguide:subdomains:index/base/applib/Titled.adoc[Titled], xref:refguide:subdomains:index/base/applib/TitledEnum.adoc[TitledEnum], xref:refguide:subdomains:index/base/applib/servi [...]
****
|===
diff --git a/subdomains/base/adoc/modules/base/pages/about.adoc b/subdomains/base/adoc/modules/base/pages/about.adoc
index 5a1f449..08c0c6b 100644
--- a/subdomains/base/adoc/modules/base/pages/about.adoc
+++ b/subdomains/base/adoc/modules/base/pages/about.adoc
@@ -85,9 +85,7 @@ xref:refguide:subdomains:index/base/applib/valuetypes/VT.adoc[]
* "with" interfaces (useful to write contract tests against):
+
-:chk: icon:check[]
-+
-[cols="2a,^2a,^2a,^2a",options="header"]
+[cols="1a,^2a,^2a,^2a",options="header"]
|===
|With
| Getter
@@ -95,29 +93,29 @@ xref:refguide:subdomains:index/base/applib/valuetypes/VT.adoc[]
| Unique
| Code
-| xref:refguide:subdomains:index/base/applib/with/WithCodeGetter.adoc[{chk}]
-| xref:refguide:subdomains:index/base/applib/with/WithCodeComparable.adoc[{chk}]
-| xref:refguide:subdomains:index/base/applib/with/WithCodeUnique.adoc[{chk}]
+| xref:refguide:subdomains:index/base/applib/with/WithCodeGetter.adoc[WithCodeGetter]
+| xref:refguide:subdomains:index/base/applib/with/WithCodeComparable.adoc[WithCodeComparable]
+| xref:refguide:subdomains:index/base/applib/with/WithCodeUnique.adoc[WithCodeUnique]
| Description
-| xref:refguide:subdomains:index/base/applib/with/WithDescriptionGetter.adoc[{chk}]
-| xref:refguide:subdomains:index/base/applib/with/WithDescriptionComparable.adoc[{chk}]
-| xref:refguide:subdomains:index/base/applib/with/WithDescriptionUnique.adoc[{chk}]
+| xref:refguide:subdomains:index/base/applib/with/WithDescriptionGetter.adoc[WithDescriptionGetter]
+| xref:refguide:subdomains:index/base/applib/with/WithDescriptionComparable.adoc[WithDescriptionComparable]
+| xref:refguide:subdomains:index/base/applib/with/WithDescriptionUnique.adoc[WithDescriptionUnique]
| Name
-| xref:refguide:subdomains:index/base/applib/with/WithNameGetter.adoc[{chk}]
-| xref:refguide:subdomains:index/base/applib/with/WithNameComparable.adoc[{chk}]
-| xref:refguide:subdomains:index/base/applib/with/WithNameUnique.adoc[{chk}]
+| xref:refguide:subdomains:index/base/applib/with/WithNameGetter.adoc[WithNameGetter]
+| xref:refguide:subdomains:index/base/applib/with/WithNameComparable.adoc[WithNameComparable]
+| xref:refguide:subdomains:index/base/applib/with/WithNameUnique.adoc[WithNameUnique]
| Reference
-| xref:refguide:subdomains:index/base/applib/with/WithReferenceGetter.adoc[{chk}]
-| xref:refguide:subdomains:index/base/applib/with/WithReferenceComparable.adoc[{chk}]
-| xref:refguide:subdomains:index/base/applib/with/WithReferenceUnique.adoc[{chk}]
+| xref:refguide:subdomains:index/base/applib/with/WithReferenceGetter.adoc[WithReferenceGetter]
+| xref:refguide:subdomains:index/base/applib/with/WithReferenceComparable.adoc[WithReferenceComparable]
+| xref:refguide:subdomains:index/base/applib/with/WithReferenceUnique.adoc[WithReferenceUnique]
| Title
-| xref:refguide:subdomains:index/base/applib/with/WithTitleGetter.adoc[{chk}]
-| xref:refguide:subdomains:index/base/applib/with/WithTitleComparable.adoc[{chk}]
-| xref:refguide:subdomains:index/base/applib/with/WithTitleUnique.adoc[{chk}]
+| xref:refguide:subdomains:index/base/applib/with/WithTitleGetter.adoc[WithTitleGetter]
+| xref:refguide:subdomains:index/base/applib/with/WithTitleComparable.adoc[WithTitleComparable]
+| xref:refguide:subdomains:index/base/applib/with/WithTitleUnique.adoc[WithTitleUnique]
|===