All Downloads are FREE. Search and download functionalities are using the official Maven repository.

org.apache.webbeans.util.WebBeansUtil Maven / Gradle / Ivy

/*
 * 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.webbeans.util;

import org.apache.webbeans.annotation.AnnotationManager;
import org.apache.webbeans.annotation.NewLiteral;
import org.apache.webbeans.component.AbstractOwbBean;
import org.apache.webbeans.component.AbstractProducerBean;
import org.apache.webbeans.component.BeanAttributesImpl;
import org.apache.webbeans.component.BeanManagerBean;
import org.apache.webbeans.component.BeanMetadataBean;
import org.apache.webbeans.component.ConversationBean;
import org.apache.webbeans.component.DecoratorMetadataBean;
import org.apache.webbeans.component.EnterpriseBeanMarker;
import org.apache.webbeans.component.EventBean;
import org.apache.webbeans.component.ExtensionBean;
import org.apache.webbeans.component.InjectionPointBean;
import org.apache.webbeans.component.InjectionTargetBean;
import org.apache.webbeans.component.InstanceBean;
import org.apache.webbeans.component.InterceptedOrDecoratedBeanMetadataBean;
import org.apache.webbeans.component.InterceptorMetadataBean;
import org.apache.webbeans.component.ManagedBean;
import org.apache.webbeans.component.NewBean;
import org.apache.webbeans.component.NewManagedBean;
import org.apache.webbeans.component.OwbBean;
import org.apache.webbeans.component.ProducerFieldBean;
import org.apache.webbeans.component.ProducerMethodBean;
import org.apache.webbeans.component.ResourceBean;
import org.apache.webbeans.component.WebBeansType;
import org.apache.webbeans.component.creation.BeanAttributesBuilder;
import org.apache.webbeans.component.creation.ExtensionBeanBuilder;
import org.apache.webbeans.component.creation.ManagedBeanBuilder;
import org.apache.webbeans.component.creation.ObserverMethodsBuilder;
import org.apache.webbeans.component.creation.ProducerFieldBeansBuilder;
import org.apache.webbeans.component.creation.ProducerMethodBeansBuilder;
import org.apache.webbeans.config.WebBeansContext;
import org.apache.webbeans.container.BeanManagerImpl;
import org.apache.webbeans.container.InjectionResolver;
import org.apache.webbeans.exception.WebBeansConfigurationException;
import org.apache.webbeans.exception.WebBeansDeploymentException;
import org.apache.webbeans.exception.inject.DefinitionException;
import org.apache.webbeans.exception.inject.InconsistentSpecializationException;
import org.apache.webbeans.inject.AlternativesManager;
import org.apache.webbeans.plugins.PluginLoader;
import org.apache.webbeans.portable.InjectionTargetImpl;
import org.apache.webbeans.portable.ProducerMethodProducer;
import org.apache.webbeans.portable.events.discovery.ErrorStack;
import org.apache.webbeans.portable.events.generics.GProcessAnnotatedType;
import org.apache.webbeans.portable.events.generics.GProcessBean;
import org.apache.webbeans.portable.events.generics.GProcessInjectionTarget;
import org.apache.webbeans.portable.events.generics.GProcessManagedBean;
import org.apache.webbeans.portable.events.generics.GProcessObservableMethod;
import org.apache.webbeans.portable.events.generics.GProcessProducer;
import org.apache.webbeans.portable.events.generics.GProcessProducerField;
import org.apache.webbeans.portable.events.generics.GProcessProducerMethod;
import org.apache.webbeans.portable.events.generics.GProcessSessionBean;
import org.apache.webbeans.spi.plugins.OpenWebBeansEjbPlugin;
import org.apache.webbeans.spi.plugins.OpenWebBeansPlugin;

import javax.decorator.Decorator;
import javax.enterprise.context.Dependent;
import javax.enterprise.context.spi.Contextual;
import javax.enterprise.inject.Alternative;
import javax.enterprise.inject.IllegalProductException;
import javax.enterprise.inject.Instance;
import javax.enterprise.inject.Specializes;
import javax.enterprise.inject.spi.AfterBeanDiscovery;
import javax.enterprise.inject.spi.AfterDeploymentValidation;
import javax.enterprise.inject.spi.AnnotatedField;
import javax.enterprise.inject.spi.AnnotatedMember;
import javax.enterprise.inject.spi.AnnotatedMethod;
import javax.enterprise.inject.spi.AnnotatedType;
import javax.enterprise.inject.spi.Bean;
import javax.enterprise.inject.spi.BeanManager;
import javax.enterprise.inject.spi.BeforeBeanDiscovery;
import javax.enterprise.inject.spi.BeforeShutdown;
import javax.enterprise.inject.spi.Extension;
import javax.enterprise.inject.spi.InjectionPoint;
import javax.enterprise.inject.spi.ObserverMethod;
import javax.enterprise.inject.spi.PassivationCapable;
import javax.enterprise.inject.spi.ProcessAnnotatedType;
import javax.enterprise.inject.spi.ProcessBean;
import javax.enterprise.inject.spi.ProcessInjectionTarget;
import javax.enterprise.inject.spi.ProcessManagedBean;
import javax.enterprise.inject.spi.ProcessObserverMethod;
import javax.enterprise.inject.spi.ProcessProducer;
import javax.enterprise.inject.spi.ProcessProducerField;
import javax.enterprise.inject.spi.ProcessProducerMethod;
import javax.enterprise.inject.spi.ProcessSessionBean;
import javax.enterprise.inject.spi.Producer;
import javax.inject.Inject;
import javax.inject.Named;
import java.io.Serializable;
import java.lang.annotation.Annotation;
import java.lang.reflect.Constructor;
import java.lang.reflect.Field;
import java.lang.reflect.Member;
import java.lang.reflect.Method;
import java.lang.reflect.Modifier;
import java.lang.reflect.ParameterizedType;
import java.lang.reflect.Type;
import java.lang.reflect.TypeVariable;
import java.util.ArrayList;
import java.util.Collections;
import java.util.Comparator;
import java.util.EnumSet;
import java.util.HashMap;
import java.util.HashSet;
import java.util.Iterator;
import java.util.List;
import java.util.Map;
import java.util.Set;

/**
 * Contains some utility methods used in the all project.
 *
 * @version $Rev: 1530644 $ $Date: 2013-10-09 07:44:22 -0700 (Wed, 09 Oct 2013) $
 */
@SuppressWarnings("unchecked")
public final class WebBeansUtil
{
    private final WebBeansContext webBeansContext;

    public WebBeansUtil(WebBeansContext webBeansContext)
    {
        this.webBeansContext = webBeansContext;
    }

    /**
     * Gets current classloader with current thread.
     *
     * @return Current class loader instance
     */
    public static ClassLoader getCurrentClassLoader()
    {
        ClassLoader loader =  Thread.currentThread().getContextClassLoader();

        if (loader == null)
        {
            loader = WebBeansUtil.class.getClassLoader();
        }

        return loader;
    }

    /**
     * Checks the generic type requirements.
     */
    public static void checkGenericType(Class clazz, Class scope)
    {
        Asserts.assertNotNull(clazz);

        if (ClassUtil.isDefinitionContainsTypeVariables(clazz))
        {
            if(!scope.equals(Dependent.class))
            {
                throw new WebBeansConfigurationException("Generic type may only defined with scope @Dependent " +
                        "for ManagedBean class : " + clazz.getName());
            }
        }
    }


    /**
     * Check producer method/field bean return type.
     * @param bean producer bean instance
     * @param member related member instance
     */
    public static void checkProducerGenericType(Bean bean,Member member)
    {
        Asserts.assertNotNull(bean,"Bean is null");

        Type type = null;

        if(bean instanceof ProducerMethodBean)
        {
            type = ((ProducerMethodBean)bean).getCreatorMethod().getGenericReturnType();
        }
        else if(bean instanceof ProducerFieldBean)
        {
            type = ((ProducerFieldBean)bean).getCreatorField().getGenericType();
        }
        else
        {
            throw new IllegalArgumentException("Bean must be Producer Field or Method Bean instance : " + bean);
        }

        String messageTemplate = "Producer Field/Method Bean with name : %s" + 
                         " in bean class : %s"; 

        String memberName = member.getName();
        String declaringClassName = member.getDeclaringClass().getName();
        if(checkGenericForProducers(type, messageTemplate, memberName, declaringClassName))
        {
            if(!bean.getScope().equals(Dependent.class))
            {
                String message = format(messageTemplate, memberName, declaringClassName);
                throw new WebBeansConfigurationException(message + " scope must bee @Dependent");
            }
        }
    }

    /**
     * Check generic types for producer method and fields.
     * @param type generic return type
     * @param messageTemplate error message
     * @return true if parametrized type argument is TypeVariable
     */
    //Helper method
    private static boolean checkGenericForProducers(Type type, String messageTemplate, Object... errorMessageArgs)
    {
        boolean result = false;

        if(type instanceof TypeVariable)
        {
            String message = format(messageTemplate, errorMessageArgs);
            throw new WebBeansConfigurationException(message + " return type can not be type variable");
        }

        if(ClassUtil.isParametrizedType(type))
        {
            Type[] actualTypes = ClassUtil.getActualTypeArguments(type);

            if(actualTypes.length == 0)
            {
                String message = format(messageTemplate, errorMessageArgs);
                throw new WebBeansConfigurationException(message +
                        " return type must define actual type arguments or type variable");
            }

            for(Type actualType : actualTypes)
            {
                if(ClassUtil.isWildCardType(actualType))
                {
                    String message = format(messageTemplate, errorMessageArgs);
                    throw new WebBeansConfigurationException(message +
                            " return type can not define wildcard actual type argument");
                }

                if(ClassUtil.isTypeVariable(actualType))
                {
                    result = true;
                }
            }
        }

        return result;
    }

    /**
     * Returns true if this class can be candidate for simple web bean, false otherwise.
     *
     * @param clazz implementation class
     * @throws WebBeansConfigurationException if any configuration exception occurs
     */
    public void checkManagedBean(Class clazz)
    {
        Asserts.nullCheckForClass(clazz, "Class is null");

        int modifier = clazz.getModifiers();

        if (!Modifier.isStatic(modifier) && ClassUtil.isInnerClazz(clazz))
        {
            throw new WebBeansConfigurationException("Skipping CDI bean detection for non-static inner class: "
                                                     + clazz.getName() );
        }

        if(Extension.class.isAssignableFrom(clazz))
        {
            throw new WebBeansConfigurationException("Skipping CDI bean detection for CDI Extension class"
                                                     + clazz.getName());
        }

        // and finally call all checks which are defined in plugins like JSF, JPA, etc
        List plugins = webBeansContext.getPluginLoader().getPlugins();
        for (OpenWebBeansPlugin plugin : plugins)
        {
            try
            {
                plugin.isManagedBean(clazz);
            }
            catch (Exception e)
            {
                PluginLoader.throwsException(e);
            }
        }
    }

    public void checkManagedBeanCondition(Class clazz) throws WebBeansConfigurationException
    {
        if (AnnotationUtil.hasClassAnnotation(clazz, Decorator.class) && AnnotationUtil.hasClassAnnotation(clazz, javax.interceptor.Interceptor.class))
        {
            throw new WebBeansConfigurationException("ManagedBean implementation class : " + clazz.getName()
                                                     + " may not annotated with both @Interceptor and @Decorator annotation");
        }

        if (!AnnotationUtil.hasClassAnnotation(clazz, Decorator.class) && !AnnotationUtil.hasClassAnnotation(clazz, javax.interceptor.Interceptor.class))
        {
            webBeansContext.getInterceptorUtil().checkSimpleWebBeansInterceptorConditions(clazz);
        }
    }

    /**
     * Returns true if given class supports injections,
     * false otherwise.
     * 

* Each plugin is asked with given class that supports * injections or not. *

* @param clazz scanned class * @return true if given class supports injections */ public boolean supportsJavaEeComponentInjections(Class clazz) { if (clazz.isInterface() || clazz.isAnnotation() || clazz.isEnum()) { // interfaces, annotations and enums are no subject of injection return false; } // and finally call all checks which are defined in plugins like JSF, JPA, etc List plugins = webBeansContext.getPluginLoader().getPlugins(); for (OpenWebBeansPlugin plugin : plugins) { //Ejb plugin handles its own events //Also EJb beans supports injections if(!(plugin instanceof OpenWebBeansEjbPlugin)) { if(plugin.supportsJavaEeComponentInjections(clazz)) { return true; } } else { return ((OpenWebBeansEjbPlugin) plugin).isSessionBean(clazz); } } return false; } /** * Check that simple web beans class has compatible constructor. * @param clazz web beans simple class * @throws WebBeansConfigurationException if the web beans has incompatible * constructor */ public boolean isConstructorOk(Class clazz) throws WebBeansConfigurationException { Asserts.nullCheckForClass(clazz); if (getNoArgConstructor(clazz) != null) { return true; } Constructor[] constructors = webBeansContext.getSecurityService().doPrivilegedGetDeclaredConstructors(clazz); for (Constructor constructor : constructors) { if (constructor.getAnnotation(Inject.class) != null) { return true; } } return false; } public Bean createNewComponent(Class type) { Asserts.nullCheckForClass(type); final OpenWebBeansEjbPlugin ejbPlugin = webBeansContext.getPluginLoader().getEjbPlugin(); if (ejbPlugin != null && ejbPlugin.isNewSessionBean(type)) { return ejbPlugin.defineNewSessionBean(type); } AnnotatedType annotatedType = webBeansContext.getAnnotatedElementFactory().newAnnotatedType(type); BeanAttributesImpl defaultBeanAttributes = BeanAttributesBuilder.forContext(webBeansContext).newBeanAttibutes(annotatedType).build(); BeanAttributesImpl newBeanAttributes = new BeanAttributesImpl(defaultBeanAttributes.getTypes(), Collections.singleton(new NewLiteral(type))); // TODO replace this by InjectionPointBuilder ManagedBeanBuilder> beanBuilder = new ManagedBeanBuilder>(webBeansContext, annotatedType, newBeanAttributes); NewManagedBean newBean = new NewManagedBean(webBeansContext, WebBeansType.MANAGED, annotatedType, newBeanAttributes, type, beanBuilder.getBean().getInjectionPoints()); return newBean; } /** * New WebBeans component class. * * @return the new component */ public NewManagedBean createNewComponent(OwbBean bean, Class type) { Asserts.assertNotNull(bean, "bean may not be null"); if (!EnumSet.of(WebBeansType.MANAGED, WebBeansType.ENTERPRISE, WebBeansType.PRODUCERMETHOD, WebBeansType.PRODUCERFIELD).contains(bean.getWebBeansType())) { throw new WebBeansConfigurationException("@New annotation on type : " + bean.getBeanClass() + " must defined as a simple or an enterprise web bean"); } AnnotatedType annotatedType = webBeansContext.getAnnotatedElementFactory().newAnnotatedType(type); BeanAttributesImpl newBeanAttributes = new BeanAttributesImpl(bean.getTypes(), Collections.singleton(new NewLiteral(type))); NewManagedBean newBean = new NewManagedBean(bean.getWebBeansContext(), bean.getWebBeansType(), annotatedType, newBeanAttributes, type, bean.getInjectionPoints()); //TODO XXX set producer return newBean; } /** * Creates a new extension bean. * * @param extension service class * @param clazz impl. class * @return a new extension service bean */ public ExtensionBean createExtensionComponent(Class clazz) { Asserts.nullCheckForClass(clazz); ExtensionBeanBuilder extensionBeanBuilder = new ExtensionBeanBuilder(webBeansContext, clazz); ExtensionBean bean = extensionBeanBuilder.getBean(); new ObserverMethodsBuilder>(webBeansContext, extensionBeanBuilder.getAnnotatedType()).defineObserverMethods(bean); return bean; } /** * Creates a new manager bean instance. * @return new manager bean instance */ public BeanManagerBean getManagerBean() { return new BeanManagerBean(webBeansContext); } /** * Creates a new instance bean. * @return new instance bean */ public InstanceBean getInstanceBean() { return new InstanceBean(webBeansContext); } /** * Creates a new event bean. * @return new event bean */ public EventBean getEventBean() { return new EventBean(webBeansContext); } /** * Creates a new bean metadata bean. * @return new bean */ public BeanMetadataBean getBeanMetadataBean() { return new BeanMetadataBean(webBeansContext); } /** * Creates a new interceptor metadata bean. * @return new bean */ public InterceptorMetadataBean getInterceptorMetadataBean() { return new InterceptorMetadataBean(webBeansContext); } /** * Creates a new decorator metadata bean. * @return new bean */ public DecoratorMetadataBean getDecoratorMetadataBean() { return new DecoratorMetadataBean(webBeansContext); } /** * Creates a new metadata bean. * @return new bean */ public InterceptedOrDecoratedBeanMetadataBean getInterceptedOrDecoratedBeanMetadataBean() { return new InterceptedOrDecoratedBeanMetadataBean(webBeansContext); } /** * Returns new conversation bean instance. * The name is explicitly specified in 6.7.2 and is not the normal default name. * @return new conversation bean */ public ConversationBean getConversationBean() { ConversationBean conversationComp = new ConversationBean(webBeansContext); return conversationComp; } /** * Returns a new injected point bean instance. * @return new injected point bean */ public InjectionPointBean getInjectionPointBean() { return new InjectionPointBean(webBeansContext); } public static String getManagedBeanDefaultName(String clazzName) { Asserts.assertNotNull(clazzName); if(clazzName.length() > 0) { StringBuilder name = new StringBuilder(clazzName); name.setCharAt(0, Character.toLowerCase(name.charAt(0))); return name.toString(); } return clazzName; } public static String getProducerDefaultName(String methodName) { StringBuilder buffer = new StringBuilder(methodName); if (buffer.length() > 3 && (buffer.substring(0, 3).equals("get") || buffer.substring(0, 3).equals("set"))) { if(Character.isUpperCase(buffer.charAt(3))) { buffer.setCharAt(3, Character.toLowerCase(buffer.charAt(3))); } return buffer.substring(3); } else if ((buffer.length() > 2 && buffer.substring(0, 2).equals("is"))) { if(Character.isUpperCase(buffer.charAt(2))) { buffer.setCharAt(2, Character.toLowerCase(buffer.charAt(2))); } return buffer.substring(2); } else { buffer.setCharAt(0, Character.toLowerCase(buffer.charAt(0))); return buffer.toString(); } } /** * Return true if a list of beans are directly specialized/extended each other. * * @param beans, a set of specialized beans. * * @return */ protected static boolean isDirectlySpecializedBeanSet(Set> beans) { ArrayList> beanList = new ArrayList>(); for(Bean bb : beans) { AbstractOwbBeanbean = (AbstractOwbBean)bb; beanList.add(bean); } java.util.Collections.sort(beanList, new java.util.Comparator() { @Override public int compare(Object o1, Object o2) { AbstractOwbBean b1 = (AbstractOwbBean)o1; AbstractOwbBean b2 = (AbstractOwbBean)o2; Class c1 = b1.getReturnType(); Class c2 = b2.getReturnType(); if (c2.isAssignableFrom(c1)) { return 1; } if (c1.isAssignableFrom(c2)) { return -1; } throw new InconsistentSpecializationException(c1 + " and " + c2 + "are not assignable to each other." ); } }); for(int i=0; i> beanClasses) { for(Class clazz : beanClasses) { configureSpecializations(clazz, beanClasses); } } /** * Configures the bean specializations. *

* Specialized beans inherit the name property * from their parents. Specialized bean deployment priority * must be higher than its super class related bean. *

* *

from the spec:
* "If Y has a name and X declares a name explicitly, using @Named, * the container automatically detects the problem and treats it as a definition error.

* * @param specializedClass specialized class * @param beanClasses all Classes which are either @Specializes or specialized. * @throws DefinitionException if name is defined * @throws InconsistentSpecializationException related with priority * @throws WebBeansConfigurationException any other exception */ protected void configureSpecializations(Class specializedClass, List> beanClasses) { Asserts.nullCheckForClass(specializedClass); Bean superBean = null; Bean specialized; Set> resolvers = isConfiguredWebBeans(specializedClass, true); AlternativesManager altManager = webBeansContext.getAlternativesManager(); if (resolvers != null && !resolvers.isEmpty()) { specialized = resolvers.iterator().next(); if(resolvers.size() > 1) { if (!isDirectlySpecializedBeanSet(resolvers)) { throw new InconsistentSpecializationException("More than one specialized bean for class : " + specializedClass + " is enabled in the deployment."); } // find the widest bean which satisfies the specializedClass for( Bean sp : resolvers) { if (sp == specialized) { continue; } if (sp.getTypes().size() > specialized.getTypes().size() && sp.getTypes().containsAll(specialized.getTypes())) { specialized = sp; } } } Class superClass = specializedClass.getSuperclass(); resolvers = isConfiguredWebBeans(superClass,false); for(Bean candidates : resolvers) { AbstractOwbBean candidate = (AbstractOwbBean)candidates; if(!(candidate instanceof NewBean)) { if(candidate.getReturnType().equals(superClass)) { superBean = candidates; break; } } } if (superBean != null) { for (Class beanClass: beanClasses) { if (beanClass.equals(specializedClass)) { continue; } if (beanClass.getSuperclass().equals(superClass)) { InconsistentSpecializationException exception = new InconsistentSpecializationException(superClass.getName() + " is @Specialized by two classes: " + beanClass.getName() + " and " + specializedClass.getName()); throw new WebBeansDeploymentException(exception); } } if (!specialized.getTypes().containsAll(superBean.getTypes())) { throw new DefinitionException("@Specialized Class : " + specializedClass.getName() + " must have all bean types of its super class"); } webBeansContext.getBeanManagerImpl().getNotificationManager().disableOverriddenObservers(superClass); // Recursively configure super class first if super class is also a special bean. // So the name and bean meta data could be populated to this beanclass. if (beanClasses.contains(superClass) && ((AbstractOwbBean)superBean).isEnabled()) { configureSpecializations(superClass, beanClasses); } if (!AnnotationUtil.hasClassAnnotation(specializedClass, Alternative.class)) { //disable superbean if the current bean is not an alternative ((AbstractOwbBean)superBean).setEnabled(false); } else if(altManager.isClassAlternative(specializedClass)) { //disable superbean if the current bean is an enabled alternative ((AbstractOwbBean)superBean).setEnabled(false); } AbstractOwbBean comp = (AbstractOwbBean)specialized; if (comp.isSpecializedBean()) { // This comp is already configured in previous invocation // return directly, else Exception might be fired when set // bean name again. return; } //Check types of the beans if(comp.getClass() != superBean.getClass()) { throw new InconsistentSpecializationException("@Specialized Class : " + specializedClass.getName() + " and its super class may be the same type of bean,i.e, ManagedBean, SessionBean etc."); } if(superBean.getName() != null) { if (!superBean.getName().equals(comp.getName())) { throw new InconsistentSpecializationException("@Specialized Class : " + specializedClass.getName() + " may not explicitly declare a bean name"); } } comp.setSpecializedBean(true); final Map, ProducerMethodBean> parentProducers = new HashMap, ProducerMethodBean>(); final Map, ProducerMethodBean> beanProducers = new HashMap, ProducerMethodBean>(); for (Bean bean: webBeansContext.getBeanManagerImpl().getComponents()) { if (bean instanceof ProducerMethodBean) { final ProducerMethodBean producerBean = (ProducerMethodBean)bean; final Class returnType = producerBean.getReturnType(); if (producerBean.getBeanClass() == superBean.getBeanClass() && producerBean.getProducer() instanceof ProducerMethodProducer) { final ProducerMethodProducer producer = (ProducerMethodProducer) producerBean.getProducer(); producer.specializeBy((Bean) comp); if (beanProducers.keySet().contains(returnType)) { beanProducers.get(returnType).setSpecializedBean(true); } else { parentProducers.put(returnType, producerBean); } } else if (specializedClass == bean.getBeanClass()) { if (parentProducers.keySet().contains(returnType)) { producerBean.setSpecializedBean(true); } else { beanProducers.put(returnType, producerBean); } } } } } else { throw new DefinitionException("WebBean component class : " + specializedClass.getName() + " is not enabled for specialized by the " + specializedClass + " class"); } } } /** * Configure a list of producer method beans, which override the same method * and the bean classes are directly extended each other. * * @param sortedProducerBeans */ protected void configSpecializedProducerMethodBeans(List sortedProducerBeans) { if (sortedProducerBeans.isEmpty()) { return; } AlternativesManager altManager = webBeansContext.getAlternativesManager(); Method superMethod = sortedProducerBeans.get(0).getCreatorMethod(); for(int i=1; i> beans = webBeansContext.getBeanManagerImpl().getBeans(); List producerBeans = new ArrayList(); for(Bean b : beans) { if (b instanceof ProducerMethodBean) { producerBeans.add((ProducerMethodBean)b); } } // create sorted bean helper. SortedListHelper producerBeanListHelper = new SortedListHelper(new ArrayList(), new Comparator () { @Override public int compare(ProducerMethodBean e1, ProducerMethodBean e2) { if (e1.getBeanClass().isAssignableFrom(e2.getBeanClass())) { return -1; } else if (e1.equals(e2)) { return 0; } return 1; } }); while(true) { pbean = null; method = null; producerBeanListHelper.clear(); //locate a specialized bean for(ProducerMethodBean pb : producerBeans) { if (pb.isSpecializedBean()) { pbean = pb; method = pb.getCreatorMethod(); producerBeanListHelper.add(pb); break; } } if (pbean == null) { break; } pRight = pbean; pLeft = pRight; boolean pLeftContinue = true; boolean pRightContinue = true; // find all pbean's super beans and sub sub beans while(pLeftContinue || pRightContinue) { pRightContinue = false; pLeftContinue = false; for(ProducerMethodBean pb : producerBeans) { //left if (pLeft!= null && pLeft.getBeanClass().getSuperclass().equals(pb.getBeanClass())) { Method superMethod = webBeansContext.getSecurityService().doPrivilegedGetDeclaredMethod(pb.getBeanClass(), method.getName(), method.getParameterTypes()); //Added by GE, method check is necessary otherwise getting wrong method qualifier annotations if (superMethod != null && superMethod.equals(pb.getCreatorMethod())) { producerBeanListHelper.add(pb); pLeft = (pb.isSpecializedBean()) ? pb : null; } else { pLeft = null; } if (pLeft != null) { pLeftContinue = true; } } //right if (pRight != null && pb.getBeanClass().getSuperclass().equals(pRight.getBeanClass())) { if (!pb.isSpecializedBean()) { pRight = null; } else { Method superMethod = webBeansContext.getSecurityService().doPrivilegedGetDeclaredMethod(pb.getBeanClass(), method.getName(), method.getParameterTypes()); //Added by GE, method check is necessary otherwise getting wrong method qualifier annotations if (superMethod != null && superMethod.equals(pb.getCreatorMethod())) { producerBeanListHelper.add(pb); pRight = pb; } else { pRight = null; } } if (pRight != null) { pRightContinue = true; } } } // for } // while //remove the group from producer bean list for(ProducerMethodBean pb : producerBeanListHelper.getList()) { producerBeans.remove(pb); } //configure the directly extended producer beans configSpecializedProducerMethodBeans(producerBeanListHelper.getList()); } } public Set> isConfiguredWebBeans(Class clazz,boolean annotate) { Asserts.nullCheckForClass(clazz); Set> beans = new HashSet>(); Set> components = webBeansContext.getBeanManagerImpl().getComponents(); Iterator> it = components.iterator(); while (it.hasNext()) { AbstractOwbBean bean = (AbstractOwbBean)it.next(); if (bean.getTypes().contains(clazz) || (EnterpriseBeanMarker.class.isInstance(bean) && bean.getBeanClass().isAssignableFrom(clazz))) { if(annotate) { if(bean.getReturnType().isAnnotationPresent(Specializes.class)) { if(!(bean instanceof NewBean)) { beans.add(bean); } } } else { beans.add(bean); } } } return beans; } public Constructor getNoArgConstructor(Class clazz) { return webBeansContext.getSecurityService().doPrivilegedGetDeclaredConstructor(clazz); } /** * Configures the name of the producer method for specializing the parent. * * @param component producer method component * @param method specialized producer method * @param superMethod overriden super producer method */ public boolean isSuperMethodNamed(AbstractOwbBean component, Method method, Method superMethod) { return webBeansContext.getAnnotationManager().isSuperMethodNamed(component, method, superMethod); } /** * Returns true if instance injection point false otherwise. * * @param injectionPoint injection point definition * @return true if instance injection point */ public static boolean checkObtainsInjectionPointConditions(InjectionPoint injectionPoint) { Type type = injectionPoint.getType(); Class candidateClazz = ClassUtil.getClass(type); if(!candidateClazz.isAssignableFrom(Instance.class)) { return false; } Class rawType; if(ClassUtil.isParametrizedType(injectionPoint.getType())) { ParameterizedType pt = (ParameterizedType)injectionPoint.getType(); rawType = (Class) pt.getRawType(); Type[] typeArgs = pt.getActualTypeArguments(); if(!(rawType.isAssignableFrom(Instance.class))) { throw new WebBeansConfigurationException(" field injection " + injectionPoint.toString() + " must have type javax.inject.Instance"); } else { if(typeArgs.length != 1) { throw new WebBeansConfigurationException(" field injection " + injectionPoint.toString() + " must not have more than one actual type argument"); } } } else { throw new WebBeansConfigurationException(" field injection " + injectionPoint.toString() + " must be defined as ParameterizedType with one actual type argument"); } return true; } public static void checkNullInstance(Object instance, Class scopeType, String errorMessage, Object... errorMessageArgs) { if (instance == null) { if (!scopeType.equals(Dependent.class)) { String message = format(errorMessage, errorMessageArgs); throw new IllegalProductException(message); } } } public void checkSerializableScopeType(Class scopeType, boolean isSerializable, String errorMessage, Object... errorMessageArgs) { if (webBeansContext.getBeanManagerImpl().isPassivatingScope(scopeType)) { if (!isSerializable) { String message = format(errorMessage, errorMessageArgs); throw new IllegalProductException(message); } } } public static Bean getMostSpecializedBean(BeanManager manager, Bean component) { Set> beans; if (component instanceof EnterpriseBeanMarker) { beans = new HashSet>(); Set> allBeans = manager.getBeans(Object.class, AnnotationUtil.asArray(component.getQualifiers())); for(Bean candidateBean : allBeans) { if (candidateBean instanceof EnterpriseBeanMarker) { /* * If a bean class of a session bean X is annotated @Specializes, then the bean class of X must directly extend * the bean class of another session bean Y. Then X directly specializes Y, as defined in Section 4.3, ‚"Specialization". */ Class candidateSuperClass = candidateBean.getBeanClass().getSuperclass(); if (candidateSuperClass.equals(component.getBeanClass())) { beans.add(candidateBean); } } } } else { beans = manager.getBeans(component.getBeanClass(), AnnotationUtil.asArray(component.getQualifiers())); } for(Bean bean : beans) { Bean find = bean; if(!find.equals(component)) { if(AnnotationUtil.hasClassAnnotation(find.getBeanClass(), Specializes.class)) { return getMostSpecializedBean(manager, find); } } } return component; } /** * Returns ProcessAnnotatedType event. * @param bean type * @param annotatedType bean class * @return event */ public GProcessAnnotatedType fireProcessAnnotatedTypeEvent(AnnotatedType annotatedType) { GProcessAnnotatedType processAnnotatedEvent = new GProcessAnnotatedType(annotatedType); //Fires ProcessAnnotatedType webBeansContext.getBeanManagerImpl().fireEvent(processAnnotatedEvent,AnnotationUtil.EMPTY_ANNOTATION_ARRAY); if (processAnnotatedEvent.isModifiedAnnotatedType()) { webBeansContext.getAnnotatedElementFactory().setAnnotatedType(processAnnotatedEvent.getAnnotatedType()); } return processAnnotatedEvent; } /** * Returns ProcessInjectionTarget event. * @param bean type * @return event */ public GProcessInjectionTarget fireProcessInjectionTargetEvent(InjectionTargetImpl injectionTarget, AnnotatedType annotatedType) { final GProcessInjectionTarget processInjectionTargetEvent = new GProcessInjectionTarget(injectionTarget, annotatedType); return fireProcessInjectionTargetEvent(processInjectionTargetEvent); } private GProcessInjectionTarget fireProcessInjectionTargetEvent(GProcessInjectionTarget processInjectionTargetEvent) { //Fires ProcessInjectionTarget webBeansContext.getBeanManagerImpl().fireEvent(processInjectionTargetEvent, AnnotationUtil.EMPTY_ANNOTATION_ARRAY); return processInjectionTargetEvent; } /** * Returns ProcessInjectionTarget event. * @param bean type * @return event */ public GProcessInjectionTarget fireProcessInjectionTargetEventForJavaEeComponents(Class componentClass) { final AnnotatedType annotatedType = webBeansContext.getAnnotatedElementFactory().newAnnotatedType(componentClass); final InjectionTargetImpl injectionTarget = InjectionTargetImpl.class.cast(webBeansContext.getBeanManagerImpl().createInjectionTarget(annotatedType)); final GProcessInjectionTarget processInjectionTargetEvent = new GProcessInjectionTarget(injectionTarget,annotatedType); //Fires ProcessInjectionTarget return fireProcessInjectionTargetEvent(processInjectionTargetEvent); } public Producer fireProcessProducerEvent(Producer producer, AnnotatedMember annotatedMember) { GProcessProducer processProducerEvent = new GProcessProducer(producer, annotatedMember); //Fires ProcessProducer webBeansContext.getBeanManagerImpl().fireEvent(processProducerEvent, AnnotationUtil.EMPTY_ANNOTATION_ARRAY); webBeansContext.getWebBeansUtil().inspectErrorStack("There are errors that are added by ProcessProducer event observers. Look at logs for further details"); return processProducerEvent.getProducer(); } public void fireProcessProducerMethodBeanEvent(Map, AnnotatedMethod> annotatedMethods, AnnotatedType annotatedType) { WebBeansContext webBeansContext = this.webBeansContext; AnnotationManager annotationManager = webBeansContext.getAnnotationManager(); for(Map.Entry, AnnotatedMethod> beanEntry : annotatedMethods.entrySet()) { ProducerMethodBean bean = beanEntry.getKey(); AnnotatedMethod annotatedMethod = beanEntry.getValue(); Annotation[] annotationsFromSet = AnnotationUtil.asArray(bean.getQualifiers()); Method disposal = annotationManager.getDisposalWithGivenAnnotatedMethod(annotatedType, bean.getReturnType(), annotationsFromSet); AnnotatedMethod disposalAnnotated = null; GProcessProducerMethod processProducerMethodEvent = null; if(disposal != null) { disposalAnnotated = webBeansContext.getAnnotatedElementFactory().newAnnotatedMethod(disposal, annotatedType); processProducerMethodEvent = new GProcessProducerMethod(bean,annotatedMethod, disposalAnnotated.getParameters().get(0)); } else { processProducerMethodEvent = new GProcessProducerMethod(bean,annotatedMethod,null); } //Fires ProcessProducer webBeansContext.getBeanManagerImpl().fireEvent(processProducerMethodEvent, AnnotationUtil.EMPTY_ANNOTATION_ARRAY); } } public void fireProcessObservableMethodBeanEvent(Map,AnnotatedMethod> annotatedMethods) { for(Map.Entry, AnnotatedMethod> observableMethodEntry : annotatedMethods.entrySet()) { ObserverMethod observableMethod = observableMethodEntry.getKey(); AnnotatedMethod annotatedMethod = observableMethodEntry.getValue(); GProcessObservableMethod event = new GProcessObservableMethod(annotatedMethod, observableMethod); //Fires ProcessProducer webBeansContext.getBeanManagerImpl().fireEvent(event, AnnotationUtil.EMPTY_ANNOTATION_ARRAY); } } public void fireProcessProducerFieldBeanEvent(Map,AnnotatedField> annotatedFields) { for(Map.Entry, AnnotatedField> beanEntry : annotatedFields.entrySet()) { ProducerFieldBean bean = beanEntry.getKey(); AnnotatedField field = beanEntry.getValue(); GProcessProducerField processProducerFieldEvent = new GProcessProducerField(bean, field, null); //Fire ProcessProducer webBeansContext.getBeanManagerImpl().fireEvent(processProducerFieldEvent, AnnotationUtil.EMPTY_ANNOTATION_ARRAY); } } public static void checkInjectionPointNamedQualifier(InjectionPoint injectionPoint) { Set qualifierset = injectionPoint.getQualifiers(); Named namedQualifier = null; for(Annotation qualifier : qualifierset) { if(qualifier.annotationType().equals(Named.class)) { namedQualifier = (Named)qualifier; break; } } if(namedQualifier != null) { String value = namedQualifier.value(); if(value == null || value.equals("")) { Member member = injectionPoint.getMember(); if(!(member instanceof Field)) { throw new WebBeansConfigurationException("Injection point type : " + injectionPoint + " can not define @Named qualifier without value!"); } } } } /** * Sets bean enabled flag. * @param bean bean instance */ public void setInjectionTargetBeanEnableFlag(InjectionTargetBean bean) { bean.setEnabled(isBeanEnabled(bean.getAnnotatedType(), bean.getStereotypes())); } public boolean isBeanEnabled(AnnotatedType at, Set> stereotypes) { boolean isAlternative = hasInjectionTargetBeanAnnotatedWithAlternative(at, stereotypes); return !isAlternative || webBeansContext.getAlternativesManager().isAlternative(at.getJavaClass(), stereotypes); } public static boolean hasInjectionTargetBeanAnnotatedWithAlternative(InjectionTargetBean bean) { return hasInjectionTargetBeanAnnotatedWithAlternative(bean.getAnnotatedType(), bean.getStereotypes()); } public static boolean hasInjectionTargetBeanAnnotatedWithAlternative(AnnotatedType beanType, Set> stereotypes) { Asserts.assertNotNull(beanType, "bean type can not be null"); Asserts.assertNotNull(stereotypes, "stereotypes can not be null"); boolean alternative = false; if(beanType.getAnnotation(Alternative.class) != null) { alternative = true; } if(!alternative) { for(Class stereoType : stereotypes) { if(AnnotationUtil.hasClassAnnotation(stereoType, Alternative.class)) { alternative = true; break; } } } return alternative; } public void setBeanEnableFlagForProducerBean(InjectionTargetBean parent, AbstractProducerBean producer, Annotation[] annotations) { Asserts.assertNotNull(parent, "parent can not be null"); Asserts.assertNotNull(producer, "producer can not be null"); producer.setEnabled(isProducerBeanEnabled(parent, producer.getStereotypes(), annotations)); } public boolean isProducerBeanEnabled(InjectionTargetBean parent, Set> stereotypes, Annotation[] annotations) { boolean alternative = false; if (AnnotationUtil.hasAnnotation(annotations, Alternative.class)) { alternative = true; } if (!alternative) { for (Class stereoType : stereotypes) { if (AnnotationUtil.hasClassAnnotation(stereoType, Alternative.class)) { alternative = true; break; } } } if (alternative) { return hasInjectionTargetBeanAnnotatedWithAlternative(parent) && webBeansContext.getAlternativesManager().isBeanHasAlternative(parent); } else { return parent.isEnabled(); } } public static boolean isExtensionEventType(Type type) { return type.equals(BeforeBeanDiscovery.class) || type.equals(AfterBeanDiscovery.class) || type.equals(AfterDeploymentValidation.class) || type.equals(BeforeShutdown.class) || type.equals(GProcessAnnotatedType.class) || type.equals(GProcessInjectionTarget.class) || type.equals(GProcessProducer.class) || type.equals(GProcessProducerField.class) || type.equals(GProcessProducerMethod.class) || type.equals(GProcessManagedBean.class) || type.equals(GProcessBean.class) || type.equals(GProcessSessionBean.class) || type.equals(GProcessObservableMethod.class); } public static boolean isExtensionBeanEventType(Type type) { return type.equals(GProcessAnnotatedType.class) || type.equals(GProcessInjectionTarget.class) || type.equals(GProcessManagedBean.class) || type.equals(GProcessSessionBean.class) || type.equals(GProcessBean.class); } public static boolean isDefaultExtensionBeanEventType(Class clazz) { return clazz.equals(ProcessAnnotatedType.class) || clazz.equals(ProcessInjectionTarget.class) || clazz.equals(ProcessManagedBean.class) || clazz.equals(ProcessBean.class) || clazz.equals(ProcessSessionBean.class); } public static boolean isExtensionProducerOrObserverEventType(Type type) { return type.equals(GProcessProducer.class) || type.equals(GProcessProducerField.class) || type.equals(GProcessProducerMethod.class) || type.equals(GProcessObservableMethod.class); } public static boolean isDefaultExtensionProducerOrObserverEventType(Class clazz) { return clazz.equals(ProcessProducer.class) || clazz.equals(ProcessProducerField.class) || clazz.equals(ProcessProducerMethod.class) || clazz.equals(ProcessObserverMethod.class); } public static boolean isDependent(Bean bean) { if(!(bean instanceof OwbBean)) { return bean.getScope().equals(Dependent.class); } return ((OwbBean) bean).isDependent(); } public void inspectErrorStack(String logMessage) { BeanManagerImpl manager = webBeansContext.getBeanManagerImpl(); //Looks for errors ErrorStack stack = manager.getErrorStack(); try { if(stack.hasErrors()) { stack.logErrors(); throw new WebBeansConfigurationException(logMessage); } } finally { stack.clear(); } } /** * * @param contextual the {@link Bean} to check * @return the uniqueId if it is {@link PassivationCapable} and enabled */ public static String getPassivationId(Contextual contextual) { if(contextual instanceof Bean) { if(contextual instanceof AbstractOwbBean) { if( ((AbstractOwbBean)contextual).isPassivationCapable()) { return ((AbstractOwbBean)contextual).getId(); } } else if(contextual instanceof PassivationCapable) { PassivationCapable pc = (PassivationCapable)contextual; return pc.getId(); } } else { if((contextual instanceof PassivationCapable) && (contextual instanceof Serializable)) { PassivationCapable pc = (PassivationCapable)contextual; return pc.getId(); } } return null; } /** * This method will be used in {@link AfterBeanDiscovery#addBean(javax.enterprise.inject.spi.Bean)}} */ public ManagedBean defineManagedBeanWithoutFireEvents(AnnotatedType type) { BeanAttributesImpl beanAttributes = BeanAttributesBuilder.forContext(webBeansContext).newBeanAttibutes(type).build(); ManagedBeanBuilder> managedBeanCreator = new ManagedBeanBuilder>(webBeansContext, type, beanAttributes); //Check for Enabled via Alternative setInjectionTargetBeanEnableFlag(managedBeanCreator.getBean()); ManagedBean managedBean = managedBeanCreator.getBean(); new ProducerMethodBeansBuilder(managedBean.getWebBeansContext(), managedBean.getAnnotatedType()).defineProducerMethods(managedBean); new ProducerFieldBeansBuilder(managedBean.getWebBeansContext(), managedBean.getAnnotatedType()).defineProducerFields(managedBean); new ObserverMethodsBuilder>(webBeansContext, managedBean.getAnnotatedType()).defineObserverMethods(managedBean); if (managedBean instanceof InjectionTargetBean) { ((InjectionTargetBean) managedBean).defineBeanInterceptorStack(); } return managedBean; } public boolean isPassivationCapableDependency(InjectionPoint injectionPoint) { //Don't attempt to get an instance of the delegate injection point if (injectionPoint.isDelegate()) { return true; } InjectionResolver instance = webBeansContext.getBeanManagerImpl().getInjectionResolver(); Bean bean = instance.getInjectionPointBean(injectionPoint); if((bean instanceof EnterpriseBeanMarker) || (bean instanceof ResourceBean) || (bean instanceof InstanceBean) || (bean instanceof EventBean) || (bean instanceof InjectionPointBean) || (bean instanceof BeanManagerBean) ) { return true; } else if(webBeansContext.getBeanManagerImpl().isNormalScope(bean.getScope())) { return true; } else { if(getPassivationId(bean) != null) { return true; } } return false; } public static void throwRuntimeExceptions(Exception e) { if(RuntimeException.class.isAssignableFrom(e.getClass())) { throw (RuntimeException)e; } throw new RuntimeException(e); } /** * @return true if this annotated type represents a decorator. */ public static boolean isDecorator(AnnotatedType annotatedType) { return annotatedType.isAnnotationPresent(Decorator.class); } /** * Return true if this annotated type represents a decorator. * @param annotatedType annotated type * @return true if decorator */ public boolean isAnnotatedTypeDecoratorOrInterceptor(AnnotatedType annotatedType) { if(isDecorator(annotatedType) || isCdiInterceptor(annotatedType)) { return true; } else if(webBeansContext.getInterceptorsManager().isInterceptorClassEnabled(annotatedType.getJavaClass())) { return true; } else if(webBeansContext.getDecoratorsManager().isDecoratorEnabled(annotatedType.getJavaClass())) { return true; } return false; } /** * @return true if this AnnotatedType represents a CDI Interceptor * defined via a {@link javax.interceptor.Interceptor} annotation */ public static boolean isCdiInterceptor(AnnotatedType annotatedType) { return annotatedType.isAnnotationPresent(javax.interceptor.Interceptor.class); } public ManagedBean defineManagedBean(AnnotatedType type) { BeanAttributesImpl beanAttributes = BeanAttributesBuilder.forContext(webBeansContext).newBeanAttibutes(type).build(); ManagedBeanBuilder> managedBeanCreator = new ManagedBeanBuilder>(webBeansContext, type, beanAttributes); //Check for Enabled via Alternative ManagedBean managedBean = managedBeanCreator.getBean(); new ProducerMethodBeansBuilder(managedBean.getWebBeansContext(), managedBean.getAnnotatedType()).defineProducerMethods(managedBean); new ProducerFieldBeansBuilder(managedBean.getWebBeansContext(), managedBean.getAnnotatedType()).defineProducerFields(managedBean); new ObserverMethodsBuilder>(webBeansContext, managedBean.getAnnotatedType()).defineObserverMethods(managedBean); if (managedBean instanceof InjectionTargetBean) { ((InjectionTargetBean) managedBean).defineBeanInterceptorStack(); } return managedBean; } /** * Checks the implementation class for checking conditions. * * @param type implementation class * @throws org.apache.webbeans.exception.WebBeansConfigurationException if any configuration exception occurs */ public void checkManagedBeanCondition(AnnotatedType type) throws WebBeansConfigurationException { int modifier = type.getJavaClass().getModifiers(); if (type.isAnnotationPresent(Decorator.class) && type.isAnnotationPresent(javax.interceptor.Interceptor.class)) { throw new WebBeansConfigurationException("Annotated type "+ type + " may not annotated with both @Interceptor and @Decorator annotation"); } if (!type.isAnnotationPresent(Decorator.class) && !type.isAnnotationPresent(javax.interceptor.Interceptor.class)) { checkManagedWebBeansInterceptorConditions(type); } if (Modifier.isInterface(modifier)) { throw new WebBeansConfigurationException("ManagedBean implementation class : " + type.getJavaClass().getName() + " may not defined as interface"); } } private void checkManagedWebBeansInterceptorConditions(AnnotatedType type) { Annotation[] anns = AnnotationUtil.asArray(type.getAnnotations()); Class clazz = type.getJavaClass(); boolean hasClassInterceptors = false; AnnotationManager annotationManager = webBeansContext.getAnnotationManager(); if (annotationManager.getInterceptorBindingMetaAnnotations(anns).length > 0) { hasClassInterceptors = true; } else { Annotation[] stereoTypes = annotationManager.getStereotypeMetaAnnotations(anns); for (Annotation stero : stereoTypes) { if (annotationManager.hasInterceptorBindingMetaAnnotation(stero.annotationType().getDeclaredAnnotations())) { hasClassInterceptors = true; break; } } } if(Modifier.isFinal(clazz.getModifiers()) && hasClassInterceptors) { throw new WebBeansConfigurationException("Final managed bean class with name : " + clazz.getName() + " can not define any InterceptorBindings"); } Set> methods = type.getMethods(); for(AnnotatedMethod methodA : methods) { Method method = methodA.getJavaMember(); int modifiers = method.getModifiers(); if (!method.isSynthetic() && !method.isBridge() && !Modifier.isStatic(modifiers) && !Modifier.isPrivate(modifiers) && Modifier.isFinal(modifiers)) { if (hasClassInterceptors) { throw new WebBeansConfigurationException("Maanged bean class : " + clazz.getName() + " can not define non-static, non-private final methods. Because it is annotated with at least one @InterceptorBinding"); } if (annotationManager.hasInterceptorBindingMetaAnnotation( AnnotationUtil.asArray(methodA.getAnnotations()))) { throw new WebBeansConfigurationException("Method : " + method.getName() + "in managed bean class : " + clazz.getName() + " can not be defined as non-static, non-private and final . Because it is annotated with at least one @InterceptorBinding"); } } } } // Note: following code for method 'format' is taken from google guava - apache 2.0 licenced library // com.google.common.base.Preconditions.format(String, Object...) /** * Substitutes each {@code %s} in {@code template} with an argument. These * are matched by position - the first {@code %s} gets {@code args[0]}, etc. * If there are more arguments than placeholders, the unmatched arguments will * be appended to the end of the formatted message in square braces. * * @param template a non-null string containing 0 or more {@code %s} * placeholders. * @param args the arguments to be substituted into the message * template. Arguments are converted to strings using * {@link String#valueOf(Object)}. Arguments can be null. */ private static String format(String template, Object... args) { template = String.valueOf(template); // null -> "null" // start substituting the arguments into the '%s' placeholders StringBuilder builder = new StringBuilder( template.length() + 16 * args.length); int templateStart = 0; int i = 0; while (i < args.length) { int placeholderStart = template.indexOf("%s", templateStart); if (placeholderStart == -1) { break; } builder.append(template.substring(templateStart, placeholderStart)); builder.append(args[i++]); templateStart = placeholderStart + 2; } builder.append(template.substring(templateStart)); // if we run out of placeholders, append the extra args in square braces if (i < args.length) { builder.append(" ["); builder.append(args[i++]); while (i < args.length) { builder.append(", "); builder.append(args[i++]); } builder.append(']'); } return builder.toString(); } }




© 2015 - 2025 Weber Informatics LLC | Privacy Policy