Top Description Inners Methods
org.springframework.context.annotation

public Interface DeferredImportSelector

extends ImportSelector
Imports
org.springframework.core.type.AnnotationMetadata, org.springframework.lang.Nullable
A variation of ImportSelector that runs after all @Configuration beans have been processed. This type of selector can be particularly useful when the selected imports are @Conditional.

Implementations can also extend the org.springframework.core.Ordered interface or use the org.springframework.core.annotation.Order annotation to indicate a precedence against other DeferredImportSelectors.

Implementations may also provide an import group which can provide additional sorting and filtering logic across different selectors.

Authors
Phillip Webb, Stephane Nicoll
Since
4.0

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static interface
DeferredImportSelector.Group

Interface used to group results from different import selectors.

Method Summary

Modifier and TypeMethod and Description
public default Class<? extends DeferredImportSelector.Group>

Returns:

the import group class, or null if none
getImportGroup()

Return a specific import group.

Inherited from org.springframework.context.annotation.ImportSelector:
getExclusionFilterselectImports

Method Detail

getImportGroupback to summary
public default Class<? extends DeferredImportSelector.Group> getImportGroup()

Return a specific import group.

The default implementations return null for no grouping required.

Returns:Class<? extends DeferredImportSelector.Group>

the import group class, or null if none

Annotations
@Nullable
Since
5.0
org.springframework.context.annotation back to summary

public Interface DeferredImportSelector.Group

Known Direct Implementers
org.springframework.context.annotation.ConfigurationClassParser.DefaultDeferredImportSelectorGroup
Interface used to group results from different import selectors.
Since
5.0

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
DeferredImportSelector.Group.Entry

An entry that holds the AnnotationMetadata of the importing Configuration class and the class name to import.

Method Summary

Modifier and TypeMethod and Description
public void
process(AnnotationMetadata metadata, DeferredImportSelector selector)

Process the AnnotationMetadata of the importing @Configuration class using the specified DeferredImportSelector.

public Iterable<DeferredImportSelector.Group.Entry>
selectImports()

Return the entries of which class(es) should be imported for this group.

Method Detail

processback to summary
public void process(AnnotationMetadata metadata, DeferredImportSelector selector)

Process the AnnotationMetadata of the importing @Configuration class using the specified DeferredImportSelector.

selectImportsback to summary
public Iterable<DeferredImportSelector.Group.Entry> selectImports()

Return the entries of which class(es) should be imported for this group.

org.springframework.context.annotation back to summary

public Class DeferredImportSelector.Group.Entry

extends Object
Class Inheritance
  • java.lang.Object
  • org.springframework.context.annotation.DeferredImportSelector.Group.Entry
An entry that holds the AnnotationMetadata of the importing Configuration class and the class name to import.

Field Summary

Modifier and TypeField and Description
private final String
importClassName

private final AnnotationMetadata
metadata

Constructor Summary

AccessConstructor and Description
public
Entry(AnnotationMetadata metadata, String importClassName)

Method Summary

Modifier and TypeMethod and Description
public boolean
equals(Object
the reference object with which to compare.
other)

Overrides java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

public String
getImportClassName()

Return the fully qualified name of the class to import.

public AnnotationMetadata
getMetadata()

Return the AnnotationMetadata of the importing Configuration class.

public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for this object.

public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.

Inherited from java.lang.Object:
clonefinalizegetClassnotifynotifyAllwaitwaitwait

Field Detail

importClassNameback to summary
private final String importClassName
metadataback to summary
private final AnnotationMetadata metadata

Constructor Detail

Entryback to summary
public Entry(AnnotationMetadata metadata, String importClassName)

Method Detail

equalsback to summary
public boolean equals(Object other)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

  • It is reflexive: for any non-null reference value x, x.equals(x) should return true.
  • It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
  • It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
  • For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters
other:Object

the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations
@Override
getImportClassNameback to summary
public String getImportClassName()

Return the fully qualified name of the class to import.

getMetadataback to summary
public AnnotationMetadata getMetadata()

Return the AnnotationMetadata of the importing Configuration class.

hashCodeback to summary
public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

  • Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
  • If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
  • It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.
Returns:int

a hash code value for this object

Annotations
@Override
toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

Annotations
@Override