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 int autowireMode = AutowireCapableBeanFactory.AUTOWIRE_NO;
053:
054: private boolean dependencyCheck = false;
055:
056: /**
057: * Create a new BeanWiringInfo that points to the given bean name.
058: * @param beanName the name of the bean definition to take the property values from
059: * @throws IllegalArgumentException if the supplied beanName is <code>null</code>,
060: * is empty, or consists wholly of whitespace
061: */
062: public BeanWiringInfo(String beanName) {
063: Assert.hasText(beanName, "'beanName' must not be empty");
064: this .beanName = beanName;
065: }
066:
067: /**
068: * Create a new BeanWiringInfo that indicates autowiring.
069: * @param autowireMode one of the constants {@link #AUTOWIRE_BY_NAME} /
070: * {@link #AUTOWIRE_BY_TYPE}
071: * @param dependencyCheck whether to perform a dependency check for object
072: * references in the bean instance (after autowiring)
073: * @throws IllegalArgumentException if the supplied <code>autowireMode</code>
074: * is not one of the allowed values
075: * @see #AUTOWIRE_BY_NAME
076: * @see #AUTOWIRE_BY_TYPE
077: */
078: public BeanWiringInfo(int autowireMode, boolean dependencyCheck) {
079: if (autowireMode != AUTOWIRE_BY_NAME
080: && autowireMode != AUTOWIRE_BY_TYPE) {
081: throw new IllegalArgumentException(
082: "Just constants AUTOWIRE_BY_NAME and AUTOWIRE_BY_TYPE allowed");
083: }
084: this .autowireMode = autowireMode;
085: this .dependencyCheck = dependencyCheck;
086: }
087:
088: /**
089: * Return whether this BeanWiringInfo indicates autowiring.
090: */
091: public boolean indicatesAutowiring() {
092: return (this .beanName == null);
093: }
094:
095: /**
096: * Return the specific bean name that this BeanWiringInfo points to, if any.
097: */
098: public String getBeanName() {
099: return this .beanName;
100: }
101:
102: /**
103: * Return one of the constants {@link #AUTOWIRE_BY_NAME} /
104: * {@link #AUTOWIRE_BY_TYPE}, if autowiring is indicated.
105: */
106: public int getAutowireMode() {
107: return this .autowireMode;
108: }
109:
110: /**
111: * Return whether to perform a dependency check for object references
112: * in the bean instance (after autowiring).
113: */
114: public boolean getDependencyCheck() {
115: return this.dependencyCheck;
116: }
117:
118: }
|