org.springframework.boot.neo4j

Annotation Type NodeEntityScan

@Target(value=TYPE)
 @Retention(value=RUNTIME)
 @Documented
 @Import(value=org.springframework.boot.neo4j.NodeEntityScanRegistrar.class)
public @interface NodeEntityScan

Configures the SessionFactory to scan for Neo4J NodeEntity classes in the classpath. This annotation provides an alternative to manually setting SessionFactoryProvider.setPackagesToScan(String...) and is particularly useful if you want to configure entity scanning in a type-safe way, or if your SessionFactory is auto-configured.

A SessionFactoryProvider must be configured within your Spring ApplicationContext in order to use entity scanning. Furthermore, any existing packagesToScan setting will be replaced.

One of basePackageClasses(), basePackages() or its alias value() may be specified to define specific packages to scan. If specific packages are not defined scanning will occur from the package of the class with this annotation.

Since:

1.4.0

Author:

Stephane Nicoll

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
Class<?>[]	basePackageClasses Type-safe alternative to basePackages() for specifying the packages to scan for node entities.
String[]	basePackages Base packages to scan for node entities.
String[]	value Alias for the basePackages() attribute.

Element Detail

value

public abstract String[] value

Alias for the basePackages() attribute. Allows for more concise annotation declarations e.g.: @NodeEntityScan("org.my.pkg") instead of @NodeEntityScan(basePackages="org.my.pkg").

Returns:

the base packages to scan

Default:

{}

basePackages

public abstract String[] basePackages

Base packages to scan for node entities. value() is an alias for (and mutually exclusive with) this attribute.

Use basePackageClasses() for a type-safe alternative to String-based package names.

Returns:

the base packages to scan

Default:

{}

basePackageClasses

public abstract Class<?>[] basePackageClasses

Type-safe alternative to basePackages() for specifying the packages to scan for node entities. The package of each class specified will be scanned.

Consider creating a special no-op marker class or interface in each package that serves no purpose other than being referenced by this attribute.

Returns:

classes from the base packages to scan

Default:

{}