public interface ListableBeanFactory extends BeanFactory
BeanFactory
インターフェースの拡張。クライアントからのリクエストに応じて、名前で Bean ルックアップを 1 つずつ試行するのではなく、Bean インスタンスをすべて列挙できます。すべての Bean 定義(XML ベースのファクトリなど)をプリロードする BeanFactory 実装は、このインターフェースを実装する場合があります。 これは HierarchicalBeanFactory
である場合、戻り値は、アカウントに任意の BeanFactory 階層になりませんが、現在のファクトリで定義された Bean にのみ関連します。BeanFactoryUtils
ヘルパークラスを使用して、祖先ファクトリの Bean も検討します。
このインターフェースのメソッドは、このファクトリの Bean 定義を考慮します。これらは、ConfigurableBeanFactory
の registerSingleton
メソッドなどの他の方法で登録されたシングルトン Bean を無視します。ただし、getBeanNamesOfType
と getBeansOfType
は例外で、このような手動で登録されたシングルトンもチェックします。もちろん、BeanFactory の getBean
では、そのような特殊な Bean への透過的なアクセスも可能です。ただし、通常のシナリオでは、すべての Bean がいずれにせよ外部 Bean 定義によって定義されるため、ほとんどのアプリケーションはこの区別について心配する必要はありません。
注意 : getBeanDefinitionCount
および containsBeanDefinition
を除いて、このインターフェースのメソッドは頻繁に呼び出すようには設計されていません。実装に時間がかかる場合があります。
HierarchicalBeanFactory
, BeanFactoryUtils
FACTORY_BEAN_PREFIX
修飾子と型 | メソッドと説明 |
---|---|
boolean | containsBeanDefinition(java.lang.String beanName) この Bean ファクトリに、指定された名前の Bean 定義が含まれているかどうかを確認します。 |
<A extends java.lang.annotation.Annotation> | findAnnotationOnBean(java.lang.String beanName, java.lang.Class<A> annotationType) 指定されたクラス自体にアノテーションが見つからない場合は、指定された Bean で annotationType の Annotation を見つけ、そのインターフェースとスーパークラスをトラバースします。 |
int | getBeanDefinitionCount() ファクトリで定義されている Bean の数を返します。 |
java.lang.String[] | getBeanDefinitionNames() このファクトリで定義されているすべての Bean の名前を返します。 |
java.lang.String[] | getBeanNamesForAnnotation(java.lang.Class<? extends java.lang.annotation.Annotation> annotationType) Bean インスタンスをまだ作成せずに、 Class が指定された Annotation 型を持つ Bean のすべての名前を検索します。 |
java.lang.String[] | getBeanNamesForType(java.lang.Class<?> type) Bean 定義または FactoryBeans の場合は getObjectType の値から判断して、指定された型(サブクラスを含む)に一致する Bean の名前を返します。 |
java.lang.String[] | getBeanNamesForType(java.lang.Class<?> type, boolean includeNonSingletons, boolean allowEagerInit) Bean 定義または FactoryBeans の場合は getObjectType の値から判断して、指定された型(サブクラスを含む)に一致する Bean の名前を返します。 |
java.lang.String[] | getBeanNamesForType(ResolvableType type) Bean 定義または FactoryBeans の場合は getObjectType の値から判断して、指定された型(サブクラスを含む)に一致する Bean の名前を返します。 |
<T> java.util.Map<java.lang.String,T> | getBeansOfType(java.lang.Class<T> type) Bean 定義または FactoryBeans の場合は getObjectType の値から判断して、指定されたオブジェクト型(サブクラスを含む)に一致する Bean インスタンスを返します。 |
<T> java.util.Map<java.lang.String,T> | getBeansOfType(java.lang.Class<T> type, boolean includeNonSingletons, boolean allowEagerInit) Bean 定義または FactoryBeans の場合は getObjectType の値から判断して、指定されたオブジェクト型(サブクラスを含む)に一致する Bean インスタンスを返します。 |
java.util.Map<java.lang.String,java.lang.Object> | getBeansWithAnnotation(java.lang.Class<? extends java.lang.annotation.Annotation> annotationType) Class が指定された Annotation 型を持つすべての Bean を検索し、対応する Bean インスタンスを持つ Bean 名のマップを返します。 |
containsBean, getAliases, getBean, getBean, getBean, getBean, getBean, getType, isPrototype, isSingleton, isTypeMatch, isTypeMatch
boolean containsBeanDefinition(java.lang.String beanName)
このファクトリが参加する可能性のある階層を考慮せず、Bean 定義以外の方法で登録されたシングルトン Bean を無視します。
beanName
- 検索する Bean の名前 BeanFactory.containsBean(java.lang.String)
int getBeanDefinitionCount()
このファクトリが参加する可能性のある階層を考慮せず、Bean 定義以外の方法で登録されたシングルトン Bean を無視します。
java.lang.String[] getBeanDefinitionNames()
このファクトリが参加する可能性のある階層を考慮せず、Bean 定義以外の方法で登録されたシングルトン Bean を無視します。
java.lang.String[] getBeanNamesForType(ResolvableType type)
getObjectType
の値から判断して、指定された型(サブクラスを含む)に一致する Bean の名前を返します。注: このメソッドは、最上位の Bean のみをイントロスペクトします。指定された型と一致する可能性のあるネストされた Bean もチェックしません。
FactoryBeans によって作成されたオブジェクトは考慮されません。つまり、FactoryBeans は初期化されます。FactoryBean によって作成されたオブジェクトが一致しない場合、生の FactoryBean 自体が型と一致します。
このファクトリが参加する可能性のある階層を考慮しません。BeanFactoryUtils の beanNamesForTypeIncludingAncestors
を使用して、祖先ファクトリにも Bean を含めます。
メモ: Bean 定義以外の方法で登録されたシングルトン Bean を無視しません。
このバージョンの getBeanNamesForType
は、シングルトン、プロトタイプ、FactoryBeans など、あらゆる種類の Bean に一致します。ほとんどの実装では、結果は getBeanNamesForType(type, true, true)
の場合と同じになります。
このメソッドによって返される Bean 名は、常に、可能な限りバックエンド構成での定義順に Bean 名を返す必要があります。
type
- 一致させるクラスまたはインターフェース、またはすべての Bean 名の null
BeanFactory.isTypeMatch(String, ResolvableType)
, FactoryBean.getObjectType()
, BeanFactoryUtils.beanNamesForTypeIncludingAncestors(ListableBeanFactory, ResolvableType)
java.lang.String[] getBeanNamesForType(java.lang.Class<?> type)
getObjectType
の値から判断して、指定された型(サブクラスを含む)に一致する Bean の名前を返します。注: このメソッドは、最上位の Bean のみをイントロスペクトします。指定された型と一致する可能性のあるネストされた Bean もチェックしません。
FactoryBeans によって作成されたオブジェクトは考慮されません。つまり、FactoryBeans は初期化されます。FactoryBean によって作成されたオブジェクトが一致しない場合、生の FactoryBean 自体が型と一致します。
このファクトリが参加する可能性のある階層を考慮しません。BeanFactoryUtils の beanNamesForTypeIncludingAncestors
を使用して、祖先ファクトリにも Bean を含めます。
メモ: Bean 定義以外の方法で登録されたシングルトン Bean を無視しません。
このバージョンの getBeanNamesForType
は、シングルトン、プロトタイプ、FactoryBeans など、あらゆる種類の Bean に一致します。ほとんどの実装では、結果は getBeanNamesForType(type, true, true)
の場合と同じになります。
このメソッドによって返される Bean 名は、常に、可能な限りバックエンド構成での定義順に Bean 名を返す必要があります。
type
- 一致させるクラスまたはインターフェース、またはすべての Bean 名の null
FactoryBean.getObjectType()
, BeanFactoryUtils.beanNamesForTypeIncludingAncestors(ListableBeanFactory, Class)
java.lang.String[] getBeanNamesForType(java.lang.Class<?> type, boolean includeNonSingletons, boolean allowEagerInit)
getObjectType
の値から判断して、指定された型(サブクラスを含む)に一致する Bean の名前を返します。注: このメソッドは、最上位の Bean のみをイントロスペクトします。指定された型と一致する可能性のあるネストされた Bean もチェックしません。
"allowEagerInit" フラグが設定されている場合は、FactoryBeans によって作成されたオブジェクトを考慮します。つまり、FactoryBeans が初期化されます。FactoryBean によって作成されたオブジェクトが一致しない場合は、生の FactoryBean 自体が型と照合されます。"allowEagerInit" が設定されていない場合は、生の FactoryBeans のみがチェックされます (各 FactoryBean の初期化は必要ありません)。
このファクトリが参加する可能性のある階層を考慮しません。BeanFactoryUtils の beanNamesForTypeIncludingAncestors
を使用して、祖先ファクトリにも Bean を含めます。
メモ: Bean 定義以外の方法で登録されたシングルトン Bean を無視しません。
このメソッドによって返される Bean 名は、常に、可能な限りバックエンド構成での定義順に Bean 名を返す必要があります。
type
- 一致させるクラスまたはインターフェース、またはすべての Bean 名の null
includeNonSingletons
- プロトタイプ Bean またはスコープ Bean も含めるか、シングルトンのみを含めるか (FactoryBeans にも適用)allowEagerInit
- 型チェックのために FactoryBeans (または "factory-bean" 参照を含むファクトリメソッド)によって作成された lazy-init シングルトンとオブジェクトを初期化するかどうか。FactoryBeans は、型を判別するために積極的に初期化する必要があることに注意してください。このフラグに "true" を渡すと、FactoryBeans および "factory-bean" 参照が初期化されることに注意してください。FactoryBean.getObjectType()
, BeanFactoryUtils.beanNamesForTypeIncludingAncestors(ListableBeanFactory, Class, boolean, boolean)
<T> java.util.Map<java.lang.String,T> getBeansOfType(java.lang.Class<T> type) throws BeansException
getObjectType
の値から判断して、指定されたオブジェクト型(サブクラスを含む)に一致する Bean インスタンスを返します。注: このメソッドは、最上位の Bean のみをイントロスペクトします。指定された型と一致する可能性のあるネストされた Bean もチェックしません。
FactoryBeans によって作成されたオブジェクトは考慮されません。つまり、FactoryBeans は初期化されます。FactoryBean によって作成されたオブジェクトが一致しない場合、生の FactoryBean 自体が型と一致します。
このファクトリが参加する可能性のある階層を考慮しません。BeanFactoryUtils の beansOfTypeIncludingAncestors
を使用して、祖先ファクトリにも Bean を含めます。
メモ: Bean 定義以外の方法で登録されたシングルトン Bean を無視しません。
このバージョンの getBeansOfType は、シングルトン、プロトタイプ、FactoryBeans など、あらゆる種類の Bean に一致します。ほとんどの実装では、結果は getBeansOfType(type, true, true)
の場合と同じになります。
このメソッドによって返されるマップは、常に、可能な限り、バックエンド構成での定義順に Bean 名と対応する Bean インスタンスを返す必要があります。
type
- 一致するクラスまたはインターフェース、またはすべての具象 Bean の null
BeansException
- Bean を作成できなかった場合 FactoryBean.getObjectType()
, BeanFactoryUtils.beansOfTypeIncludingAncestors(ListableBeanFactory, Class)
<T> java.util.Map<java.lang.String,T> getBeansOfType(java.lang.Class<T> type, boolean includeNonSingletons, boolean allowEagerInit) throws BeansException
getObjectType
の値から判断して、指定されたオブジェクト型(サブクラスを含む)に一致する Bean インスタンスを返します。注: このメソッドは、最上位の Bean のみをイントロスペクトします。指定された型と一致する可能性のあるネストされた Bean もチェックしません。
"allowEagerInit" フラグが設定されている場合は、FactoryBeans によって作成されたオブジェクトを考慮します。つまり、FactoryBeans が初期化されます。FactoryBean によって作成されたオブジェクトが一致しない場合は、生の FactoryBean 自体が型と照合されます。"allowEagerInit" が設定されていない場合は、生の FactoryBeans のみがチェックされます (各 FactoryBean の初期化は必要ありません)。
このファクトリが参加する可能性のある階層を考慮しません。BeanFactoryUtils の beansOfTypeIncludingAncestors
を使用して、祖先ファクトリにも Bean を含めます。
メモ: Bean 定義以外の方法で登録されたシングルトン Bean を無視しません。
このメソッドによって返されるマップは、常に、可能な限り、バックエンド構成での定義順に Bean 名と対応する Bean インスタンスを返す必要があります。
type
- 一致するクラスまたはインターフェース、またはすべての具象 Bean の null
includeNonSingletons
- プロトタイプ Bean またはスコープ Bean も含めるか、シングルトンのみを含めるか (FactoryBeans にも適用)allowEagerInit
- 型チェックのために FactoryBeans (または "factory-bean" 参照を含むファクトリメソッド)によって作成された lazy-init シングルトンとオブジェクトを初期化するかどうか。FactoryBeans は、型を判別するために積極的に初期化する必要があることに注意してください。このフラグに "true" を渡すと、FactoryBeans および "factory-bean" 参照が初期化されることに注意してください。BeansException
- Bean を作成できなかった場合 FactoryBean.getObjectType()
, BeanFactoryUtils.beansOfTypeIncludingAncestors(ListableBeanFactory, Class, boolean, boolean)
java.lang.String[] getBeanNamesForAnnotation(java.lang.Class<? extends java.lang.annotation.Annotation> annotationType)
Class
が指定された Annotation
型を持つ Bean のすべての名前を検索します。annotationType
- 検索するアノテーションの型 java.util.Map<java.lang.String,java.lang.Object> getBeansWithAnnotation(java.lang.Class<? extends java.lang.annotation.Annotation> annotationType) throws BeansException
Class
が指定された Annotation
型を持つすべての Bean を検索し、対応する Bean インスタンスを持つ Bean 名のマップを返します。annotationType
- 検索するアノテーションの型 BeansException
- Bean を作成できなかった場合 <A extends java.lang.annotation.Annotation> A findAnnotationOnBean(java.lang.String beanName, java.lang.Class<A> annotationType) throws NoSuchBeanDefinitionException
annotationType
の Annotation
を見つけ、そのインターフェースとスーパークラスをトラバースします。beanName
- アノテーションを探す Bean の名前 annotationType
- 検索するアノテーションクラス null
NoSuchBeanDefinitionException
- 指定された名前の Bean がない場合