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.named.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.facets.named.NamedFacet;
032    import org.apache.isis.core.metamodel.methodutils.MethodScope;
033    import org.apache.isis.core.progmodel.facets.MethodFinderUtils;
034    import org.apache.isis.core.progmodel.facets.MethodPrefixBasedFacetFactoryAbstract;
035    import org.apache.isis.core.progmodel.facets.MethodPrefixConstants;
036    
037    /**
038     * Sets up a {@link NamedFacet} if a {@value MethodPrefixConstants#NAME_PREFIX}-prefixed method is present.
039     */
040    public class NamedFacetViaNameMethodFacetFactory extends MethodPrefixBasedFacetFactoryAbstract {
041    
042        private static final String[] PREFIXES = { MethodPrefixConstants.NAME_PREFIX };
043    
044        /**
045         * Note that the {@link Facet}s registered are the generic ones from noa-architecture (where they exist)
046         */
047        public NamedFacetViaNameMethodFacetFactory() {
048            super(FeatureType.MEMBERS, PREFIXES);
049        }
050    
051        // ///////////////////////////////////////////////////////
052        // Actions
053        // ///////////////////////////////////////////////////////
054    
055        @Override
056        public void process(final ProcessMethodContext processMethodContext) {
057    
058            // namedXxx()
059            attachNamedFacetIfNamedMethodIsFound(processMethodContext);
060    
061        }
062    
063        public static void attachNamedFacetIfNamedMethodIsFound(final ProcessMethodContext processMethodContext) {
064            final Method method = processMethodContext.getMethod();
065            final String capitalizedName = NameUtils.javaBaseNameStripAccessorPrefixIfRequired(method.getName());
066    
067            final Class<?> cls = processMethodContext.getCls();
068            final Method nameMethod =
069                MethodFinderUtils.findMethod(cls, MethodScope.CLASS, MethodPrefixConstants.NAME_PREFIX + capitalizedName,
070                    String.class, new Class[0]);
071    
072            if (nameMethod == null) {
073                return;
074            }
075    
076            processMethodContext.removeMethod(nameMethod);
077            final String name = invokeNameMethod(nameMethod);
078    
079            final FacetHolder facetHolder = processMethodContext.getFacetHolder();
080            FacetUtil.addFacet(new NamedFacetViaMethod(name, nameMethod, facetHolder));
081        }
082    
083        private static String invokeNameMethod(final Method nameMethod) {
084            String name = null;
085            try {
086                name = (String) InvokeUtils.invokeStatic(nameMethod);
087            } catch (final ClassCastException e) {
088                // ignore
089            }
090            if (name == null) {
091                throw new MetaModelException("method " + nameMethod + "must return a string");
092            }
093            return name;
094        }
095    
096    }