Package com.broadleafcommerce.common.extension.data

Class DataRouteReference

java.lang.Object

com.broadleafcommerce.common.extension.data.DataRouteReference

public class DataRouteReference
extends Object

Utility class used to filter routable concepts.

Author:

Jeff Fischer

Constructor Summary

Constructors

Constructor	Description
DataRouteReference(List<PackageDataRouteSupplier<DataRouteSupporting>> routeSuppliers, List<RepositoryDataRouteSupplier<DataRouteSupporting>> repositoryRouteSuppliers, List<DomainClassSupplier<DataRouteSupporting>> domainSuppliers)

Method Summary

Modifier and Type	Method	Description
protected boolean	canEqual(Object other)
boolean	equals(Object o)
Optional<List<Class<?>>>	findDomainClassesByRoute(Class<?> routeClass)	Given an example class, find any available scanned entity classes associated with the route.
Optional<DataRouteSupporting>	findRouteByExample(Class<?> exampleClass)	Given an example class, find a matching instance based on PackageDataRouteSupplier.PackageMapping.packageFragment(), if available.
Optional<DataRouteSupporting>	findRouteByExample(String routePartition)	Given an example package fragment, find a matching instance based on PackageDataRouteSupplier.PackageMapping.packageFragment(), if available.
DataRouteSupporting	findRouteByKey(String key)	Given a known route key, find a matching instance based on DataRouteSupporting.getLookupKey().
Optional<List<DataRouteSupporting>>	findRoutesByRepository(Class<?> repositoryClass)	Filter all routes associated with a DataRouteSupporting extension that are handled by a given repository.
Set<DataRouteSupporting>	findSupportingRoutesByExample(Class<?> exampleClass)	Given an example class, find one or more matching instances based on PackageDataRouteSupplier.PackageMapping.packageFragment(), if available.
Set<DataRouteSupporting>	findSupportingRoutesByExample(String routePartition)	Given an example package fragment, find one or more matching instances based on PackageDataRouteSupplier.PackageMapping.packageFragment(), if available.
List<DomainClassSupplier<DataRouteSupporting>>	getDomainSuppliers()
Map<Class<?>,String>	getPackageFragmentByRoute()
List<RepositoryDataRouteSupplier<DataRouteSupporting>>	getRepositoryRouteSuppliers()
List<PackageDataRouteSupplier<DataRouteSupporting>>	getRouteSuppliers()
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

DataRouteReference

public DataRouteReference(List<PackageDataRouteSupplier<DataRouteSupporting>> routeSuppliers,
 List<RepositoryDataRouteSupplier<DataRouteSupporting>> repositoryRouteSuppliers,
 List<DomainClassSupplier<DataRouteSupporting>> domainSuppliers)

Method Details

findRouteByKey

public DataRouteSupporting findRouteByKey(String key)

Given a known route key, find a matching instance based on DataRouteSupporting.getLookupKey().

Parameters:

key - The known rout key.

Returns:

The filtered DataRouteSupporting

findRouteByExample

public Optional<DataRouteSupporting> findRouteByExample(Class<?> exampleClass)

Given an example class, find a matching instance based on PackageDataRouteSupplier.PackageMapping.packageFragment(), if available.

Parameters:

exampleClass - Class whose package name is used to identify a valid DataRouteSupporting instance.

Returns:

Filtered DataRouteSupporting instance, if found.

findRouteByExample

public Optional<DataRouteSupporting> findRouteByExample(String routePartition)

Given an example package fragment, find a matching instance based on PackageDataRouteSupplier.PackageMapping.packageFragment(), if available.

Parameters:

routePartition - Package fragment used to identify a valid DataRouteSupporting instance.

Returns:

Filtered DataRouteSupporting instance, if found.

findSupportingRoutesByExample

public Set<DataRouteSupporting> findSupportingRoutesByExample(Class<?> exampleClass)

Given an example class, find one or more matching instances based on PackageDataRouteSupplier.PackageMapping.packageFragment(), if available.

Parameters:

exampleClass - Class whose package name is used to identify valid DataRouteSupporting instances.

Returns:

Filtered DataRouteSupporting instances.

findSupportingRoutesByExample

public Set<DataRouteSupporting> findSupportingRoutesByExample(String routePartition)

Given an example package fragment, find one or more matching instances based on PackageDataRouteSupplier.PackageMapping.packageFragment(), if available.

Parameters:

routePartition - Package fragment used to identify valid DataRouteSupporting instances.

Returns:

Filtered DataRouteSupporting instances.

findRoutesByRepository

public Optional<List<DataRouteSupporting>> findRoutesByRepository(Class<?> repositoryClass)

Filter all routes associated with a DataRouteSupporting extension that are handled by a given repository. This is generally useful in common libraries that have data interactions. For example, BulkUpdateRepository deals with any BulkDataRouteSupporting data route proxy.

Parameters:

repositoryClass - The specific repository to filter associated data route proxies by.

Returns:

List of one or more DataRouteSupporting proxies, if found.

findDomainClassesByRoute

public Optional<List<Class<?>>> findDomainClassesByRoute(Class<?> routeClass)

Given an example class, find any available scanned entity classes associated with the route.

Parameters:

routeClass - Example class for the route.

Returns:

Any available scanned entity classes associated with the route.

getRouteSuppliers

public List<PackageDataRouteSupplier<DataRouteSupporting>> getRouteSuppliers()

getRepositoryRouteSuppliers

public List<RepositoryDataRouteSupplier<DataRouteSupporting>> getRepositoryRouteSuppliers()

getDomainSuppliers

public List<DomainClassSupplier<DataRouteSupporting>> getDomainSuppliers()

getPackageFragmentByRoute

public Map<Class<?>,String> getPackageFragmentByRoute()

equals

public boolean equals(Object o)

Overrides:

equals in class Object

canEqual

protected boolean canEqual(Object other)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object