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 2021/06/25 06:17:21 UTC
[isis] branch master updated: ISIS-2766: java-doc polishing
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 93bc43c ISIS-2766: java-doc polishing
93bc43c is described below
commit 93bc43c41280eff1f3842caf595a8b576bfe0c4b
Author: Andi Huber <ah...@apache.org>
AuthorDate: Fri Jun 25 08:17:09 2021 +0200
ISIS-2766: java-doc polishing
---
.../metamodel/facets/object/icon/ObjectIcon.java | 6 ++++++
.../facets/object/icon/ObjectIconService.java | 24 +++++++---------------
2 files changed, 13 insertions(+), 17 deletions(-)
diff --git a/core/metamodel/src/main/java/org/apache/isis/core/metamodel/facets/object/icon/ObjectIcon.java b/core/metamodel/src/main/java/org/apache/isis/core/metamodel/facets/object/icon/ObjectIcon.java
index 030662d..9e7e319 100644
--- a/core/metamodel/src/main/java/org/apache/isis/core/metamodel/facets/object/icon/ObjectIcon.java
+++ b/core/metamodel/src/main/java/org/apache/isis/core/metamodel/facets/object/icon/ObjectIcon.java
@@ -35,6 +35,12 @@ import lombok.Synchronized;
import lombok.ToString;
import lombok.val;
+/**
+ * Icon image data class-path resource reference.
+ *
+ * @see ObjectIconService
+ * @since 2.0
+ */
@RequiredArgsConstructor
@ToString
@EqualsAndHashCode
diff --git a/core/metamodel/src/main/java/org/apache/isis/core/metamodel/facets/object/icon/ObjectIconService.java b/core/metamodel/src/main/java/org/apache/isis/core/metamodel/facets/object/icon/ObjectIconService.java
index 1145635..baf09ba 100644
--- a/core/metamodel/src/main/java/org/apache/isis/core/metamodel/facets/object/icon/ObjectIconService.java
+++ b/core/metamodel/src/main/java/org/apache/isis/core/metamodel/facets/object/icon/ObjectIconService.java
@@ -20,6 +20,7 @@ package org.apache.isis.core.metamodel.facets.object.icon;
import javax.annotation.Nullable;
+import org.apache.isis.core.metamodel.spec.ManagedObject;
import org.apache.isis.core.metamodel.spec.ObjectSpecification;
import lombok.NonNull;
@@ -27,9 +28,13 @@ import lombok.NonNull;
/**
* Creates {@link ObjectIcon}(s), which are class-path resource references.
* <p>
- * Internally used by the metamodel.
- * Clients should use {@link ObjectSpecification#getIcon(org.apache.isis.core.metamodel.spec.ManagedObject)}.
+ * Clients should not use this service directly. Either use
+ * {@link ManagedObject#getIcon()} or
+ * {@link ObjectSpecification#getIcon(org.apache.isis.core.metamodel.spec.ManagedObject)}.
*
+ * @apiNote internal service, used by the metamodel
+ *
+ * @see ManagedObject#getIcon()
* @see ObjectSpecification#getIcon(org.apache.isis.core.metamodel.spec.ManagedObject)
* @since 2.0
*/
@@ -44,19 +49,4 @@ public interface ObjectIconService {
@NonNull ObjectSpecification specification,
@Nullable String iconNameSuffixIfAny);
-// ObjectIcon getObjectFallbackIcon();
-//
-// // -- SHORTCUTS
-//
-// default ObjectIcon getObjectIcon(final ObjectSpecification spec) {
-// return getObjectIcon(spec, null);
-// }
-//
-// default ObjectIcon getObjectIcon(final ManagedObject adapter) {
-// return ManagedObjects.isSpecified(adapter)
-// ? getObjectIcon(
-// adapter.getSpecification(),
-// adapter.getSpecification().getIconName(adapter))
-// : getObjectFallbackIcon();
-// }
}