org.osgl.inject

Class BeanSpec

java.lang.Object

org.osgl.inject.BeanSpec

All Implemented Interfaces:

org.osgl.util.AnnotationAware

public class BeanSpec
extends java.lang.Object
implements org.osgl.util.AnnotationAware

Specification of a bean to be injected.

Method Summary

Modifier and Type	Method and Description
java.lang.annotation.Annotation[]	allAnnotations()
boolean	equals(java.lang.Object obj) A bean spec equals to another bean spec if all of the following conditions are met: * the type of the two bean spec equals to each other * the annotations of the two bean spec equals to each other
<T extends java.lang.annotation.Annotation> T	getAnnotation(java.lang.Class<T> annoClass)
int	getModifiers()
boolean	hasAnnotation()
boolean	hasAnnotation(java.lang.Class<? extends java.lang.annotation.Annotation> annoClass)
int	hashCode()
Injector	injector()
boolean	isArray()
boolean	isFinal()
boolean	isInstance(java.lang.Object o) Check if a given object is instance of the type of this bean spec.
boolean	isInstanceOf(java.lang.Class c) Return if the bean is instance of give class.
boolean	isPrivate()
boolean	isProtected()
boolean	isPublic()
boolean	isStatic()
boolean	isTransient()
java.lang.String	name()
static BeanSpec	of(java.lang.Class<?> clazz, Injector injector)
static BeanSpec	of(java.lang.reflect.Field field, Injector injector)
static BeanSpec	of(java.lang.reflect.Type type, java.lang.annotation.Annotation[] paramAnnotations, Injector injector)
static BeanSpec	of(java.lang.reflect.Type type, java.lang.annotation.Annotation[] paramAnnotations, Injector injector, int modifiers)
static BeanSpec	of(java.lang.reflect.Type type, java.lang.annotation.Annotation[] paramAnnotations, java.lang.String name, Injector injector)
static BeanSpec	of(java.lang.reflect.Type type, java.lang.annotation.Annotation[] paramAnnotations, java.lang.String name, Injector injector, int modifiers)
static BeanSpec	of(java.lang.reflect.Type type, Injector injector)
java.util.Set<java.lang.annotation.Annotation>	qualifiers() Returns all qualifier annotation of this bean spec.
java.lang.Class	rawType()
static java.lang.Class<?>	rawTypeOf(java.lang.reflect.Type type) A utility method to return raw type (the class) of a given type.
java.lang.annotation.Annotation[]	taggedAnnotations(java.lang.Class<? extends java.lang.annotation.Annotation> tagType)
BeanSpec	toList() Convert an array bean spec to a list bean spec.
java.lang.String	toString()
java.lang.reflect.Type	type()
java.util.List<java.lang.reflect.Type>	typeParams() Returns a list of type parameters if the type() of the bean is instance of ParameterizedType.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

A bean spec equals to another bean spec if all of the following conditions are met: * the type of the two bean spec equals to each other * the annotations of the two bean spec equals to each other

Specifically, scope does not participate comparison because 1. Scope annotations shall be put onto type, or the factory method with Provides annotation, which is equivalent to Type. So it is safe to ignore scope annotation because one type cannot be annotated with different scope 2. If we count scope annotation in equality test, we will never be able to get the correct provider stem from the factory methods.

Overrides:

equals in class java.lang.Object

Parameters:

obj - the object to compare with this object

Returns:

true if the two objects equals as per described above

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

injector

public Injector injector()

type

public java.lang.reflect.Type type()

rawType

public java.lang.Class rawType()

name

public java.lang.String name()

isArray

public boolean isArray()

allAnnotations

public java.lang.annotation.Annotation[] allAnnotations()

taggedAnnotations

public java.lang.annotation.Annotation[] taggedAnnotations(java.lang.Class<? extends java.lang.annotation.Annotation> tagType)

toList

public BeanSpec toList()

Convert an array bean spec to a list bean spec.

Returns:

the array bean spec with component type derived from this bean spec

getAnnotation

public <T extends java.lang.annotation.Annotation> T getAnnotation(java.lang.Class<T> annoClass)

Specified by:

getAnnotation in interface org.osgl.util.AnnotationAware

hasAnnotation

public boolean hasAnnotation(java.lang.Class<? extends java.lang.annotation.Annotation> annoClass)

Specified by:

hasAnnotation in interface org.osgl.util.AnnotationAware

hasAnnotation

public boolean hasAnnotation()

getModifiers

public int getModifiers()

isTransient

public boolean isTransient()

isStatic

public boolean isStatic()

isPrivate

public boolean isPrivate()

isPublic

public boolean isPublic()

isProtected

public boolean isProtected()

isFinal

public boolean isFinal()

typeParams

public java.util.List<java.lang.reflect.Type> typeParams()

Returns a list of type parameters if the type() of the bean is instance of ParameterizedType.

For example the bean spec of a field declared as

private Map<String, Integer> scores;

The typeParams() method will return a list of String and Integer

Returns:

type parameter list

isInstanceOf

public boolean isInstanceOf(java.lang.Class c)

Return if the bean is instance of give class.

Parameters:

c - the class

Returns:

true if the underline bean is an instance of c

isInstance

public boolean isInstance(java.lang.Object o)

Check if a given object is instance of the type of this bean spec.

Parameters:

o - the object instance

Returns:

true if the object is an instance of type of this bean spec

qualifiers

public java.util.Set<java.lang.annotation.Annotation> qualifiers()

Returns all qualifier annotation of this bean spec.

Returns:

all qualifier annotations of this bean spec

of

public static BeanSpec of(java.lang.Class<?> clazz,
                          Injector injector)

of

public static BeanSpec of(java.lang.reflect.Type type,
                          Injector injector)

of

public static BeanSpec of(java.lang.reflect.Type type,
                          java.lang.annotation.Annotation[] paramAnnotations,
                          Injector injector)

of

public static BeanSpec of(java.lang.reflect.Type type,
                          java.lang.annotation.Annotation[] paramAnnotations,
                          Injector injector,
                          int modifiers)

of

public static BeanSpec of(java.lang.reflect.Type type,
                          java.lang.annotation.Annotation[] paramAnnotations,
                          java.lang.String name,
                          Injector injector)

of

public static BeanSpec of(java.lang.reflect.Type type,
                          java.lang.annotation.Annotation[] paramAnnotations,
                          java.lang.String name,
                          Injector injector,
                          int modifiers)

of

public static BeanSpec of(java.lang.reflect.Field field,
                          Injector injector)

rawTypeOf

public static java.lang.Class<?> rawTypeOf(java.lang.reflect.Type type)

A utility method to return raw type (the class) of a given type.

Parameters:

type - a Type

Returns:

a Class of the type

Throws:

org.osgl.exception.UnexpectedException - if class cannot be determined