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/11/11 11:38:19 UTC

[isis] branch master updated: ISIS-2877: remove HelpFacetNone

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 1c036c0  ISIS-2877: remove HelpFacetNone
1c036c0 is described below

commit 1c036c022b1e3a9486aa5ce5f175214265aad098
Author: Andi Huber <ah...@apache.org>
AuthorDate: Thu Nov 11 12:38:08 2021 +0100

    ISIS-2877: remove HelpFacetNone
---
 .../core/metamodel/facets/all/help/HelpFacet.java  |  2 +-
 .../facets/all/help/HelpFacetAbstract.java         |  8 +++--
 .../facets/fallback/FallbackFacetFactory.java      |  3 --
 .../metamodel/facets/fallback/HelpFacetNone.java   | 41 ----------------------
 4 files changed, 6 insertions(+), 48 deletions(-)

diff --git a/core/metamodel/src/main/java/org/apache/isis/core/metamodel/facets/all/help/HelpFacet.java b/core/metamodel/src/main/java/org/apache/isis/core/metamodel/facets/all/help/HelpFacet.java
index c20902e..b429a35 100644
--- a/core/metamodel/src/main/java/org/apache/isis/core/metamodel/facets/all/help/HelpFacet.java
+++ b/core/metamodel/src/main/java/org/apache/isis/core/metamodel/facets/all/help/HelpFacet.java
@@ -22,7 +22,7 @@ import org.apache.isis.core.metamodel.facets.SingleStringValueFacet;
 
 /**
  * Provide help about a class, a property, collection or action or a parameter.
- *
+ * @apiNote currently not implemented - kept for potential future extensions
  */
 public interface HelpFacet extends SingleStringValueFacet {
 }
diff --git a/core/metamodel/src/main/java/org/apache/isis/core/metamodel/facets/all/help/HelpFacetAbstract.java b/core/metamodel/src/main/java/org/apache/isis/core/metamodel/facets/all/help/HelpFacetAbstract.java
index b662d7c..17a06ca 100644
--- a/core/metamodel/src/main/java/org/apache/isis/core/metamodel/facets/all/help/HelpFacetAbstract.java
+++ b/core/metamodel/src/main/java/org/apache/isis/core/metamodel/facets/all/help/HelpFacetAbstract.java
@@ -22,17 +22,19 @@ import org.apache.isis.core.metamodel.facetapi.Facet;
 import org.apache.isis.core.metamodel.facetapi.FacetHolder;
 import org.apache.isis.core.metamodel.facets.SingleStringValueFacetAbstract;
 
-public abstract class HelpFacetAbstract extends SingleStringValueFacetAbstract implements HelpFacet {
+public abstract class HelpFacetAbstract
+extends SingleStringValueFacetAbstract
+implements HelpFacet {
 
     private static final Class<? extends Facet> type() {
         return HelpFacet.class;
     }
 
-    public HelpFacetAbstract(final String value, final FacetHolder holder) {
+    protected HelpFacetAbstract(final String value, final FacetHolder holder) {
         super(type(), holder, value);
     }
 
-    public HelpFacetAbstract(final String value, final FacetHolder holder, final Facet.Precedence precedence) {
+    protected HelpFacetAbstract(final String value, final FacetHolder holder, final Facet.Precedence precedence) {
         super(type(), holder, value, precedence);
     }
 
diff --git a/core/metamodel/src/main/java/org/apache/isis/core/metamodel/facets/fallback/FallbackFacetFactory.java b/core/metamodel/src/main/java/org/apache/isis/core/metamodel/facets/fallback/FallbackFacetFactory.java
index 7068ade..655aa06 100644
--- a/core/metamodel/src/main/java/org/apache/isis/core/metamodel/facets/fallback/FallbackFacetFactory.java
+++ b/core/metamodel/src/main/java/org/apache/isis/core/metamodel/facets/fallback/FallbackFacetFactory.java
@@ -84,7 +84,6 @@ public class FallbackFacetFactory extends FacetFactoryAbstract {
         final FacetedMethod facetedMethod = processMethodContext.getFacetHolder();
 
         addFacet(new NamedFacetFallbackFromMemberName(facetedMethod));
-        addFacet(new HelpFacetNone(facetedMethod));
 
         final FeatureType featureType = facetedMethod.getFeatureType();
         if (featureType.isProperty()) {
@@ -109,9 +108,7 @@ public class FallbackFacetFactory extends FacetFactoryAbstract {
 
         final TypedHolder typedHolder = processParameterContext.getFacetHolder();
         if (typedHolder.getFeatureType().isActionParameter()) {
-            addFacet(new HelpFacetNone(typedHolder));
             addFacet(new MultiLineFacetNone(typedHolder));
-
             addFacet(new MaxLengthFacetUnlimited(typedHolder));
 
             addFacet(newPropParamLayoutFacetIfAny(typedHolder, "parameterLayout", getConfiguration().getApplib().getAnnotation().getParameterLayout()));
diff --git a/core/metamodel/src/main/java/org/apache/isis/core/metamodel/facets/fallback/HelpFacetNone.java b/core/metamodel/src/main/java/org/apache/isis/core/metamodel/facets/fallback/HelpFacetNone.java
deleted file mode 100644
index 178a4d1..0000000
--- a/core/metamodel/src/main/java/org/apache/isis/core/metamodel/facets/fallback/HelpFacetNone.java
+++ /dev/null
@@ -1,41 +0,0 @@
-/*
- *  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 agreed to in writing,
- *  software distributed under the License is distributed on an
- *  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- *  KIND, either express or implied.  See the License for the
- *  specific language governing permissions and limitations
- *  under the License.
- */
-package org.apache.isis.core.metamodel.facets.fallback;
-
-import org.apache.isis.core.metamodel.facetapi.FacetHolder;
-import org.apache.isis.core.metamodel.facetapi.HasSemanticEqualityByClass;
-import org.apache.isis.core.metamodel.facets.all.help.HelpFacetAbstract;
-
-/**
- * Has a description of <tt>null</tt>.
- */
-public class HelpFacetNone
-extends HelpFacetAbstract
-implements HasSemanticEqualityByClass {
-
-    public HelpFacetNone(final FacetHolder holder) {
-        super(null, holder, Precedence.FALLBACK);
-    }
-
-    @Override
-    public String value() {
-        return "No help available";
-    }
-
-}