org.cadixdev.bombe.analysis

Class CachingInheritanceProvider

java.lang.Object

org.cadixdev.bombe.analysis.CachingInheritanceProvider

All Implemented Interfaces:

InheritanceProvider

public class CachingInheritanceProvider
extends Object
implements InheritanceProvider

An InheritanceProvider that wraps another InheritanceProvider and caches all requests. If information is needed more than once, use of this class is recommended to improve performance.

Since:

0.3.0

Nested Class Summary

Nested classes/interfaces inherited from interface org.cadixdev.bombe.analysis.InheritanceProvider

InheritanceProvider.ClassInfo

Constructor Summary

Constructors

Constructor and Description
CachingInheritanceProvider(InheritanceProvider provider)

Method Summary

Modifier and Type	Method and Description
Optional<InheritanceProvider.ClassInfo>	provide(String klass) Gets the class information for the given class name, if available.
Optional<InheritanceProvider.ClassInfo>	provide(String klass, Object context) Gets the class information for the given class name and optional context, if available.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CachingInheritanceProvider

public CachingInheritanceProvider(InheritanceProvider provider)

Method Detail

provide

public Optional<InheritanceProvider.ClassInfo> provide(String klass)

Description copied from interface: InheritanceProvider

Gets the class information for the given class name, if available.

Specified by:

provide in interface InheritanceProvider

Parameters:

klass - The class name

Returns:

The class information wrapped in an Optional

provide

public Optional<InheritanceProvider.ClassInfo> provide(String klass,
                                                       Object context)

Description copied from interface: InheritanceProvider

Gets the class information for the given class name and optional context, if available.

The provided context may be used by the InheritanceProvider to avoid looking up the class by its name. The accepted values are specific to each InheritanceProvider; unknown context should be ignored.

Specified by:

provide in interface InheritanceProvider

Parameters:

klass - The class name

context - Additional context related to the class name

Returns:

The class information wrapped in an Optional