001 /*
002 * Licensed to the Apache Software Foundation (ASF) under one
003 * or more contributor license agreements. See the NOTICE file
004 * distributed with this work for additional information
005 * regarding copyright ownership. The ASF licenses this file
006 * to you under the Apache License, Version 2.0 (the
007 * "License"); you may not use this file except in compliance
008 * with the License. You may obtain a copy of the License at
009 *
010 * http://www.apache.org/licenses/LICENSE-2.0
011 *
012 * Unless required by applicable law or agreed to in writing,
013 * software distributed under the License is distributed on an
014 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
015 * KIND, either express or implied. See the License for the
016 * specific language governing permissions and limitations
017 * under the License.
018 */
019
020 package org.apache.isis.core.progmodel.facets.members.hide.staticmethod;
021
022 import java.lang.reflect.Method;
023
024 import org.apache.isis.core.commons.lang.NameUtils;
025 import org.apache.isis.core.metamodel.adapter.util.InvokeUtils;
026 import org.apache.isis.core.metamodel.exceptions.MetaModelException;
027 import org.apache.isis.core.metamodel.facetapi.Facet;
028 import org.apache.isis.core.metamodel.facetapi.FacetHolder;
029 import org.apache.isis.core.metamodel.facetapi.FacetUtil;
030 import org.apache.isis.core.metamodel.facetapi.FeatureType;
031 import org.apache.isis.core.metamodel.methodutils.MethodScope;
032 import org.apache.isis.core.progmodel.facets.MethodFinderUtils;
033 import org.apache.isis.core.progmodel.facets.MethodPrefixBasedFacetFactoryAbstract;
034 import org.apache.isis.core.progmodel.facets.MethodPrefixConstants;
035
036 public class HiddenFacetViaAlwaysHideMethodFacetFactory extends MethodPrefixBasedFacetFactoryAbstract {
037
038 private static final String[] PREFIXES = { MethodPrefixConstants.HIDE_PREFIX };
039
040 /**
041 * Note that the {@link Facet}s registered are the generic ones from noa-architecture (where they exist)
042 */
043 public HiddenFacetViaAlwaysHideMethodFacetFactory() {
044 super(FeatureType.MEMBERS, PREFIXES);
045 }
046
047 // ///////////////////////////////////////////////////////
048 // Actions
049 // ///////////////////////////////////////////////////////
050
051 @Override
052 public void process(final ProcessMethodContext processMethodContext) {
053 // alwaysHideXxx()
054 attachHiddenFacetIfAlwaysHideMethodIsFound(processMethodContext);
055
056 }
057
058 public static void attachHiddenFacetIfAlwaysHideMethodIsFound(final ProcessMethodContext processMethodContext) {
059
060 final Class<?> type = processMethodContext.getCls();
061 final Method method = processMethodContext.getMethod();
062
063 final String capitalizedName = NameUtils.javaBaseNameStripAccessorPrefixIfRequired(method.getName());
064
065 final Method alwaysHideMethod =
066 MethodFinderUtils.findMethod(type, MethodScope.CLASS, MethodPrefixConstants.ALWAYS_HIDE_PREFIX
067 + capitalizedName, boolean.class, new Class[] {});
068 if (alwaysHideMethod == null) {
069 return;
070 }
071
072 processMethodContext.removeMethod(alwaysHideMethod);
073 final Boolean alwaysHideMethodReturnValue = invokeAlwaysHideMethod(alwaysHideMethod);
074 if (!alwaysHideMethodReturnValue.booleanValue()) {
075 return;
076 }
077
078 final FacetHolder facetedMethod = processMethodContext.getFacetHolder();
079 FacetUtil.addFacet(new HiddenFacetAlways(facetedMethod));
080 }
081
082 private static Boolean invokeAlwaysHideMethod(final Method alwaysHideMethod) {
083 Boolean alwaysHideMethodReturnValue = null;
084 try {
085 alwaysHideMethodReturnValue = (Boolean) InvokeUtils.invokeStatic(alwaysHideMethod);
086 } catch (final ClassCastException ex) {
087 // ignore
088 }
089 if (alwaysHideMethodReturnValue == null) {
090 throw new MetaModelException("method " + alwaysHideMethod + "must return a boolean");
091 }
092 return alwaysHideMethodReturnValue;
093 }
094
095 }