001: /*
002: * Copyright 2002-2007 the original author or authors.
003: *
004: * Licensed under the Apache License, Version 2.0 (the "License");
005: * you may not use this file except in compliance with the License.
006: * You may obtain a copy of the License at
007: *
008: * http://www.apache.org/licenses/LICENSE-2.0
009: *
010: * Unless required by applicable law or agreed to in writing, software
011: * distributed under the License is distributed on an "AS IS" BASIS,
012: * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013: * See the License for the specific language governing permissions and
014: * limitations under the License.
015: */
016:
017: package org.springframework.beans.factory.wiring;
018:
019: import org.springframework.beans.factory.config.AutowireCapableBeanFactory;
020: import org.springframework.util.Assert;
021:
022: /**
023: * Holder for bean wiring metadata information about a particular class. Used in
024: * conjunction with the {@link org.springframework.beans.factory.annotation.Configurable}
025: * annotation and the AspectJ <code>AnnotationBeanConfigurerAspect</code>.
026: *
027: * @author Rod Johnson
028: * @author Juergen Hoeller
029: * @since 2.0
030: * @see BeanWiringInfoResolver
031: * @see org.springframework.beans.factory.config.AutowireCapableBeanFactory
032: * @see org.springframework.beans.factory.annotation.Configurable
033: */
034: public class BeanWiringInfo {
035:
036: /**
037: * Constant that indicates autowiring bean properties by name.
038: * @see #BeanWiringInfo(int, boolean)
039: * @see org.springframework.beans.factory.config.AutowireCapableBeanFactory#AUTOWIRE_BY_NAME
040: */
041: public static final int AUTOWIRE_BY_NAME = AutowireCapableBeanFactory.AUTOWIRE_BY_NAME;
042:
043: /**
044: * Constant that indicates autowiring bean properties by type.
045: * @see #BeanWiringInfo(int, boolean)
046: * @see org.springframework.beans.factory.config.AutowireCapableBeanFactory#AUTOWIRE_BY_TYPE
047: */
048: public static final int AUTOWIRE_BY_TYPE = AutowireCapableBeanFactory.AUTOWIRE_BY_TYPE;
049:
050: private String beanName = null;
051:
052: private boolean isDefaultBeanName = false;
053:
054: private int autowireMode = AutowireCapableBeanFactory.AUTOWIRE_NO;
055:
056: private boolean dependencyCheck = false;
057:
058: /**
059: * Create a default BeanWiringInfo that suggests plain initialization of
060: * factory and post-processor callbacks that the bean class may expect.
061: */
062: public BeanWiringInfo() {
063: }
064:
065: /**
066: * Create a new BeanWiringInfo that points to the given bean name.
067: * @param beanName the name of the bean definition to take the property values from
068: * @throws IllegalArgumentException if the supplied beanName is <code>null</code>,
069: * is empty, or consists wholly of whitespace
070: */
071: public BeanWiringInfo(String beanName) {
072: this (beanName, false);
073: }
074:
075: /**
076: * Create a new BeanWiringInfo that points to the given bean name.
077: * @param beanName the name of the bean definition to take the property values from
078: * @param isDefaultBeanName whether the given bean name is a suggested
079: * default bean name, not necessarily matching an actual bean definition
080: * @throws IllegalArgumentException if the supplied beanName is <code>null</code>,
081: * is empty, or consists wholly of whitespace
082: */
083: public BeanWiringInfo(String beanName, boolean isDefaultBeanName) {
084: Assert.hasText(beanName, "'beanName' must not be empty");
085: this .beanName = beanName;
086: this .isDefaultBeanName = isDefaultBeanName;
087: }
088:
089: /**
090: * Create a new BeanWiringInfo that indicates autowiring.
091: * @param autowireMode one of the constants {@link #AUTOWIRE_BY_NAME} /
092: * {@link #AUTOWIRE_BY_TYPE}
093: * @param dependencyCheck whether to perform a dependency check for object
094: * references in the bean instance (after autowiring)
095: * @throws IllegalArgumentException if the supplied <code>autowireMode</code>
096: * is not one of the allowed values
097: * @see #AUTOWIRE_BY_NAME
098: * @see #AUTOWIRE_BY_TYPE
099: */
100: public BeanWiringInfo(int autowireMode, boolean dependencyCheck) {
101: if (autowireMode != AUTOWIRE_BY_NAME
102: && autowireMode != AUTOWIRE_BY_TYPE) {
103: throw new IllegalArgumentException(
104: "Only constants AUTOWIRE_BY_NAME and AUTOWIRE_BY_TYPE supported");
105: }
106: this .autowireMode = autowireMode;
107: this .dependencyCheck = dependencyCheck;
108: }
109:
110: /**
111: * Return whether this BeanWiringInfo indicates autowiring.
112: */
113: public boolean indicatesAutowiring() {
114: return (this .beanName == null);
115: }
116:
117: /**
118: * Return the specific bean name that this BeanWiringInfo points to, if any.
119: */
120: public String getBeanName() {
121: return this .beanName;
122: }
123:
124: /**
125: * Return whether the specific bean name is a suggested default bean name,
126: * not necessarily matching an actual bean definition in the factory.
127: */
128: public boolean isDefaultBeanName() {
129: return this .isDefaultBeanName;
130: }
131:
132: /**
133: * Return one of the constants {@link #AUTOWIRE_BY_NAME} /
134: * {@link #AUTOWIRE_BY_TYPE}, if autowiring is indicated.
135: */
136: public int getAutowireMode() {
137: return this .autowireMode;
138: }
139:
140: /**
141: * Return whether to perform a dependency check for object references
142: * in the bean instance (after autowiring).
143: */
144: public boolean getDependencyCheck() {
145: return this.dependencyCheck;
146: }
147:
148: }
|