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 10:23:15 UTC
[isis] branch master updated: ISIS-2473: remove remaining antora
tags from java sources (applib classes) (2)
This is an automated email from the ASF dual-hosted git repository.
ahuber pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/isis.git
The following commit(s) were added to refs/heads/master by this push:
new 1385581 ISIS-2473: remove remaining antora tags from java sources (applib classes) (2)
1385581 is described below
commit 13855818b374a5eecf857ada4e4f6915591abb17
Author: Andi Huber <ah...@apache.org>
AuthorDate: Sun Dec 13 10:42:17 2020 +0100
ISIS-2473: remove remaining antora tags from java sources (applib
classes) (2)
---
.../java/org/apache/isis/applib/FatalException.java | 3 +--
.../java/org/apache/isis/applib/Identifier.java | 5 +++--
.../apache/isis/applib/NonRecoverableException.java | 3 +--
.../apache/isis/applib/PersistFailedException.java | 3 +--
.../apache/isis/applib/RecoverableException.java | 3 +--
.../apache/isis/applib/RecreatableDomainObject.java | 4 +---
.../org/apache/isis/applib/RepositoryException.java | 3 +--
.../isis/applib/adapters/DefaultsProvider.java | 5 +----
.../apache/isis/applib/adapters/EncoderDecoder.java | 7 +------
.../isis/applib/adapters/EncodingException.java | 3 +--
.../org/apache/isis/applib/adapters/Parser.java | 15 +--------------
.../isis/applib/adapters/ParsingException.java | 3 +--
.../apache/isis/applib/client/SuppressionType.java | 19 +------------------
.../apache/isis/applib/events/EventObjectBase.java | 13 ++-----------
.../applib/events/domain/CollectionDomainEvent.java | 21 +++------------------
.../applib/events/domain/PropertyDomainEvent.java | 18 +++---------------
.../applib/events/lifecycle/ObjectCreatedEvent.java | 13 +++----------
.../applib/events/lifecycle/ObjectLoadedEvent.java | 13 +++----------
.../events/lifecycle/ObjectPersistedEvent.java | 13 +++----------
.../events/lifecycle/ObjectPersistingEvent.java | 13 +++----------
.../events/lifecycle/ObjectRemovingEvent.java | 13 +++----------
.../applib/events/lifecycle/ObjectUpdatedEvent.java | 13 +++----------
.../events/lifecycle/ObjectUpdatingEvent.java | 13 +++----------
.../isis/applib/events/ui/CssClassUiEvent.java | 14 +-------------
.../apache/isis/applib/events/ui/LayoutUiEvent.java | 13 +------------
.../apache/isis/applib/events/ui/TitleUiEvent.java | 17 +----------------
.../java/org/apache/isis/applib/graph/Edge.java | 4 +---
.../org/apache/isis/applib/graph/SimpleEdge.java | 4 +---
.../isis/applib/jaxb/PersistentEntitiesAdapter.java | 13 +++----------
.../isis/applib/jaxb/PersistentEntityAdapter.java | 13 +++----------
.../applib/layout/component/HasBookmarking.java | 3 +++
.../isis/applib/layout/component/HasCssClass.java | 3 +++
.../isis/applib/layout/component/HasCssClassFa.java | 3 +++
.../applib/layout/component/HasDescribedAs.java | 3 +++
.../isis/applib/layout/component/HasHidden.java | 3 +++
.../applib/layout/grid/bootstrap3/HasCssId.java | 3 +++
.../applib/mixins/timestamp/HoldsUpdatedAt.java | 3 +++
.../applib/mixins/timestamp/HoldsUpdatedBy.java | 3 +++
.../java/org/apache/isis/applib/query/Query.java | 11 +----------
.../isis/applib/query/QueryFindAllInstances.java | 1 +
.../snapshot/SnapshottableWithInclusions.java | 5 +----
.../org/apache/isis/applib/spec/Specification.java | 5 +----
.../org/apache/isis/applib/spec/Specification2.java | 5 +----
.../apache/isis/applib/spec/SpecificationAnd.java | 3 +--
.../apache/isis/applib/spec/SpecificationNot.java | 3 +--
.../apache/isis/applib/spec/SpecificationOr.java | 3 +--
.../java/org/apache/isis/applib/util/Enums.java | 3 +++
.../java/org/apache/isis/applib/util/Equality.java | 2 +-
.../java/org/apache/isis/applib/util/Hashing.java | 3 +--
.../isis/applib/util/schema/ChangesDtoUtils.java | 3 +++
.../isis/applib/util/schema/CommandDtoUtils.java | 4 +++-
.../isis/applib/util/schema/CommonDtoUtils.java | 3 +++
.../java/org/apache/isis/applib/value/Clob.java | 5 +++--
.../java/org/apache/isis/applib/value/HasHtml.java | 5 +++--
.../apache/isis/applib/value/LocalResourcePath.java | 5 ++---
.../java/org/apache/isis/applib/value/Markup.java | 4 +---
.../apache/isis/applib/value/NamedWithMimeType.java | 5 +++--
.../java/org/apache/isis/applib/value/Password.java | 6 +++---
58 files changed, 116 insertions(+), 289 deletions(-)
diff --git a/api/applib/src/main/java/org/apache/isis/applib/FatalException.java b/api/applib/src/main/java/org/apache/isis/applib/FatalException.java
index dadd763..b663634 100644
--- a/api/applib/src/main/java/org/apache/isis/applib/FatalException.java
+++ b/api/applib/src/main/java/org/apache/isis/applib/FatalException.java
@@ -33,9 +33,8 @@ package org.apache.isis.applib;
* @see RecoverableException
* @see ApplicationException
* @see NonRecoverableException
+ * @since 1.x {@index}
*/
-// tag::refguide[]
-// end::refguide[]
public class FatalException extends NonRecoverableException {
private static final long serialVersionUID = 1L;
diff --git a/api/applib/src/main/java/org/apache/isis/applib/Identifier.java b/api/applib/src/main/java/org/apache/isis/applib/Identifier.java
index e757cf0..46e89aa 100644
--- a/api/applib/src/main/java/org/apache/isis/applib/Identifier.java
+++ b/api/applib/src/main/java/org/apache/isis/applib/Identifier.java
@@ -28,8 +28,9 @@ import java.util.stream.Collectors;
import org.apache.isis.commons.internal.base._NullSafe;
import org.apache.isis.commons.internal.collections._Lists;
-// tag::refguide[]
-// end::refguide[]
+/**
+ * @since 1.x {@index}
+ */
public class Identifier implements Comparable<Identifier> {
private static final List<String> EMPTY_LIST_OF_STRINGS = Collections.<String> emptyList();
diff --git a/api/applib/src/main/java/org/apache/isis/applib/NonRecoverableException.java b/api/applib/src/main/java/org/apache/isis/applib/NonRecoverableException.java
index 32381e3..6d1f6cf 100644
--- a/api/applib/src/main/java/org/apache/isis/applib/NonRecoverableException.java
+++ b/api/applib/src/main/java/org/apache/isis/applib/NonRecoverableException.java
@@ -38,9 +38,8 @@ import org.apache.isis.commons.internal.functions._Functions;
* @see RecoverableException
* @see ApplicationException
* @see FatalException
+ * @since 1.x {@index}
*/
-// tag::refguide[]
-// end::refguide[]
public class NonRecoverableException extends RuntimeException implements TranslatableException {
private static final long serialVersionUID = 1L;
diff --git a/api/applib/src/main/java/org/apache/isis/applib/PersistFailedException.java b/api/applib/src/main/java/org/apache/isis/applib/PersistFailedException.java
index 44cfe31..a2aa3bd 100644
--- a/api/applib/src/main/java/org/apache/isis/applib/PersistFailedException.java
+++ b/api/applib/src/main/java/org/apache/isis/applib/PersistFailedException.java
@@ -30,9 +30,8 @@ package org.apache.isis.applib;
*
* @see NonRecoverableException
* @see RecoverableException
+ * @since 1.x {@index}
*/
-// tag::refguide[]
-// end::refguide[]
public class PersistFailedException extends NonRecoverableException {
private static final long serialVersionUID = 1L;
diff --git a/api/applib/src/main/java/org/apache/isis/applib/RecoverableException.java b/api/applib/src/main/java/org/apache/isis/applib/RecoverableException.java
index 6aa0059..2f1deff 100644
--- a/api/applib/src/main/java/org/apache/isis/applib/RecoverableException.java
+++ b/api/applib/src/main/java/org/apache/isis/applib/RecoverableException.java
@@ -47,9 +47,8 @@ import org.apache.isis.commons.internal.exceptions._Exceptions;
* @see ApplicationException
* @see NonRecoverableException
* @see FatalException
+ * @since 1.x {@index}
*/
-// tag::refguide[]
-// end::refguide[]
public class RecoverableException extends RuntimeException implements TranslatableException {
private static final long serialVersionUID = 1L;
diff --git a/api/applib/src/main/java/org/apache/isis/applib/RecreatableDomainObject.java b/api/applib/src/main/java/org/apache/isis/applib/RecreatableDomainObject.java
index d6ede95..549b996 100644
--- a/api/applib/src/main/java/org/apache/isis/applib/RecreatableDomainObject.java
+++ b/api/applib/src/main/java/org/apache/isis/applib/RecreatableDomainObject.java
@@ -27,10 +27,8 @@ package org.apache.isis.applib;
* Objects that are view models (logically belonging to the UI/application layer) should instead implement
* {@link org.apache.isis.applib.ViewModel}.
* </p>
-
+ * @since ? {@index}
*/
-// tag::refguide[]
-// end::refguide[]
public interface RecreatableDomainObject {
/**
diff --git a/api/applib/src/main/java/org/apache/isis/applib/RepositoryException.java b/api/applib/src/main/java/org/apache/isis/applib/RepositoryException.java
index d320dc3..2e79680 100644
--- a/api/applib/src/main/java/org/apache/isis/applib/RepositoryException.java
+++ b/api/applib/src/main/java/org/apache/isis/applib/RepositoryException.java
@@ -30,9 +30,8 @@ package org.apache.isis.applib;
*
* @see NonRecoverableException
* @see RecoverableException
+ * @since ? {@index}
*/
-// tag::refguide[]
-// end::refguide[]
public class RepositoryException extends NonRecoverableException {
private static final long serialVersionUID = 1L;
diff --git a/api/applib/src/main/java/org/apache/isis/applib/adapters/DefaultsProvider.java b/api/applib/src/main/java/org/apache/isis/applib/adapters/DefaultsProvider.java
index cb51705..cc01254 100644
--- a/api/applib/src/main/java/org/apache/isis/applib/adapters/DefaultsProvider.java
+++ b/api/applib/src/main/java/org/apache/isis/applib/adapters/DefaultsProvider.java
@@ -44,16 +44,13 @@ package org.apache.isis.applib.adapters;
* @see Parser
* @see EncoderDecoder
* @see ValueSemanticsProvider
+ * @since ? {@index}
*/
-// tag::refguide[]
public interface DefaultsProvider<T> {
- // tag::refguide[]
/**
* The default, if any (as a pojo).
*/
T getDefaultValue();
- // tag::refguide[]
}
-// end::refguide[]
diff --git a/api/applib/src/main/java/org/apache/isis/applib/adapters/EncoderDecoder.java b/api/applib/src/main/java/org/apache/isis/applib/adapters/EncoderDecoder.java
index ad2c792..a754351 100644
--- a/api/applib/src/main/java/org/apache/isis/applib/adapters/EncoderDecoder.java
+++ b/api/applib/src/main/java/org/apache/isis/applib/adapters/EncoderDecoder.java
@@ -44,11 +44,10 @@ package org.apache.isis.applib.adapters;
* @see Parser
* @see DefaultsProvider
* @see ValueSemanticsProvider
+ * @since 1.x {@index}
*/
-// tag::refguide[]
public interface EncoderDecoder<T> {
- // end::refguide[]
/**
* Returns the provided object as an encoded string.
*
@@ -58,10 +57,8 @@ public interface EncoderDecoder<T> {
* constructor. That is, the object shouldn't encode itself, it should
* encode the object provided to it.
*/
- // tag::refguide[]
String toEncodedString(T toEncode);
- // end::refguide[]
/**
* Converts an encoded string to an instance of the object.
*
@@ -70,8 +67,6 @@ public interface EncoderDecoder<T> {
*
* @see #toEncodedString(T toEncode)
*/
- // tag::refguide[]
T fromEncodedString(String encodedString);
}
-// end::refguide[]
diff --git a/api/applib/src/main/java/org/apache/isis/applib/adapters/EncodingException.java b/api/applib/src/main/java/org/apache/isis/applib/adapters/EncodingException.java
index 5827d0f..4644d8b 100644
--- a/api/applib/src/main/java/org/apache/isis/applib/adapters/EncodingException.java
+++ b/api/applib/src/main/java/org/apache/isis/applib/adapters/EncodingException.java
@@ -21,8 +21,8 @@ package org.apache.isis.applib.adapters;
/**
* Indicates that encoding or decoding has failed.
+ * @since ? {@index}
*/
-// tag::refguide[]
public class EncodingException extends RuntimeException {
private static final long serialVersionUID = 1L;
@@ -43,4 +43,3 @@ public class EncodingException extends RuntimeException {
}
}
-// end::refguide[]
diff --git a/api/applib/src/main/java/org/apache/isis/applib/adapters/Parser.java b/api/applib/src/main/java/org/apache/isis/applib/adapters/Parser.java
index 7cd592f..ccbc3ea 100644
--- a/api/applib/src/main/java/org/apache/isis/applib/adapters/Parser.java
+++ b/api/applib/src/main/java/org/apache/isis/applib/adapters/Parser.java
@@ -73,11 +73,10 @@ package org.apache.isis.applib.adapters;
* @see DefaultsProvider
* @see EncoderDecoder
* @see ValueSemanticsProvider
+ * @since 1.x {@index}
*/
-// tag::refguide[]
public interface Parser<T> {
- // end::refguide[]
/**
* Parses a string to an instance of the object.
*
@@ -87,31 +86,23 @@ public interface Parser<T> {
* - the context domain object for which the text is being
* parsed. For example +3 might mean add 3 to the current number.
*/
- // tag::refguide[]
T parseTextEntry(Object contextPojo, String entry);
- // end::refguide[]
/**
* The typical length of objects that can be parsed.
*/
- // tag::refguide[]
int typicalLength();
- // end::refguide[]
/**
* The title of the object.
*/
- // tag::refguide[]
String displayTitleOf(T object);
- // end::refguide[]
/**
* The title of the object using a mask.
*/
- // tag::refguide[]
String displayTitleOf(T object, String usingMask);
- // end::refguide[]
/**
* A title for the object that is valid but which may be easier to edit than
* the title provided by a <code>TitleFacet</code>.
@@ -122,18 +113,14 @@ public interface Parser<T> {
* field. So, a date might be rendered via a <code>TitleFacet</code> as
* <tt>May 2, 2007</tt>, but its editable form might be <tt>20070502</tt>.
*/
- // tag::refguide[]
String parseableTitleOf(T existing);
- // end::refguide[]
/**
* The max length of objects that can be parsed (if any).
* A return type of -1 corresponds to unlimited.
*/
- // tag::refguide[]
default int maxLength() {
return -1;
}
}
-// end::refguide[]
diff --git a/api/applib/src/main/java/org/apache/isis/applib/adapters/ParsingException.java b/api/applib/src/main/java/org/apache/isis/applib/adapters/ParsingException.java
index 9b4413e..da808f1 100644
--- a/api/applib/src/main/java/org/apache/isis/applib/adapters/ParsingException.java
+++ b/api/applib/src/main/java/org/apache/isis/applib/adapters/ParsingException.java
@@ -22,8 +22,8 @@ package org.apache.isis.applib.adapters;
/**
* Indicates that parsing has failed, ie the entry is illegal (rather than
* invalid).
+ * @since 1.x {@index}
*/
-// tag::refguide[]
public class ParsingException extends RuntimeException {
private static final long serialVersionUID = 1L;
@@ -44,4 +44,3 @@ public class ParsingException extends RuntimeException {
}
}
-// end::refguide[]
diff --git a/api/applib/src/main/java/org/apache/isis/applib/client/SuppressionType.java b/api/applib/src/main/java/org/apache/isis/applib/client/SuppressionType.java
index 661260f..dc52e9e 100644
--- a/api/applib/src/main/java/org/apache/isis/applib/client/SuppressionType.java
+++ b/api/applib/src/main/java/org/apache/isis/applib/client/SuppressionType.java
@@ -26,55 +26,40 @@ import org.apache.isis.commons.internal.base._NullSafe;
import static org.apache.isis.commons.internal.base._NullSafe.stream;
/**
- *
- * @since 2.0
+ * @since 2.0 {@index}
*/
-// tag::refguide[]
public enum SuppressionType {
- // end::refguide[]
/**
* suppress '$$RO', RO Spec representation
*/
- // tag::refguide[]
RO,
- // end::refguide[]
/**
* suppress '$$href', hyperlink to the representation
*/
- // tag::refguide[]
HREF,
- // end::refguide[]
/**
suppress '$$instanceId', instance id of the domain object
*/
- // tag::refguide[]
ID,
- // end::refguide[]
/**
* suppress '$$domainType', object spec of the domain object
*/
- // tag::refguide[]
DOMAIN_TYPE,
- // end::refguide[]
/**
* suppress '$$title', title of the domain object
*/
- // tag::refguide[]
TITLE,
- // end::refguide[]
/**
* suppress all '$$...' entries
*/
- // tag::refguide[]
ALL
- // end::refguide[]
;
public static EnumSet<SuppressionType> setOf(SuppressionType ... types){
@@ -111,7 +96,5 @@ public enum SuppressionType {
}
}
}
- // tag::refguide[]
}
-// end::refguide[]
diff --git a/api/applib/src/main/java/org/apache/isis/applib/events/EventObjectBase.java b/api/applib/src/main/java/org/apache/isis/applib/events/EventObjectBase.java
index 2635740..9b5c643 100644
--- a/api/applib/src/main/java/org/apache/isis/applib/events/EventObjectBase.java
+++ b/api/applib/src/main/java/org/apache/isis/applib/events/EventObjectBase.java
@@ -25,41 +25,34 @@ import org.apache.isis.commons.internal.exceptions._Exceptions;
import static org.apache.isis.commons.internal.base._With.requires;
/**
- * @since 2.0
+ * @since 2.0 {@index}
+ *
*/
-// tag::refguide[]
public abstract class EventObjectBase<T> {
- // end::refguide[]
/**
* The object on which the Event initially occurred.
*/
- // tag::refguide[]
protected transient T source;
- // end::refguide[]
/**
* Constructs a prototypical Event.
*
* @param source The object on which the Event initially occurred.
*/
- // tag::refguide[]
protected EventObjectBase(@Nullable T source) {
this.source = source;
}
- // end::refguide[]
/**
* The object on which the Event initially occurred.
*
* @return The object on which the Event initially occurred.
*/
- // tag::refguide[]
public @Nullable T getSource() {
return source;
}
- // end::refguide[]
/**
* A one-shot function. Only allowed to be called if a source has not already been set.
*
@@ -83,7 +76,5 @@ public abstract class EventObjectBase<T> {
public String toString() {
return getClass().getName() + "[source=" + source + "]";
}
- // tag::refguide[]
}
-// end::refguide[]
diff --git a/api/applib/src/main/java/org/apache/isis/applib/events/domain/CollectionDomainEvent.java b/api/applib/src/main/java/org/apache/isis/applib/events/domain/CollectionDomainEvent.java
index 3bf5192..5fd73c1 100644
--- a/api/applib/src/main/java/org/apache/isis/applib/events/domain/CollectionDomainEvent.java
+++ b/api/applib/src/main/java/org/apache/isis/applib/events/domain/CollectionDomainEvent.java
@@ -23,36 +23,31 @@ import org.apache.isis.applib.util.ToString;
import lombok.Getter;
-// tag::refguide[]
+/**
+ * @since ? {@index}
+ */
public abstract class CollectionDomainEvent<S,T> extends AbstractDomainEvent<S> {
- // end::refguide[]
/**
* This class is the default for the
* {@link org.apache.isis.applib.annotation.Collection#domainEvent()} annotation attribute. Whether this
* raises an event or not depends upon the <tt>isis.core.meta-model.annotation.collection.domain-event.post-for-default</tt>
* configuration property.
*/
- // tag::refguide[]
public static class Default extends CollectionDomainEvent<Object, Object> { }
- // end::refguide[]
/**
* Convenience class to use indicating that an event should <i>not</i> be posted (irrespective of the configuration
* property setting for the {@link Default} event.
*/
- // tag::refguide[]
public static class Noop extends CollectionDomainEvent<Object, Object> {}
- // end::refguide[]
/**
* Convenience class meaning that an event <i>should</i> be posted (irrespective of the configuration
* property setting for the {@link Default} event..
*/
- // tag::refguide[]
public static class Doop extends CollectionDomainEvent<Object, Object> {}
- // end::refguide[]
/**
* If used then the framework will set state via (non-API) setters.
@@ -70,36 +65,29 @@ public abstract class CollectionDomainEvent<S,T> extends AbstractDomainEvent<S>
* The proposed reference to either add or remove (per {@link #getOf()}), populated at {@link org.apache.isis.applib.events.domain.AbstractDomainEvent.Phase#VALIDATE}
* and subsequent phases (is null for {@link org.apache.isis.applib.events.domain.AbstractDomainEvent.Phase#HIDE hidden} and {@link org.apache.isis.applib.events.domain.AbstractDomainEvent.Phase#DISABLE disable} phases).
*/
- // tag::refguide[]
@Getter
private T value;
public static enum Of {
- // end::refguide[]
/**
* The collection is being accessed
* ({@link Phase#HIDE hide} and
* {@link Phase#DISABLE disable}) checks.
*/
- // tag::refguide[]
ACCESS,
- // end::refguide[]
/**
* The collection is being added to
* ({@link Phase#VALIDATE validity} check and
* {@link Phase#EXECUTED execution}).
*/
- // tag::refguide[]
ADD_TO,
- // end::refguide[]
/**
* The collection is being removed from
* ({@link Phase#VALIDATE validity} check and
* {@link Phase#EXECUTED execution}).
*/
- // tag::refguide[]
REMOVE_FROM
}
@@ -107,7 +95,6 @@ public abstract class CollectionDomainEvent<S,T> extends AbstractDomainEvent<S>
@Getter
private Of of;
- // end::refguide[]
/**
* Not API, set by the framework.
*/
@@ -137,7 +124,5 @@ public abstract class CollectionDomainEvent<S,T> extends AbstractDomainEvent<S>
return toString.toString(this);
}
- // tag::refguide[]
}
-// end::refguide[]
diff --git a/api/applib/src/main/java/org/apache/isis/applib/events/domain/PropertyDomainEvent.java b/api/applib/src/main/java/org/apache/isis/applib/events/domain/PropertyDomainEvent.java
index 1dbf127..07141b8 100644
--- a/api/applib/src/main/java/org/apache/isis/applib/events/domain/PropertyDomainEvent.java
+++ b/api/applib/src/main/java/org/apache/isis/applib/events/domain/PropertyDomainEvent.java
@@ -24,36 +24,31 @@ import org.apache.isis.applib.util.ToString;
import lombok.Getter;
import lombok.Setter;
-// tag::refguide[]
+/**
+ * @since ? {@index}
+ */
public abstract class PropertyDomainEvent<S,T> extends AbstractDomainEvent<S> {
- // end::refguide[]
/**
* This class is the default for the
* {@link org.apache.isis.applib.annotation.Property#domainEvent()} annotation attribute. Whether this
* raises an event or not depends upon the <tt>isis.core.meta-model.annotation.property.domain-event.post-for-default</tt>
* configuration property.
*/
- // tag::refguide[]
public static class Default extends PropertyDomainEvent<Object, Object> {}
- // end::refguide[]
/**
* Convenience class to use indicating that an event should <i>not</i> be posted (irrespective of the configuration
* property setting for the {@link Default} event.
*/
- // tag::refguide[]
public static class Noop extends PropertyDomainEvent<Object, Object> {}
- // end::refguide[]
/**
* Convenience class meaning that an event <i>should</i> be posted (irrespective of the configuration
* property setting for the {@link Default} event..
*/
- // tag::refguide[]
public static class Doop extends PropertyDomainEvent<Object, Object> {}
- // end::refguide[]
/**
* If used then the framework will set state via (non-API) setters.
*
@@ -64,16 +59,13 @@ public abstract class PropertyDomainEvent<S,T> extends AbstractDomainEvent<S> {
public PropertyDomainEvent() {
}
- // end::refguide[]
/**
* The current (pre-modification) value of the property; populated at {@link org.apache.isis.applib.events.domain.AbstractDomainEvent.Phase#VALIDATE} and subsequent phases
* (but null for {@link org.apache.isis.applib.events.domain.AbstractDomainEvent.Phase#HIDE hidden} and {@link org.apache.isis.applib.events.domain.AbstractDomainEvent.Phase#DISABLE disable} phases).
*/
- // tag::refguide[]
@Getter @Setter
private T oldValue;
- // end::refguide[]
/**
* The proposed (post-modification) value of the property; populated at {@link org.apache.isis.applib.events.domain.AbstractDomainEvent.Phase#VALIDATE} and subsequent phases
* (but null for {@link org.apache.isis.applib.events.domain.AbstractDomainEvent.Phase#HIDE hidden} and {@link org.apache.isis.applib.events.domain.AbstractDomainEvent.Phase#DISABLE disable} phases).
@@ -85,11 +77,9 @@ public abstract class PropertyDomainEvent<S,T> extends AbstractDomainEvent<S> {
* no sanity checks.
* </p>
*/
- // tag::refguide[]
@Getter @Setter
private T newValue;
- // end::refguide[]
@@ -107,7 +97,5 @@ public abstract class PropertyDomainEvent<S,T> extends AbstractDomainEvent<S> {
return toString.toString(this);
}
- // tag::refguide[]
}
-// end::refguide[]
diff --git a/api/applib/src/main/java/org/apache/isis/applib/events/lifecycle/ObjectCreatedEvent.java b/api/applib/src/main/java/org/apache/isis/applib/events/lifecycle/ObjectCreatedEvent.java
index 1a2482e..79d6a2a 100644
--- a/api/applib/src/main/java/org/apache/isis/applib/events/lifecycle/ObjectCreatedEvent.java
+++ b/api/applib/src/main/java/org/apache/isis/applib/events/lifecycle/ObjectCreatedEvent.java
@@ -18,36 +18,31 @@
*/
package org.apache.isis.applib.events.lifecycle;
-// tag::refguide[]
+/**
+ * @since ? {@index}
+ */
public abstract class ObjectCreatedEvent<S> extends AbstractLifecycleEvent<S> {
- // end::refguide[]
/**
* This class is the default for the
* {@link org.apache.isis.applib.annotation.DomainObject#createdLifecycleEvent()} annotation attribute. Whether this
* raises an event or not depends upon the <tt>isis.core.meta-model.annotation.domain-object.created-lifecycle-event.post-for-default</tt>
* configuration property.
*/
- // tag::refguide[]
public static class Default extends ObjectCreatedEvent<Object> {}
- // end::refguide[]
/**
* Convenience class to use indicating that an event should <i>not</i> be posted (irrespective of the configuration
* property setting for the {@link Default} event.
*/
- // tag::refguide[]
public static class Noop extends ObjectCreatedEvent<Object> {}
- // end::refguide[]
/**
* Convenience class meaning that an event <i>should</i> be posted (irrespective of the configuration
* property setting for the {@link Default} event..
*/
- // tag::refguide[]
public static class Doop extends ObjectCreatedEvent<Object> {}
- // end::refguide[]
public ObjectCreatedEvent() {
}
@@ -55,7 +50,5 @@ public abstract class ObjectCreatedEvent<S> extends AbstractLifecycleEvent<S> {
super(source);
}
- // tag::refguide[]
}
-// end::refguide[]
diff --git a/api/applib/src/main/java/org/apache/isis/applib/events/lifecycle/ObjectLoadedEvent.java b/api/applib/src/main/java/org/apache/isis/applib/events/lifecycle/ObjectLoadedEvent.java
index acc5780..f7e33fc 100644
--- a/api/applib/src/main/java/org/apache/isis/applib/events/lifecycle/ObjectLoadedEvent.java
+++ b/api/applib/src/main/java/org/apache/isis/applib/events/lifecycle/ObjectLoadedEvent.java
@@ -18,36 +18,31 @@
*/
package org.apache.isis.applib.events.lifecycle;
-// tag::refguide[]
+/**
+ * @since ? {@index}
+ */
public abstract class ObjectLoadedEvent<S> extends AbstractLifecycleEvent<S> {
- // end::refguide[]
/**
* This class is the default for the
* {@link org.apache.isis.applib.annotation.DomainObject#loadedLifecycleEvent()} annotation attribute. Whether this
* raises an event or not depends upon the <tt>isis.core.meta-model.annotation.domain-object.loaded-lifecycle-event.post-for-default</tt>
* configuration property.
*/
- // tag::refguide[]
public static class Default extends ObjectLoadedEvent<Object> {}
- // end::refguide[]
/**
* Convenience class to use indicating that an event should <i>not</i> be posted (irrespective of the configuration
* property setting for the {@link Default} event.
*/
- // tag::refguide[]
public static class Noop extends ObjectLoadedEvent<Object> {}
- // end::refguide[]
/**
* Convenience class meaning that an event <i>should</i> be posted (irrespective of the configuration
* property setting for the {@link Default} event..
*/
- // tag::refguide[]
public static class Doop extends ObjectLoadedEvent<Object> {}
- // end::refguide[]
public ObjectLoadedEvent() {
}
@@ -55,7 +50,5 @@ public abstract class ObjectLoadedEvent<S> extends AbstractLifecycleEvent<S> {
super(source);
}
- // tag::refguide[]
}
-// end::refguide[]
diff --git a/api/applib/src/main/java/org/apache/isis/applib/events/lifecycle/ObjectPersistedEvent.java b/api/applib/src/main/java/org/apache/isis/applib/events/lifecycle/ObjectPersistedEvent.java
index cf364b6..1f507ba 100644
--- a/api/applib/src/main/java/org/apache/isis/applib/events/lifecycle/ObjectPersistedEvent.java
+++ b/api/applib/src/main/java/org/apache/isis/applib/events/lifecycle/ObjectPersistedEvent.java
@@ -18,36 +18,31 @@
*/
package org.apache.isis.applib.events.lifecycle;
-// tag::refguide[]
+/**
+ * @since ? {@index}
+ */
public abstract class ObjectPersistedEvent<S> extends AbstractLifecycleEvent<S> {
- // end::refguide[]
/**
* This class is the default for the
* {@link org.apache.isis.applib.annotation.DomainObject#persistedLifecycleEvent()} annotation attribute. Whether this
* raises an event or not depends upon the <tt>isis.core.meta-model.annotation.domain-object.persisted-lifecycle-event.post-for-default</tt>
* configuration property.
*/
- // tag::refguide[]
public static class Default extends ObjectPersistedEvent<Object> {}
- // end::refguide[]
/**
* Convenience class to use indicating that an event should <i>not</i> be posted (irrespective of the configuration
* property setting for the {@link Default} event.
*/
- // tag::refguide[]
public static class Noop extends ObjectPersistedEvent<Object> {}
- // end::refguide[]
/**
* Convenience class meaning that an event <i>should</i> be posted (irrespective of the configuration
* property setting for the {@link Default} event..
*/
- // tag::refguide[]
public static class Doop extends ObjectPersistedEvent<Object> {}
- // end::refguide[]
public ObjectPersistedEvent() {
}
@@ -56,7 +51,5 @@ public abstract class ObjectPersistedEvent<S> extends AbstractLifecycleEvent<S>
super(source);
}
- // tag::refguide[]
}
-// end::refguide[]
diff --git a/api/applib/src/main/java/org/apache/isis/applib/events/lifecycle/ObjectPersistingEvent.java b/api/applib/src/main/java/org/apache/isis/applib/events/lifecycle/ObjectPersistingEvent.java
index 6f5c070..245f611 100644
--- a/api/applib/src/main/java/org/apache/isis/applib/events/lifecycle/ObjectPersistingEvent.java
+++ b/api/applib/src/main/java/org/apache/isis/applib/events/lifecycle/ObjectPersistingEvent.java
@@ -18,36 +18,31 @@
*/
package org.apache.isis.applib.events.lifecycle;
-// tag::refguide[]
+/**
+ * @since ? {@index}
+ */
public abstract class ObjectPersistingEvent<S> extends AbstractLifecycleEvent<S> {
- // end::refguide[]
/**
* This class is the default for the
* {@link org.apache.isis.applib.annotation.DomainObject#persistingLifecycleEvent()} annotation attribute. Whether this
* raises an event or not depends upon the <tt>isis.core.meta-model.annotation.domain-object.persisting-lifecycle-event.post-for-default</tt>
* configuration property.
*/
- // tag::refguide[]
public static class Default extends ObjectPersistingEvent<Object> {}
- // end::refguide[]
/**
* Convenience class to use indicating that an event should <i>not</i> be posted (irrespective of the configuration
* property setting for the {@link Default} event.
*/
- // tag::refguide[]
public static class Noop extends ObjectPersistingEvent<Object> {}
- // end::refguide[]
/**
* Convenience class meaning that an event <i>should</i> be posted (irrespective of the configuration
* property setting for the {@link Default} event..
*/
- // tag::refguide[]
public static class Doop extends ObjectPersistingEvent<Object> {}
- // end::refguide[]
public ObjectPersistingEvent() {
}
@@ -55,7 +50,5 @@ public abstract class ObjectPersistingEvent<S> extends AbstractLifecycleEvent<S>
super(source);
}
- // tag::refguide[]
}
-// end::refguide[]
diff --git a/api/applib/src/main/java/org/apache/isis/applib/events/lifecycle/ObjectRemovingEvent.java b/api/applib/src/main/java/org/apache/isis/applib/events/lifecycle/ObjectRemovingEvent.java
index 6ad99af..6af275a 100644
--- a/api/applib/src/main/java/org/apache/isis/applib/events/lifecycle/ObjectRemovingEvent.java
+++ b/api/applib/src/main/java/org/apache/isis/applib/events/lifecycle/ObjectRemovingEvent.java
@@ -18,36 +18,31 @@
*/
package org.apache.isis.applib.events.lifecycle;
-// tag::refguide[]
+/**
+ * @since ? {@index}
+ */
public abstract class ObjectRemovingEvent<S> extends AbstractLifecycleEvent<S> {
- // end::refguide[]
/**
* This class is the default for the
* {@link org.apache.isis.applib.annotation.DomainObject#removingLifecycleEvent()} annotation attribute. Whether this
* raises an event or not depends upon the <tt>isis.core.meta-model.annotation.domain-object.removing-lifecycle-event.post-for-default</tt>
* configuration property.
*/
- // tag::refguide[]
public static class Default extends ObjectRemovingEvent<Object> {}
- // end::refguide[]
/**
* Convenience class to use indicating that an event should <i>not</i> be posted (irrespective of the configuration
* property setting for the {@link Default} event.
*/
- // tag::refguide[]
public static class Noop extends ObjectRemovingEvent<Object> {}
- // end::refguide[]
/**
* Convenience class meaning that an event <i>should</i> be posted (irrespective of the configuration
* property setting for the {@link Default} event..
*/
- // tag::refguide[]
public static class Doop extends ObjectRemovingEvent<Object> {}
- // end::refguide[]
public ObjectRemovingEvent() {
}
@@ -56,7 +51,5 @@ public abstract class ObjectRemovingEvent<S> extends AbstractLifecycleEvent<S> {
super(source);
}
- // tag::refguide[]
}
-// end::refguide[]
diff --git a/api/applib/src/main/java/org/apache/isis/applib/events/lifecycle/ObjectUpdatedEvent.java b/api/applib/src/main/java/org/apache/isis/applib/events/lifecycle/ObjectUpdatedEvent.java
index 4e2f080..7716e51 100644
--- a/api/applib/src/main/java/org/apache/isis/applib/events/lifecycle/ObjectUpdatedEvent.java
+++ b/api/applib/src/main/java/org/apache/isis/applib/events/lifecycle/ObjectUpdatedEvent.java
@@ -18,36 +18,31 @@
*/
package org.apache.isis.applib.events.lifecycle;
-// tag::refguide[]
+/**
+ * @since ? {@index}
+ */
public abstract class ObjectUpdatedEvent<S> extends AbstractLifecycleEvent<S> {
- // end::refguide[]
/**
* This class is the default for the
* {@link org.apache.isis.applib.annotation.DomainObject#updatedLifecycleEvent()} annotation attribute. Whether this
* raises an event or not depends upon the <tt>isis.core.meta-model.annotation.domain-object.updated-lifecycle-event.post-for-default</tt>
* configuration property.
*/
- // tag::refguide[]
public static class Default extends ObjectUpdatedEvent<Object> {}
- // end::refguide[]
/**
* Convenience class to use indicating that an event should <i>not</i> be posted (irrespective of the configuration
* property setting for the {@link Default} event.
*/
- // tag::refguide[]
public static class Noop extends ObjectUpdatedEvent<Object> {}
- // end::refguide[]
/**
* Convenience class meaning that an event <i>should</i> be posted (irrespective of the configuration
* property setting for the {@link Default} event..
*/
- // tag::refguide[]
public static class Doop extends ObjectUpdatedEvent<Object> {}
- // end::refguide[]
public ObjectUpdatedEvent() {
}
@@ -56,7 +51,5 @@ public abstract class ObjectUpdatedEvent<S> extends AbstractLifecycleEvent<S> {
super(source);
}
- // tag::refguide[]
}
-// end::refguide[]
diff --git a/api/applib/src/main/java/org/apache/isis/applib/events/lifecycle/ObjectUpdatingEvent.java b/api/applib/src/main/java/org/apache/isis/applib/events/lifecycle/ObjectUpdatingEvent.java
index c0a4813..1e1ba25 100644
--- a/api/applib/src/main/java/org/apache/isis/applib/events/lifecycle/ObjectUpdatingEvent.java
+++ b/api/applib/src/main/java/org/apache/isis/applib/events/lifecycle/ObjectUpdatingEvent.java
@@ -18,36 +18,31 @@
*/
package org.apache.isis.applib.events.lifecycle;
-// tag::refguide[]
+/**
+ * @since ? {@index}
+ */
public abstract class ObjectUpdatingEvent<S> extends AbstractLifecycleEvent<S> {
- // end::refguide[]
/**
* This class is the default for the
* {@link org.apache.isis.applib.annotation.DomainObject#updatingLifecycleEvent()} annotation attribute. Whether this
* raises an event or not depends upon the <tt>isis.core.meta-model.annotation.domain-object.updating-lifecycle-event.post-for-default</tt>
* configuration property.
*/
- // tag::refguide[]
public static class Default extends ObjectUpdatingEvent<Object> {}
- // end::refguide[]
/**
* Convenience class to use indicating that an event should <i>not</i> be posted (irrespective of the configuration
* property setting for the {@link Default} event.
*/
- // tag::refguide[]
public static class Noop extends ObjectUpdatingEvent<Object> {}
- // end::refguide[]
/**
* Convenience class meaning that an event <i>should</i> be posted (irrespective of the configuration
* property setting for the {@link Default} event..
*/
- // tag::refguide[]
public static class Doop extends ObjectUpdatingEvent<Object> {}
- // end::refguide[]
public ObjectUpdatingEvent() {
}
@@ -56,7 +51,5 @@ public abstract class ObjectUpdatingEvent<S> extends AbstractLifecycleEvent<S> {
super(source);
}
- // tag::refguide[]
}
-// end::refguide[]
diff --git a/api/applib/src/main/java/org/apache/isis/applib/events/ui/CssClassUiEvent.java b/api/applib/src/main/java/org/apache/isis/applib/events/ui/CssClassUiEvent.java
index a3ea0bf..da43156 100644
--- a/api/applib/src/main/java/org/apache/isis/applib/events/ui/CssClassUiEvent.java
+++ b/api/applib/src/main/java/org/apache/isis/applib/events/ui/CssClassUiEvent.java
@@ -21,41 +21,33 @@ package org.apache.isis.applib.events.ui;
import org.apache.isis.applib.annotation.DomainObjectLayout;
import lombok.Getter;
-import lombok.Setter;
/**
* Emitted for subscribers to obtain a cssClass hint (equivalent to the <tt>cssClass()</tt> supporting method or the {@link DomainObjectLayout#cssClass()} attribute).
+ * @since ? {@index}
*/
-// tag::refguide[]
public abstract class CssClassUiEvent<S> extends AbstractUiEvent<S> {
- // end::refguide[]
/**
* This class is the default for the
* {@link org.apache.isis.applib.annotation.DomainObjectLayout#cssClassUiEvent()} annotation attribute. Whether this
* raises an event or not depends upon the <tt>isis.core.meta-model.annotation.domain-object-layout.css-class-ui-event.post-for-default</tt>
* configuration property.
*/
- // tag::refguide[]
public static class Default extends CssClassUiEvent<Object> {}
- // end::refguide[]
/**
* Convenience class to use indicating that an event should <i>not</i> be posted (irrespective of the configuration
* property setting for the {@link Default} event.
*/
- // tag::refguide[]
public static class Noop extends CssClassUiEvent<Object> {}
- // end::refguide[]
/**
* Convenience class meaning that an event <i>should</i> be posted (irrespective of the configuration
* property setting for the {@link Default} event..
*/
- // tag::refguide[]
public static class Doop extends CssClassUiEvent<Object> {}
- // end::refguide[]
/**
* If used then the framework will set state via (non-API) setters.
@@ -72,18 +64,14 @@ public abstract class CssClassUiEvent<S> extends AbstractUiEvent<S> {
/**
* The CSS class as provided by a subscriber using {@link #setCssClass(String)}.
*/
- // tag::refguide[]
@Getter
private String cssClass;
- // end::refguide[]
/**
* For subscribers to call to provide a CSS class for this object.
*/
- // tag::refguide[]
public void setCssClass(final String cssClass) {
this.cssClass = cssClass;
}
}
-// end::refguide[]
diff --git a/api/applib/src/main/java/org/apache/isis/applib/events/ui/LayoutUiEvent.java b/api/applib/src/main/java/org/apache/isis/applib/events/ui/LayoutUiEvent.java
index 5804488..828a6c7 100644
--- a/api/applib/src/main/java/org/apache/isis/applib/events/ui/LayoutUiEvent.java
+++ b/api/applib/src/main/java/org/apache/isis/applib/events/ui/LayoutUiEvent.java
@@ -26,37 +26,30 @@ import lombok.Getter;
/**
* Emitted for subscribers to obtain a layout hint (equivalent to the <tt>layout()</tt> supporting method).
+ * @since ? {@index}
*/
-// tag::refguide[]
public abstract class LayoutUiEvent<S> extends AbstractUiEvent<S> {
- // end::refguide[]
/**
* This class is the default for the
* {@link DomainObjectLayout#layoutUiEvent()} annotation attribute. Whether this
* raises an event or not depends upon the <tt>isis.core.meta-model.annotation.domain-object-layout.layout-ui-event.post-for-default</tt>
* configuration property.
*/
- // tag::refguide[]
public static class Default extends LayoutUiEvent<Object> { }
- // end::refguide[]
/**
* Convenience class to use indicating that an event should <i>not</i> be posted (irrespective of the configuration
* property setting for the {@link Default} event.
*/
- // tag::refguide[]
public static class Noop extends LayoutUiEvent<Object> { }
- // end::refguide[]
/**
* Convenience class meaning that an event <i>should</i> be posted (irrespective of the configuration
* property setting for the {@link Default} event..
*/
- // tag::refguide[]
public static class Doop extends LayoutUiEvent<Object> { }
- // end::refguide[]
/**
* If used then the framework will set state via (non-API) setters.
*
@@ -75,16 +68,12 @@ public abstract class LayoutUiEvent<S> extends AbstractUiEvent<S> {
/**
* The name of the alternate layout to use, as provided by a subscriber using {@link #setLayout(String)}.
*/
- // tag::refguide[]
@Getter
private String layout;
- // end::refguide[]
/**
* For subscribers to call to provide a layout for this object.
*/
- // tag::refguide[]
public void setLayout(final String layout) { }
}
-// end::refguide[]
diff --git a/api/applib/src/main/java/org/apache/isis/applib/events/ui/TitleUiEvent.java b/api/applib/src/main/java/org/apache/isis/applib/events/ui/TitleUiEvent.java
index 88e6829..abc336a 100644
--- a/api/applib/src/main/java/org/apache/isis/applib/events/ui/TitleUiEvent.java
+++ b/api/applib/src/main/java/org/apache/isis/applib/events/ui/TitleUiEvent.java
@@ -26,37 +26,30 @@ import lombok.Getter;
/**
* Emitted for subscribers to obtain a cssClass hint (equivalent to the <tt>title()</tt> supporting method).
+ * @since ? {@index}
*/
-// tag::refguide[]
public abstract class TitleUiEvent<S> extends AbstractUiEvent<S> {
- // end::refguide[]
/**
* This class is the default for the
* {@link org.apache.isis.applib.annotation.DomainObjectLayout#titleUiEvent()} annotation attribute. Whether this
* raises an event or not depends upon the <tt>isis.core.meta-model.annotation.domain-object-layout.title-ui-event.post-for-default</tt>
* configuration property.
*/
- // tag::refguide[]
public static class Default extends TitleUiEvent<Object> {}
- // end::refguide[]
/**
* Convenience class to use indicating that an event should <i>not</i> be posted (irrespective of the configuration
* property seting for the {@link Default} event.
*/
- // tag::refguide[]
public static class Noop extends TitleUiEvent<Object> {}
- // end::refguide[]
/**
* Convenience class meaning that an event <i>should</i> be posted (irrespective of the configuration
* property setting for the {@link Default} event..
*/
- // tag::refguide[]
public static class Doop extends TitleUiEvent<Object> {}
- // end::refguide[]
/**
* If used then the framework will set state via (non-API) setters.
@@ -81,21 +74,17 @@ public abstract class TitleUiEvent<S> extends AbstractUiEvent<S> {
* Note that a {@link #getTranslatableTitle()} will be used in preference, if available.
* </p>
*/
- // tag::refguide[]
@Getter
private String title;
- // end::refguide[]
/**
* For subscribers to call to provide a (non-translated) title for this object.
*/
- // tag::refguide[]
public void setTitle(final String title) {
this.title = title;
}
- // end::refguide[]
/**
* The translatable (i18n) title as provided by a subscriber using {@link #setTranslatableTitle(TranslatableString)}.
*
@@ -104,19 +93,15 @@ public abstract class TitleUiEvent<S> extends AbstractUiEvent<S> {
* {@link #getTitle() non-translatable title}.
* </p>
*/
- // tag::refguide[]
@Getter
private TranslatableString translatableTitle;
/**
* For subscribers to call to provide a translatable (i18n) title for this object.
*/
- // tag::refguide[]
public void setTranslatableTitle(final TranslatableString translatableTitle) {
this.translatableTitle = translatableTitle;
}
- // tag::refguide[]
}
-// end::refguide[]
diff --git a/api/applib/src/main/java/org/apache/isis/applib/graph/Edge.java b/api/applib/src/main/java/org/apache/isis/applib/graph/Edge.java
index bd4c0f3..96e90f9 100644
--- a/api/applib/src/main/java/org/apache/isis/applib/graph/Edge.java
+++ b/api/applib/src/main/java/org/apache/isis/applib/graph/Edge.java
@@ -21,11 +21,10 @@ package org.apache.isis.applib.graph;
/**
* Fundamental building block for graph structures.
*
- * @since 2.0
+ * @since 2.0 {@index}
*
* @param <T> type constraint for values contained by this edge's vertices
*/
-// tag::refguide[]
public interface Edge<T> {
Vertex<T> getFrom();
@@ -33,4 +32,3 @@ public interface Edge<T> {
Vertex<T> getTo();
}
-// end::refguide[]
diff --git a/api/applib/src/main/java/org/apache/isis/applib/graph/SimpleEdge.java b/api/applib/src/main/java/org/apache/isis/applib/graph/SimpleEdge.java
index 3ba7003..50f1c05 100644
--- a/api/applib/src/main/java/org/apache/isis/applib/graph/SimpleEdge.java
+++ b/api/applib/src/main/java/org/apache/isis/applib/graph/SimpleEdge.java
@@ -23,11 +23,10 @@ import lombok.Value;
/**
* Fundamental building block for graph structures.
*
- * @since 2.0
+ * @since 2.0 {@index}
*
* @param <T> type constraint for values contained by this edge's vertices
*/
-// tag::refguide[]
@Value(staticConstructor = "of")
public class SimpleEdge<T> implements Edge<T> {
@@ -35,4 +34,3 @@ public class SimpleEdge<T> implements Edge<T> {
Vertex<T> to;
}
-// end::refguide[]
diff --git a/api/applib/src/main/java/org/apache/isis/applib/jaxb/PersistentEntitiesAdapter.java b/api/applib/src/main/java/org/apache/isis/applib/jaxb/PersistentEntitiesAdapter.java
index de2f9e7..7f57f40 100644
--- a/api/applib/src/main/java/org/apache/isis/applib/jaxb/PersistentEntitiesAdapter.java
+++ b/api/applib/src/main/java/org/apache/isis/applib/jaxb/PersistentEntitiesAdapter.java
@@ -32,7 +32,9 @@ import lombok.AccessLevel;
import lombok.Getter;
import lombok.val;
-// tag::refguide[]
+/**
+ * @since ? {@index}
+ */
public class PersistentEntitiesAdapter extends XmlAdapter<OidsDto, List<Object>> {
@Inject @Getter(AccessLevel.PROTECTED)
@@ -40,7 +42,6 @@ public class PersistentEntitiesAdapter extends XmlAdapter<OidsDto, List<Object>>
@Override
public List<Object> unmarshal(final OidsDto oidsDto) {
- // end::refguide[]
List<Object> domainObjects = new ArrayList<>();
for (val oidDto : oidsDto.getOid()) {
@@ -49,14 +50,10 @@ public class PersistentEntitiesAdapter extends XmlAdapter<OidsDto, List<Object>>
domainObjects.add(domainObject);
}
return domainObjects;
-
- // tag::refguide[]
- // ...
}
@Override
public OidsDto marshal(final List<Object> domainObjects) {
- // end::refguide[]
if(domainObjects == null) {
return null;
@@ -67,10 +64,6 @@ public class PersistentEntitiesAdapter extends XmlAdapter<OidsDto, List<Object>>
oidsDto.getOid().add(bookmark.toOidDto());
}
return oidsDto;
-
- // tag::refguide[]
- // ...
}
}
-// end::refguide[]
diff --git a/api/applib/src/main/java/org/apache/isis/applib/jaxb/PersistentEntityAdapter.java b/api/applib/src/main/java/org/apache/isis/applib/jaxb/PersistentEntityAdapter.java
index e836f00..d24f7d1 100644
--- a/api/applib/src/main/java/org/apache/isis/applib/jaxb/PersistentEntityAdapter.java
+++ b/api/applib/src/main/java/org/apache/isis/applib/jaxb/PersistentEntityAdapter.java
@@ -25,35 +25,28 @@ import org.apache.isis.schema.common.v2.OidDto;
import lombok.val;
-// tag::refguide[]
+/**
+ * @since ? {@index}
+ */
public class PersistentEntityAdapter extends XmlAdapter<OidDto, Object> {
@Inject private BookmarkService bookmarkService;
@Override
public Object unmarshal(final OidDto oidDto) throws Exception {
- // end::refguide[]
val bookmark = Bookmark.from(oidDto);
return bookmarkService.lookup(bookmark);
-
- // tag::refguide[]
- // ...
}
@Override
public OidDto marshal(final Object domainObject) throws Exception {
- // end::refguide[]
if(domainObject == null) {
return null;
}
val bookmark = bookmarkService.bookmarkForElseThrow(domainObject);
return bookmark.toOidDto();
-
- // tag::refguide[]
- // ...
}
}
-// end::refguide[]
diff --git a/api/applib/src/main/java/org/apache/isis/applib/layout/component/HasBookmarking.java b/api/applib/src/main/java/org/apache/isis/applib/layout/component/HasBookmarking.java
index 361971a..47e5954 100644
--- a/api/applib/src/main/java/org/apache/isis/applib/layout/component/HasBookmarking.java
+++ b/api/applib/src/main/java/org/apache/isis/applib/layout/component/HasBookmarking.java
@@ -22,6 +22,9 @@ import javax.xml.bind.annotation.XmlAttribute;
import org.apache.isis.applib.annotation.BookmarkPolicy;
+/**
+ * @since 2.0 {@index}
+ */
public interface HasBookmarking {
@XmlAttribute(required = false)
BookmarkPolicy getBookmarking();
diff --git a/api/applib/src/main/java/org/apache/isis/applib/layout/component/HasCssClass.java b/api/applib/src/main/java/org/apache/isis/applib/layout/component/HasCssClass.java
index 26d2088..0dc13a2 100644
--- a/api/applib/src/main/java/org/apache/isis/applib/layout/component/HasCssClass.java
+++ b/api/applib/src/main/java/org/apache/isis/applib/layout/component/HasCssClass.java
@@ -20,6 +20,9 @@ package org.apache.isis.applib.layout.component;
import javax.xml.bind.annotation.XmlAttribute;
+/**
+ * @since 2.0 {@index}
+ */
public interface HasCssClass {
@XmlAttribute(required = false)
String getCssClass();
diff --git a/api/applib/src/main/java/org/apache/isis/applib/layout/component/HasCssClassFa.java b/api/applib/src/main/java/org/apache/isis/applib/layout/component/HasCssClassFa.java
index 8452713..f027b19 100644
--- a/api/applib/src/main/java/org/apache/isis/applib/layout/component/HasCssClassFa.java
+++ b/api/applib/src/main/java/org/apache/isis/applib/layout/component/HasCssClassFa.java
@@ -20,6 +20,9 @@ package org.apache.isis.applib.layout.component;
import javax.xml.bind.annotation.XmlAttribute;
+/**
+ * @since 2.0 {@index}
+ */
public interface HasCssClassFa {
@XmlAttribute(required = false)
diff --git a/api/applib/src/main/java/org/apache/isis/applib/layout/component/HasDescribedAs.java b/api/applib/src/main/java/org/apache/isis/applib/layout/component/HasDescribedAs.java
index ad9f99a..d2aeda3 100644
--- a/api/applib/src/main/java/org/apache/isis/applib/layout/component/HasDescribedAs.java
+++ b/api/applib/src/main/java/org/apache/isis/applib/layout/component/HasDescribedAs.java
@@ -20,6 +20,9 @@ package org.apache.isis.applib.layout.component;
import javax.xml.bind.annotation.XmlElement;
+/**
+ * @since 2.0 {@index}
+ */
public interface HasDescribedAs {
@XmlElement(required = false)
diff --git a/api/applib/src/main/java/org/apache/isis/applib/layout/component/HasHidden.java b/api/applib/src/main/java/org/apache/isis/applib/layout/component/HasHidden.java
index 60add99..4836897 100644
--- a/api/applib/src/main/java/org/apache/isis/applib/layout/component/HasHidden.java
+++ b/api/applib/src/main/java/org/apache/isis/applib/layout/component/HasHidden.java
@@ -22,6 +22,9 @@ import javax.xml.bind.annotation.XmlAttribute;
import org.apache.isis.applib.annotation.Where;
+/**
+ * @since 2.0 {@index}
+ */
public interface HasHidden {
@XmlAttribute(required = false)
diff --git a/api/applib/src/main/java/org/apache/isis/applib/layout/grid/bootstrap3/HasCssId.java b/api/applib/src/main/java/org/apache/isis/applib/layout/grid/bootstrap3/HasCssId.java
index 9b774da..e2de04d 100644
--- a/api/applib/src/main/java/org/apache/isis/applib/layout/grid/bootstrap3/HasCssId.java
+++ b/api/applib/src/main/java/org/apache/isis/applib/layout/grid/bootstrap3/HasCssId.java
@@ -18,6 +18,9 @@
*/
package org.apache.isis.applib.layout.grid.bootstrap3;
+/**
+ * @since 2.0 {@index}
+ */
public interface HasCssId {
/**
diff --git a/api/applib/src/main/java/org/apache/isis/applib/mixins/timestamp/HoldsUpdatedAt.java b/api/applib/src/main/java/org/apache/isis/applib/mixins/timestamp/HoldsUpdatedAt.java
index d3e8404..a47b65a 100644
--- a/api/applib/src/main/java/org/apache/isis/applib/mixins/timestamp/HoldsUpdatedAt.java
+++ b/api/applib/src/main/java/org/apache/isis/applib/mixins/timestamp/HoldsUpdatedAt.java
@@ -18,6 +18,9 @@
*/
package org.apache.isis.applib.mixins.timestamp;
+/**
+ * @since 2.0 {@index}
+ */
public interface HoldsUpdatedAt {
void setUpdatedAt(java.sql.Timestamp updatedAt);
diff --git a/api/applib/src/main/java/org/apache/isis/applib/mixins/timestamp/HoldsUpdatedBy.java b/api/applib/src/main/java/org/apache/isis/applib/mixins/timestamp/HoldsUpdatedBy.java
index d156407..6348c51 100644
--- a/api/applib/src/main/java/org/apache/isis/applib/mixins/timestamp/HoldsUpdatedBy.java
+++ b/api/applib/src/main/java/org/apache/isis/applib/mixins/timestamp/HoldsUpdatedBy.java
@@ -18,6 +18,9 @@
*/
package org.apache.isis.applib.mixins.timestamp;
+/**
+ * @since 2.0 {@index}
+ */
public interface HoldsUpdatedBy {
void setUpdatedBy(String updatedBy);
diff --git a/api/applib/src/main/java/org/apache/isis/applib/query/Query.java b/api/applib/src/main/java/org/apache/isis/applib/query/Query.java
index 02e6931..afafceb 100644
--- a/api/applib/src/main/java/org/apache/isis/applib/query/Query.java
+++ b/api/applib/src/main/java/org/apache/isis/applib/query/Query.java
@@ -44,41 +44,32 @@ import org.apache.isis.applib.services.repository.RepositoryService;
*
* Note that the predicate is applied within the {@link RepositoryService}
* (ie client-side) rather than being pushed back to the object store.
+ * @since ? {@index}
*/
-// tag::refguide[]
public interface Query<T> extends Serializable {
- // end::refguide[]
/**
* The {@link Class} of the objects returned by this query.
*/
- // tag::refguide[]
Class<T> getResultType();
- // end::refguide[]
/**
* A human-readable representation of this query and its values.
*/
- // tag::refguide[]
String getDescription();
- // end::refguide[]
/**
* The start index into the set table
*
* @return
*/
- // tag::refguide[]
long getStart();
- // end::refguide[]
/**
* The number of items to return, starting at {@link #getStart()}
*
* @return
*/
- // tag::refguide[]
long getCount();
}
-// end::refguide[]
diff --git a/api/applib/src/main/java/org/apache/isis/applib/query/QueryFindAllInstances.java b/api/applib/src/main/java/org/apache/isis/applib/query/QueryFindAllInstances.java
index a8a18dc..f37c591 100644
--- a/api/applib/src/main/java/org/apache/isis/applib/query/QueryFindAllInstances.java
+++ b/api/applib/src/main/java/org/apache/isis/applib/query/QueryFindAllInstances.java
@@ -26,6 +26,7 @@ import java.io.Serializable;
* Although implements {@link Query} and thus is intended to be (and indeed is)
* {@link Serializable}, it will be converted into a <tt>PersistenceQuery</tt>
* in the runtime for remoting purposes.
+ * @since ? {@index}
*/
public class QueryFindAllInstances<T> extends QueryAbstract<T> {
diff --git a/api/applib/src/main/java/org/apache/isis/applib/snapshot/SnapshottableWithInclusions.java b/api/applib/src/main/java/org/apache/isis/applib/snapshot/SnapshottableWithInclusions.java
index bb70ec9..3245e77 100644
--- a/api/applib/src/main/java/org/apache/isis/applib/snapshot/SnapshottableWithInclusions.java
+++ b/api/applib/src/main/java/org/apache/isis/applib/snapshot/SnapshottableWithInclusions.java
@@ -27,16 +27,13 @@ import org.apache.isis.applib.services.xmlsnapshot.XmlSnapshotService;
* Optional interface for domain objects with which an
* snapshot is to be created using the {@link XmlSnapshotService}, indicating
* paths to be {@link XmlSnapshotService.Snapshot#} automatically include additional paths within the snapshot.
+ * @since ? {@index}
*/
-// tag::refguide[]
public interface SnapshottableWithInclusions {
- // end::refguide[]
/**
* Paths to include in the snapshot.
*/
- // tag::refguide[]
List<String> snapshotInclusions();
}
-// end::refguide[]
diff --git a/api/applib/src/main/java/org/apache/isis/applib/spec/Specification.java b/api/applib/src/main/java/org/apache/isis/applib/spec/Specification.java
index f08d788..4197702 100644
--- a/api/applib/src/main/java/org/apache/isis/applib/spec/Specification.java
+++ b/api/applib/src/main/java/org/apache/isis/applib/spec/Specification.java
@@ -22,17 +22,14 @@ package org.apache.isis.applib.spec;
/**
* An implementation of the <i>Specification</i> pattern, as described in Eric
* Evans' <i>Domain Driven Design</i>, p224.
+ * @since ? {@index}
*/
-// tag::refguide[]
public interface Specification {
- // end::refguide[]
/**
* If <tt>null</tt> then satisfied, otherwise is reason why the
* specification is not satisfied.
*/
- // tag::refguide[]
String satisfies(Object obj);
}
-// end::refguide[]
diff --git a/api/applib/src/main/java/org/apache/isis/applib/spec/Specification2.java b/api/applib/src/main/java/org/apache/isis/applib/spec/Specification2.java
index 6b391b1..336ce35 100644
--- a/api/applib/src/main/java/org/apache/isis/applib/spec/Specification2.java
+++ b/api/applib/src/main/java/org/apache/isis/applib/spec/Specification2.java
@@ -28,16 +28,13 @@ import org.apache.isis.applib.services.i18n.TranslatableString;
* If implemented, then the {@link #satisfies(Object)} inherited from {@link Specification} can just return <tt>null</tt>;
* it will never be called by the framework.
* </p>
+ * @since ? {@index}
*/
-// tag::refguide[]
public interface Specification2 extends Specification {
- // end::refguide[]
/**
* If <tt>null</tt> then satisfied, otherwise is the reason (as a {@link TranslatableString} translatable string) as to why the specification is not satisfied.
*/
- // tag::refguide[]
TranslatableString satisfiesTranslatable(Object obj);
}
-// end::refguide[]
diff --git a/api/applib/src/main/java/org/apache/isis/applib/spec/SpecificationAnd.java b/api/applib/src/main/java/org/apache/isis/applib/spec/SpecificationAnd.java
index d66e00f..427b581 100644
--- a/api/applib/src/main/java/org/apache/isis/applib/spec/SpecificationAnd.java
+++ b/api/applib/src/main/java/org/apache/isis/applib/spec/SpecificationAnd.java
@@ -42,8 +42,8 @@ import org.apache.isis.applib.util.ReasonBuffer;
*
* @see SpecificationOr
* @see SpecificationNot
+ * @since ? {@index}
*/
-// tag::refguide[]
public abstract class SpecificationAnd implements Specification {
private final Specification[] specifications;
@@ -63,4 +63,3 @@ public abstract class SpecificationAnd implements Specification {
}
}
-// end::refguide[]
diff --git a/api/applib/src/main/java/org/apache/isis/applib/spec/SpecificationNot.java b/api/applib/src/main/java/org/apache/isis/applib/spec/SpecificationNot.java
index 64ffffa..f57b63d 100644
--- a/api/applib/src/main/java/org/apache/isis/applib/spec/SpecificationNot.java
+++ b/api/applib/src/main/java/org/apache/isis/applib/spec/SpecificationNot.java
@@ -43,8 +43,8 @@ package org.apache.isis.applib.spec;
*
* @see SpecificationAnd
* @see SpecificationOr
+ * @since ? {@index}
*/
-// tag::refguide[]
public abstract class SpecificationNot implements Specification {
private final Specification specification;
@@ -59,4 +59,3 @@ public abstract class SpecificationNot implements Specification {
return satisfies != null ? null : "not satisfied";
}
}
-// end::refguide[]
diff --git a/api/applib/src/main/java/org/apache/isis/applib/spec/SpecificationOr.java b/api/applib/src/main/java/org/apache/isis/applib/spec/SpecificationOr.java
index 62029f5..6d6a9f5 100644
--- a/api/applib/src/main/java/org/apache/isis/applib/spec/SpecificationOr.java
+++ b/api/applib/src/main/java/org/apache/isis/applib/spec/SpecificationOr.java
@@ -42,8 +42,8 @@ import org.apache.isis.applib.util.ReasonBuffer;
*
* @see SpecificationAnd
* @see SpecificationNot
+ * @since ? {@index}
*/
-// tag::refguide[]
public abstract class SpecificationOr implements Specification {
private final Specification[] specifications;
@@ -67,4 +67,3 @@ public abstract class SpecificationOr implements Specification {
}
}
-// end::refguide[]
diff --git a/api/applib/src/main/java/org/apache/isis/applib/util/Enums.java b/api/applib/src/main/java/org/apache/isis/applib/util/Enums.java
index 4047788..41f385f 100644
--- a/api/applib/src/main/java/org/apache/isis/applib/util/Enums.java
+++ b/api/applib/src/main/java/org/apache/isis/applib/util/Enums.java
@@ -25,6 +25,9 @@ import org.apache.isis.commons.internal.base._Strings;
import lombok.experimental.UtilityClass;
+/**
+ * @since ? {@index}
+ */
@UtilityClass
public final class Enums {
diff --git a/api/applib/src/main/java/org/apache/isis/applib/util/Equality.java b/api/applib/src/main/java/org/apache/isis/applib/util/Equality.java
index a8509fd..e0ba38b 100644
--- a/api/applib/src/main/java/org/apache/isis/applib/util/Equality.java
+++ b/api/applib/src/main/java/org/apache/isis/applib/util/Equality.java
@@ -29,7 +29,7 @@ import org.apache.isis.commons.internal.collections._Lists;
* Fluent Object Equality Composition.
*
* @param <T>
- * @since 2.0
+ * @since 2.0 {@index}
*/
public class Equality<T> {
diff --git a/api/applib/src/main/java/org/apache/isis/applib/util/Hashing.java b/api/applib/src/main/java/org/apache/isis/applib/util/Hashing.java
index 1a393a4..1ac17b3 100644
--- a/api/applib/src/main/java/org/apache/isis/applib/util/Hashing.java
+++ b/api/applib/src/main/java/org/apache/isis/applib/util/Hashing.java
@@ -28,8 +28,7 @@ import org.apache.isis.commons.internal.collections._Lists;
* Fluent Object Hash Code Composition.
*
* @param <T>
- * @since 2.0
- *
+ * @since 2.0 {@index}
*/
public class Hashing<T> {
diff --git a/api/applib/src/main/java/org/apache/isis/applib/util/schema/ChangesDtoUtils.java b/api/applib/src/main/java/org/apache/isis/applib/util/schema/ChangesDtoUtils.java
index 5e013a1..5433730 100644
--- a/api/applib/src/main/java/org/apache/isis/applib/util/schema/ChangesDtoUtils.java
+++ b/api/applib/src/main/java/org/apache/isis/applib/util/schema/ChangesDtoUtils.java
@@ -35,6 +35,9 @@ import org.apache.isis.applib.util.JaxbUtil;
import org.apache.isis.commons.internal.resources._Resources;
import org.apache.isis.schema.chg.v2.ChangesDto;
+/**
+ * @since ? {@index}
+ */
public final class ChangesDtoUtils {
public static void init() {
diff --git a/api/applib/src/main/java/org/apache/isis/applib/util/schema/CommandDtoUtils.java b/api/applib/src/main/java/org/apache/isis/applib/util/schema/CommandDtoUtils.java
index ea5e56f..61159dd 100644
--- a/api/applib/src/main/java/org/apache/isis/applib/util/schema/CommandDtoUtils.java
+++ b/api/applib/src/main/java/org/apache/isis/applib/util/schema/CommandDtoUtils.java
@@ -33,7 +33,6 @@ import javax.xml.bind.Unmarshaller;
import org.apache.isis.applib.services.bookmark.Bookmark;
import org.apache.isis.applib.util.JaxbUtil;
import org.apache.isis.commons.internal.base._Strings;
-import org.apache.isis.commons.internal.exceptions._Exceptions;
import org.apache.isis.commons.internal.resources._Resources;
import org.apache.isis.schema.cmd.v2.ActionDto;
import org.apache.isis.schema.cmd.v2.CommandDto;
@@ -42,6 +41,9 @@ import org.apache.isis.schema.cmd.v2.ParamsDto;
import org.apache.isis.schema.common.v2.OidsDto;
import org.apache.isis.schema.common.v2.PeriodDto;
+/**
+ * @since ? {@index}
+ */
public final class CommandDtoUtils {
public static void init() {
diff --git a/api/applib/src/main/java/org/apache/isis/applib/util/schema/CommonDtoUtils.java b/api/applib/src/main/java/org/apache/isis/applib/util/schema/CommonDtoUtils.java
index eab3811..ec9e5b5 100644
--- a/api/applib/src/main/java/org/apache/isis/applib/util/schema/CommonDtoUtils.java
+++ b/api/applib/src/main/java/org/apache/isis/applib/util/schema/CommonDtoUtils.java
@@ -60,6 +60,9 @@ import static org.apache.isis.commons.internal.collections._Maps.entry;
import lombok.val;
+/**
+ * @since ? {@index}
+ */
public final class CommonDtoUtils {
// -- PARAM_DTO_TO_NAME, PARAM_DTO_TO_TYPE
diff --git a/api/applib/src/main/java/org/apache/isis/applib/value/Clob.java b/api/applib/src/main/java/org/apache/isis/applib/value/Clob.java
index 0b558de..6a294e8 100644
--- a/api/applib/src/main/java/org/apache/isis/applib/value/Clob.java
+++ b/api/applib/src/main/java/org/apache/isis/applib/value/Clob.java
@@ -35,8 +35,9 @@ import org.apache.isis.commons.internal.base._Strings;
import lombok.val;
-// tag::refguide[]
-// end::refguide[]
+/**
+ * @since 1.x {@index}
+ */
@Value(semanticsProviderName =
"org.apache.isis.core.metamodel.facets.value.clobs.ClobValueSemanticsProvider")
@XmlJavaTypeAdapter(Clob.JaxbToStringAdapter.class) // for JAXB view model support
diff --git a/api/applib/src/main/java/org/apache/isis/applib/value/HasHtml.java b/api/applib/src/main/java/org/apache/isis/applib/value/HasHtml.java
index ecb6fec..e6a0a23 100644
--- a/api/applib/src/main/java/org/apache/isis/applib/value/HasHtml.java
+++ b/api/applib/src/main/java/org/apache/isis/applib/value/HasHtml.java
@@ -19,8 +19,9 @@
package org.apache.isis.applib.value;
-// tag::refguide[]
-// end::refguide[]
+/**
+ * @since 2.0 {@index}
+ */
public interface HasHtml {
String asHtml();
diff --git a/api/applib/src/main/java/org/apache/isis/applib/value/LocalResourcePath.java b/api/applib/src/main/java/org/apache/isis/applib/value/LocalResourcePath.java
index 47523bc..fe05629 100644
--- a/api/applib/src/main/java/org/apache/isis/applib/value/LocalResourcePath.java
+++ b/api/applib/src/main/java/org/apache/isis/applib/value/LocalResourcePath.java
@@ -32,9 +32,8 @@ import lombok.NonNull;
/**
* Represents a local resource path, typically a relative path originating at this web-app's root or context-root.
+ * @since 2.0 {@index}
*/
-// tag::refguide[]
-// end::refguide[]
@Value(semanticsProviderName =
"org.apache.isis.core.metamodel.facets.value.localrespath.LocalResourcePathValueSemanticsProvider")
@XmlJavaTypeAdapter(LocalResourcePath.JaxbToStringAdapter.class) // for JAXB view model support
@@ -111,4 +110,4 @@ public final class LocalResourcePath implements Serializable {
return localResourcePath != null ? localResourcePath.getPath() : null;
}
}
-}
\ No newline at end of file
+}
diff --git a/api/applib/src/main/java/org/apache/isis/applib/value/Markup.java b/api/applib/src/main/java/org/apache/isis/applib/value/Markup.java
index ee1bec6..ae49b04 100644
--- a/api/applib/src/main/java/org/apache/isis/applib/value/Markup.java
+++ b/api/applib/src/main/java/org/apache/isis/applib/value/Markup.java
@@ -31,10 +31,8 @@ import org.apache.isis.commons.internal.base._Strings;
/**
* Immutable value type holding pre-rendered HTML.
- *
+ * @since 2.0 {@index}
*/
-// tag::refguide[]
-// end::refguide[]
@Value(semanticsProviderName =
"org.apache.isis.core.metamodel.facets.value.markup.MarkupValueSemanticsProvider")
@XmlJavaTypeAdapter(Markup.JaxbToStringAdapter.class) // for JAXB view model support
diff --git a/api/applib/src/main/java/org/apache/isis/applib/value/NamedWithMimeType.java b/api/applib/src/main/java/org/apache/isis/applib/value/NamedWithMimeType.java
index c242158..626e473 100644
--- a/api/applib/src/main/java/org/apache/isis/applib/value/NamedWithMimeType.java
+++ b/api/applib/src/main/java/org/apache/isis/applib/value/NamedWithMimeType.java
@@ -28,8 +28,9 @@ import org.apache.isis.commons.collections.Can;
import lombok.Getter;
-// tag::refguide[]
-// end::refguide[]
+/**
+ * @since 2.0 {@index}
+ */
public interface NamedWithMimeType extends Serializable {
public String getName();
diff --git a/api/applib/src/main/java/org/apache/isis/applib/value/Password.java b/api/applib/src/main/java/org/apache/isis/applib/value/Password.java
index 45adcf7..2f9a229 100644
--- a/api/applib/src/main/java/org/apache/isis/applib/value/Password.java
+++ b/api/applib/src/main/java/org/apache/isis/applib/value/Password.java
@@ -24,12 +24,12 @@ import java.util.Objects;
import javax.xml.bind.annotation.XmlAccessType;
import javax.xml.bind.annotation.XmlAccessorType;
-import javax.xml.bind.annotation.adapters.XmlJavaTypeAdapter;
import org.apache.isis.applib.annotation.Value;
-// tag::refguide[]
-// end::refguide[]
+/**
+ * @since 1.x {@index}
+ */
@Value(semanticsProviderName = "org.apache.isis.core.metamodel.facets.value.password.PasswordValueSemanticsProvider")
@XmlAccessorType(XmlAccessType.FIELD)
// @XmlJavaTypeAdapter(Password.JaxbToStringAdapter.class) // TODO: not automatically registered because not secure enough. Instead we should set up some sort of mechanism to encrypt.