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.object.title;
021    
022    import java.lang.reflect.Method;
023    
024    import org.apache.isis.core.commons.lang.JavaClassUtils;
025    import org.apache.isis.core.metamodel.facetapi.FacetHolder;
026    import org.apache.isis.core.metamodel.facetapi.FacetUtil;
027    import org.apache.isis.core.metamodel.facetapi.FeatureType;
028    import org.apache.isis.core.metamodel.methodutils.MethodScope;
029    import org.apache.isis.core.progmodel.facets.MethodFinderUtils;
030    import org.apache.isis.core.progmodel.facets.MethodPrefixBasedFacetFactoryAbstract;
031    import org.apache.isis.core.progmodel.facets.fallback.FallbackFacetFactory;
032    
033    public class TitleMethodFacetFactory extends MethodPrefixBasedFacetFactoryAbstract {
034    
035        private static final String TO_STRING = "toString";
036        private static final String TITLE = "title";
037    
038        private static final String[] PREFIXES = { TO_STRING, TITLE, };
039    
040        public TitleMethodFacetFactory() {
041            super(FeatureType.OBJECTS_ONLY, PREFIXES);
042        }
043    
044        /**
045         * If no title or toString can be used then will use Facets provided by {@link FallbackFacetFactory} instead.
046         */
047        @Override
048        public void process(final ProcessClassContext processClassContext) {
049            final Class<?> cls = processClassContext.getCls();
050            final FacetHolder facetHolder = processClassContext.getFacetHolder();
051    
052            Method method = MethodFinderUtils.findMethod(cls, MethodScope.OBJECT, TITLE, String.class, null);
053            if (method != null) {
054                processClassContext.removeMethod(method);
055                FacetUtil.addFacet(new TitleFacetViaTitleMethod(method, facetHolder));
056                return;
057            }
058    
059            try {
060                method = MethodFinderUtils.findMethod(cls, MethodScope.OBJECT, TO_STRING, String.class, null);
061                if (method == null) {
062                    return;
063                }
064                if (JavaClassUtils.isJavaClass(method.getDeclaringClass())) {
065                    return;
066                }
067                processClassContext.removeMethod(method);
068                FacetUtil.addFacet(new TitleFacetViaToStringMethod(method, facetHolder));
069    
070            } catch (final Exception e) {
071                return;
072            }
073        }
074    }