BeanSpec (OSGL Genie 1.7.1 API)

java.lang.Object
- org.osgl.inject.BeanSpec

All Implemented Interfaces:

org.osgl.util.AnnotationAware
```
public class BeanSpec
extends Object
implements org.osgl.util.AnnotationAware
```
Specification of a bean to be injected.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Annotation[]`	`allAnnotations()`
`BeanSpec`	`componentSpec()`
`boolean`	`equals(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
`BeanSpec`	`field(String name)`
`Map<String,BeanSpec>`	`fields()` Returns a list of `BeanSpec` for all fields including super class fields.
`List<BeanSpec>`	`fields(org.osgl.Lang.Predicate<Field> filter)` Returns a list of `BeanSpec` for all fields including super class fields.
`<T extends Annotation> T`	`getAnnotation(Class<T> annoClass)`
`int`	`getModifiers()`
`boolean`	`hasAnnotation()`
`boolean`	`hasAnnotation(Class<? extends Annotation> annoClass)`
`int`	`hashCode()`
`boolean`	`hasInjectDecorator()` Check if the bean spec has injector decorators.
`Injector`	`injector()`
`boolean`	`isArray()`
`boolean`	`isFinal()`
`boolean`	`isInstance(Object o)` Check if a given object is instance of the type of this bean spec.
`boolean`	`isInstanceOf(Class c)` Return if the bean is instance of give class.
`boolean`	`isInterface()`
`boolean`	`isNotObject()`
`boolean`	`isObject()`
`boolean`	`isPrivate()`
`boolean`	`isProtected()`
`boolean`	`isPublic()`
`boolean`	`isStatic()`
`boolean`	`isTransient()`
`String`	`name()`
`List<BeanSpec>`	`nonStaticFields()`
`static BeanSpec`	`of(Class<?> clazz, Injector injector)`
`static BeanSpec`	`of(Field field, Injector injector)`
`static BeanSpec`	`of(Type type, Annotation[] paramAnnotations, Injector injector)`
`static BeanSpec`	`of(Type type, Annotation[] paramAnnotations, Injector injector, int modifiers)`
`static BeanSpec`	`of(Type type, Annotation[] paramAnnotations, String name, Injector injector)`
`static BeanSpec`	`of(Type type, Annotation[] paramAnnotations, String name, Injector injector, int modifiers)`
`static BeanSpec`	`of(Type type, Injector injector)`
`BeanSpec`	`parent()`
`Set<Annotation>`	`qualifiers()` Returns all qualifier annotation of this bean spec.
`Class`	`rawType()`
`static Class<?>`	`rawTypeOf(Type type)` A utility method to return raw type (the class) of a given type.
`Annotation[]`	`taggedAnnotations(Class<? extends Annotation> tagType)`
`BeanSpec`	`toList()` Convert an array bean spec to a list bean spec.
`String`	`toString()`
`Type`	`type()`
`List<Type>`	`typeParams()` Returns a list of type parameters if the `type()` of the bean is instance of `ParameterizedType`.
`BeanSpec`	`withoutName()`

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 Object

equals
```
public boolean equals(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 Object

Parameters:

obj - the object to compare with this object

Returns:

true if the two objects equals as per described above

toString
```
public String toString()
```
Overrides:

toString in class Object

injector
```
public Injector injector()
```

type
```
public Type type()
```

rawType
```
public Class rawType()
```

name
```
public String name()
```

isArray
```
public boolean isArray()
```

allAnnotations
```
public Annotation[] allAnnotations()
```

taggedAnnotations

public Annotation[] taggedAnnotations(Class<? extends 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 Annotation> T getAnnotation(Class<T> annoClass)
```
Specified by:

getAnnotation in interface org.osgl.util.AnnotationAware

hasAnnotation
```
public boolean hasAnnotation(Class<? extends 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()
```

isInterface
```
public boolean isInterface()
```

withoutName
```
public BeanSpec withoutName()
```

typeParams
```
public List<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

componentSpec
```
public BeanSpec componentSpec()
```

isInstanceOf
```
public boolean isInstanceOf(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(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

hasInjectDecorator
```
public boolean hasInjectDecorator()
```
Check if the bean spec has injector decorators. The following annotations are considered to be inject decorators: * qualifiers * post construct annotation * scope annotation * Inject or any annotation has InjectTag presented

Returns:

true if the beanSpec has inject decorators or false otherwise

qualifiers
```
public Set<Annotation> qualifiers()
```
Returns all qualifier annotation of this bean spec.

Returns:

all qualifier annotations of this bean spec

parent
```
public BeanSpec parent()
```

isObject
```
public boolean isObject()
```

isNotObject
```
public boolean isNotObject()
```

field
```
public BeanSpec field(String name)
```

fields
```
public Map<String,BeanSpec> fields()
```
Returns a list of BeanSpec for all fields including super class fields.

Returns:

the fields spec list

nonStaticFields

public List<BeanSpec> nonStaticFields()

fields
```
public List<BeanSpec> fields(org.osgl.Lang.Predicate<Field> filter)
```
Returns a list of BeanSpec for all fields including super class fields.

Parameters:

filter - a function to filter out fields that are not needed.

Returns:

the fields spec list

of

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

of

public static BeanSpec of(Type type,
                          Injector injector)

of

public static BeanSpec of(Type type,
                          Annotation[] paramAnnotations,
                          Injector injector)

of

public static BeanSpec of(Type type,
                          Annotation[] paramAnnotations,
                          Injector injector,
                          int modifiers)

of

public static BeanSpec of(Type type,
                          Annotation[] paramAnnotations,
                          String name,
                          Injector injector)

of

public static BeanSpec of(Type type,
                          Annotation[] paramAnnotations,
                          String name,
                          Injector injector,
                          int modifiers)

of

public static BeanSpec of(Field field,
                          Injector injector)

rawTypeOf
```
public static Class<?> rawTypeOf(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

Class BeanSpec

Method Summary

Methods inherited from class java.lang.Object

Method Detail

hashCode

equals

toString

injector

type

rawType

name

isArray

allAnnotations

taggedAnnotations

toList

getAnnotation

hasAnnotation

hasAnnotation

getModifiers

isTransient

isStatic

isPrivate

isPublic

isProtected

isFinal

isInterface

withoutName

typeParams

componentSpec

isInstanceOf

isInstance

hasInjectDecorator

qualifiers

parent

isObject

isNotObject

field

fields

nonStaticFields

fields

of

of

of

of

of

of

of

rawTypeOf