Package com.broadleafcommerce.common.extension.data

Annotation Type DataRouteByExample

@Target({TYPE,METHOD})
@Retention(RUNTIME)
@Inherited
@Documented
public @interface DataRouteByExample

This annotation identifies an example class whose package name is used to narrow the appropriate DataRouteSupporting component (for example, a RoutableDataSource in JPA) via a PackageDataRouteSupplier implementation.

This annotation is generally most useful in establishing a route at the beginning of a flow. You will often see it defined at the rest controller level upon entry into the API.

Author:

Jeff Fischer

Required Element Summary

Required Elements

Modifier and Type	Required Element	Description
Class<?>	value	The class that serves as an example of a data route package.

Element Detail

value

Class<?> value

The class that serves as an example of a data route package. The example class' package should start with the data route package fragment.

Returns:

The class that serves as an example of a data route package.