/*
* JBoss, Home of Professional Open Source
* Copyright 2011, Red Hat, Inc. and/or its affiliates, and individual
* contributors by the @authors tag. See the copyright.txt in the
* distribution for a full listing of individual contributors.
*
* Licensed 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.jboss.solder.bean;
import java.lang.annotation.Annotation;
import java.lang.reflect.Type;
import java.util.Collection;
import java.util.HashSet;
import java.util.Set;
import javax.enterprise.context.Dependent;
import javax.enterprise.inject.Alternative;
import javax.enterprise.inject.spi.AnnotatedType;
import javax.enterprise.inject.spi.Bean;
import javax.enterprise.inject.spi.BeanManager;
import javax.inject.Named;
import org.jboss.solder.literal.AnyLiteral;
import org.jboss.solder.literal.DefaultLiteral;
import static org.jboss.solder.util.collections.Arrays2.asSet;
/**
* Builder for {@link ImmutableNarrowingBean} and
* {@link ImmutablePassivationCapableNarrowingBean}.
*
* @author Pete Muir
* @see ImmutableNarrowingBean
* @see ImmutablePassivationCapableNarrowingBean
*/
public class NarrowingBeanBuilder<T> {
private final Bean<Object> delegate;
private final BeanManager beanManager;
private Set<Type> types;
private Set<Annotation> qualifiers;
private String name;
private Class<? extends Annotation> scope;
private boolean alternative;
private boolean nullable;
private String toString;
private Set<Class<? extends Annotation>> stereotypes;
private boolean passivationCapable;
private String id;
/**
* Create a new {@link NarrowingBeanBuilder}, allowing Java to infer the type
* <code>T</code>.
*
* @param <T> the type of the bean
* @param delegate the delegate bean
*/
public static <T> NarrowingBeanBuilder<T> of(Bean<Object> delegate, BeanManager beanManager) {
return new NarrowingBeanBuilder<T>(delegate, beanManager);
}
/**
* Instantiate a new {@link NarrowingBeanBuilder}.
*
* @param delegate the delegate bean
*/
public NarrowingBeanBuilder(Bean<Object> delegate, BeanManager beanManager) {
this.delegate = delegate;
this.beanManager = beanManager;
}
/**
* <p>
* Read the {@link AnnotatedType}, creating a narrowing bean from the class
* and its annotations.
* </p>
*
* @param type the type to read
*/
public NarrowingBeanBuilder<T> readFromType(AnnotatedType<T> type) {
this.types = new HashSet<Type>(type.getTypeClosure());
this.qualifiers = new HashSet<Annotation>();
this.stereotypes = new HashSet<Class<? extends Annotation>>();
String name = null;
Class<? extends Annotation> scope = Dependent.class;
for (Annotation annotation : type.getAnnotations()) {
if (beanManager.isQualifier(annotation.annotationType())) {
this.qualifiers.add(annotation);
} else if (annotation.annotationType().equals(Named.class)) {
name = Named.class.cast(annotation).value();
} else if (beanManager.isScope(annotation.annotationType())) {
scope = annotation.annotationType();
} else if (beanManager.isStereotype(annotation.annotationType())) {
this.stereotypes.add(annotation.annotationType());
}
}
if (qualifiers.isEmpty()) {
this.qualifiers.add(DefaultLiteral.INSTANCE);
}
this.qualifiers.add(AnyLiteral.INSTANCE);
this.name = "".equals(name) ? null : name;
this.scope = scope;
this.alternative = type.isAnnotationPresent(Alternative.class);
return this;
}
/**
* Type closure currently defined for bean creation.
*
* @return the type closure currently defined
*/
public Set<Type> getTypes() {
return types;
}
/**
* Define the type closure used for bean creation.
*
* @param types the type closure to use
*/
public NarrowingBeanBuilder<T> types(Set<Type> types) {
this.types = types;
return this;
}
/**
* Define the type closure used for bean creation.
*
* @param types the type closure to use
*/
public NarrowingBeanBuilder<T> types(Type... types) {
this.types = asSet(types);
return this;
}
/**
* Add to the type closure used for bean creation.
*
* @param type additional type to use
*/
public NarrowingBeanBuilder<T> addType(Type type) {
this.types.add(type);
return this;
}
/**
* Add to the type closure used for bean creation.
*
* @param types the additional types to use
*/
public NarrowingBeanBuilder<T> addTypes(Type... types) {
this.types.addAll(asSet(types));
return this;
}
/**
* Add to the type closure used for bean creation.
*
* @param types the additional types to use
*/
public NarrowingBeanBuilder<T> addTypes(Collection<Type> types) {
this.types.addAll(types);
return this;
}
/**
* Qualifiers currently defined for bean creation.
*
* @return the qualifiers current defined
*/
public Set<Annotation> getQualifiers() {
return qualifiers;
}
/**
* Define the qualifiers used for bean creation.
*
* @param qualifiers the qualifiers to use
*/
public NarrowingBeanBuilder<T> qualifiers(Set<Annotation> qualifiers) {
this.qualifiers = qualifiers;
return this;
}
/**
* Define the qualifiers used for bean creation.
*
* @param qualifiers the qualifiers to use
*/
public NarrowingBeanBuilder<T> qualifiers(Annotation... qualifiers) {
this.qualifiers = asSet(qualifiers);
return this;
}
/**
* Add to the qualifiers used for bean creation.
*
* @param qualifiers the additional qualifier to use
*/
public NarrowingBeanBuilder<T> addQualifier(Annotation qualifier) {
this.qualifiers.add(qualifier);
return this;
}
/**
* Add to the qualifiers used for bean creation.
*
* @param qualifiers the additional qualifiers to use
*/
public NarrowingBeanBuilder<T> addQualifiers(Annotation... qualifiers) {
this.qualifiers.addAll(asSet(qualifiers));
return this;
}
/**
* Add to the qualifiers used for bean creation.
*
* @param qualifiers the additional qualifiers to use
*/
public NarrowingBeanBuilder<T> addQualifiers(Collection<Annotation> qualifiers) {
this.qualifiers.addAll(qualifiers);
return this;
}
/**
* The name of the bean currently defined for bean creation.
*
* @return the name of the bean or <code>null</code> if the bean has no name
*/
public String getName() {
return name;
}
/**
* Define the name of the bean used for bean creation.
*
* @param name the name of the bean to use or <code>null</code> if the bean
* should have no name
*/
public NarrowingBeanBuilder<T> name(String name) {
this.name = name;
return this;
}
/**
* Scope currently defined for bean creation.
*
* @return the scope currently defined
*/
public Class<? extends Annotation> getScope() {
return scope;
}
/**
* Define the scope used for bean creation.
*
* @param scope the scope to use
*/
public NarrowingBeanBuilder<T> scope(Class<? extends Annotation> scope) {
this.scope = scope;
return this;
}
/**
* Whether the created bean will be an alternative.
*
* @return <code>true</code> if the created bean will be an alternative,
* otherwise <code>false</code>
*/
public boolean isAlternative() {
return alternative;
}
/**
* Define that the created bean will (or will not) be an alternative.
*
* @param alternative <code>true</code> if the created bean should be an
* alternative, otherwise <code>false</code>
*/
public NarrowingBeanBuilder<T> alternative(boolean alternative) {
this.alternative = alternative;
return this;
}
/**
* Stereotypes currently defined for bean creation.
*
* @return the stereotypes currently defined
*/
public Set<Class<? extends Annotation>> getStereotypes() {
return stereotypes;
}
/**
* Define the stereotypes used for bean creation.
*
* @param stereotypes the stereotypes to use
*/
public NarrowingBeanBuilder<T> stereotypes(Set<Class<? extends Annotation>> stereotypes) {
this.stereotypes = stereotypes;
return this;
}
/**
* <p>
* Use the bean builder's current state to define the bean.
* </p>
*
* @return the bean
*/
public ImmutableNarrowingBean<T> create() {
if (isPassivationCapable()) {
return new ImmutablePassivationCapableNarrowingBean<T>(delegate, name, qualifiers, scope, stereotypes, types, alternative, nullable, toString, id);
} else {
return new ImmutableNarrowingBean<T>(delegate, name, qualifiers, scope, stereotypes, types, alternative, nullable, toString);
}
}
/**
* The string used when {@link #toString()} is called on the bean.
*
* @return the string currently defined
*/
public String getToString() {
return toString;
}
/**
* Define the string used when {@link #toString()} is called on the bean.
*
* @param toString the string to use
*/
public NarrowingBeanBuilder<T> toString(String toString) {
this.toString = toString;
return this;
}
/**
* Whether the created bean will be nullable.
*
* @return <code>true</code> if the created bean will be nullable, otherwise
* <code>false</code>
*/
public boolean isNullable() {
return nullable;
}
/**
* Define that the created bean will (or will not) be nullable.
*
* @param nullable <code>true</code> if the created bean should be nullable,
* otherwise <code>false</code>
*/
public NarrowingBeanBuilder<T> nullable(boolean nullable) {
this.nullable = nullable;
return this;
}
/**
* Whether the created bean will be passivation capable.
*
* @return <code>true</code> if the created bean will be passivation capable,
* otherwise <code>false</code>
*/
public boolean isPassivationCapable() {
return passivationCapable;
}
/**
* Define that the created bean will (or will not) be passivation capable.
*
* @param nullable <code>true</code> if the created bean should be
* passivation capable, otherwise <code>false</code>
*/
public NarrowingBeanBuilder<T> passivationCapable(boolean passivationCapable) {
this.passivationCapable = passivationCapable;
return this;
}
/**
* The id currently defined for bean creation.
*
* @return the id currently defined.
*/
public String getId() {
return id;
}
/**
* Define the id used for bean creation.
*
* @param id the id to use
*/
public NarrowingBeanBuilder<T> id(String id) {
this.id = id;
return this;
}
}