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
020package org.apache.isis.core.progmodel.facets.members.hidden.staticmethod;
021
022import java.lang.reflect.Method;
023
024import org.apache.isis.core.commons.lang.MethodExtensions;
025import org.apache.isis.core.commons.lang.StringExtensions;
026import org.apache.isis.core.metamodel.exceptions.MetaModelException;
027import org.apache.isis.core.metamodel.facetapi.Facet;
028import org.apache.isis.core.metamodel.facetapi.FacetHolder;
029import org.apache.isis.core.metamodel.facetapi.FacetUtil;
030import org.apache.isis.core.metamodel.facetapi.FeatureType;
031import org.apache.isis.core.metamodel.methodutils.MethodScope;
032import org.apache.isis.core.progmodel.facets.MethodFinderUtils;
033import org.apache.isis.core.progmodel.facets.MethodPrefixBasedFacetFactoryAbstract;
034import org.apache.isis.core.progmodel.facets.MethodPrefixConstants;
035
036public 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
042     * noa-architecture (where they exist)
043     */
044    public HiddenFacetViaAlwaysHideMethodFacetFactory() {
045        super(FeatureType.MEMBERS, OrphanValidation.VALIDATE, PREFIXES);
046    }
047
048    // ///////////////////////////////////////////////////////
049    // Actions
050    // ///////////////////////////////////////////////////////
051
052    @Override
053    public void process(final ProcessMethodContext processMethodContext) {
054        // alwaysHideXxx()
055        attachHiddenFacetIfAlwaysHideMethodIsFound(processMethodContext);
056
057    }
058
059    public static void attachHiddenFacetIfAlwaysHideMethodIsFound(final ProcessMethodContext processMethodContext) {
060
061        final Class<?> type = processMethodContext.getCls();
062        final Method method = processMethodContext.getMethod();
063
064        final String capitalizedName = StringExtensions.asJavaBaseNameStripAccessorPrefixIfRequired(method.getName());
065
066        final Method alwaysHideMethod = MethodFinderUtils.findMethod(type, MethodScope.CLASS, MethodPrefixConstants.ALWAYS_HIDE_PREFIX + capitalizedName, boolean.class, new Class[] {});
067        if (alwaysHideMethod == null) {
068            return;
069        }
070
071        processMethodContext.removeMethod(alwaysHideMethod);
072        final Boolean alwaysHideMethodReturnValue = invokeAlwaysHideMethod(alwaysHideMethod);
073        if (!alwaysHideMethodReturnValue.booleanValue()) {
074            return;
075        }
076
077        final FacetHolder facetedMethod = processMethodContext.getFacetHolder();
078        FacetUtil.addFacet(new HiddenFacetAlwaysEverywhere(facetedMethod));
079    }
080
081    private static Boolean invokeAlwaysHideMethod(final Method alwaysHideMethod) {
082        Boolean alwaysHideMethodReturnValue = null;
083        try {
084            alwaysHideMethodReturnValue = (Boolean) MethodExtensions.invokeStatic(alwaysHideMethod);
085        } catch (final ClassCastException ex) {
086            // ignore
087        }
088        if (alwaysHideMethodReturnValue == null) {
089            throw new MetaModelException("method " + alwaysHideMethod + "must return a boolean");
090        }
091        return alwaysHideMethodReturnValue;
092    }
093
094}