configuration

Class ClassProvider

java.lang.Object

configuration.ClassProvider

public class ClassProvider
extends Object

A functional interface to provide a path to a class given an input string. The origin of the input string can be defined by the ClassProvider.ProvideFrom enum. The Generator uses this to determine merge classes and input classes.

Author:

Daan

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ClassProvider.ProvideFrom Determines what the Generator should provide as input to the ClassProvider to determine the path to the merge class.

Constructor Summary

Constructors

Constructor and Description
ClassProvider() Provider to return the same class as the input class.
ClassProvider(ClassProvider.ProvideFrom provideFrom, java.util.function.Function<String,String> provide) Provider to create a custom path to a class after receiving a path from the given ClassProvider.ProvideFrom.
ClassProvider(String path) Provider to return the class defined by the input path.

Method Summary

Modifier and Type	Method and Description
static ClassProvider	forMavenUnitTestFromInput() Calculates the path of the maven unit test by replacing 'main' with 'test' and replacing '.java' with 'Test.java'.
static ClassProvider	forMavenUnitTestFromParent() Calculates the path of the maven unit test by replacing 'main' with 'test' and replacing '.java' with 'Test.java'.
static ClassProvider	fromInputClass(java.util.function.Function<String,String> provider) Provider to create a custom path to a class after receiving the path to the input class.
static ClassProvider	fromParentMergeClass()
static ClassProvider	fromParentMergeClass(java.util.function.Function<String,String> provider) Provider to create a custom path to a class after receiving the path to the merge class from the parent JavaForgerConfiguration.
String	provide(String path) Calculates the path to the class given the input path.
String	provide(String parentInputClass, String parentMergeClass) Selects one of the 2 input values depending on the ClassProvider.ProvideFrom that was set.
ClassProvider.ProvideFrom	provideFrom() Defines what the provider requires as input to provide the output class.
static ClassProvider	sameAsParentMergeClass() Provider to provide the class to which the parent JavaForgerConfiguration was merged.

Methods inherited from class java.lang.Object

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

Constructor Detail

ClassProvider

public ClassProvider()

Provider to return the same class as the input class.

ClassProvider

public ClassProvider(String path)

Provider to return the class defined by the input path.

Parameters:

path - The path to the class to merge with.

ClassProvider

public ClassProvider(ClassProvider.ProvideFrom provideFrom,
                     java.util.function.Function<String,String> provide)

Provider to create a custom path to a class after receiving a path from the given ClassProvider.ProvideFrom.

Parameters:

provideFrom - The ClassProvider.ProvideFrom defining where the input path should be taken from.

provide - The provider for determining the output path after receiving the input path.

Method Detail

fromInputClass

public static ClassProvider fromInputClass(java.util.function.Function<String,String> provider)

Provider to create a custom path to a class after receiving the path to the input class.

Parameters:

provider - The provider for determining the output path after receiving the input path.

Returns:

new ClassProvider

fromParentMergeClass

public static ClassProvider fromParentMergeClass()

Returns:

The same class as the class to which the parent JavaForgerConfiguration was merged.

fromParentMergeClass

public static ClassProvider fromParentMergeClass(java.util.function.Function<String,String> provider)

Provider to create a custom path to a class after receiving the path to the merge class from the parent JavaForgerConfiguration.

Parameters:

provider - The provider for determining the output path after receiving the input path.

Returns:

new ClassProvider

forMavenUnitTestFromInput

public static ClassProvider forMavenUnitTestFromInput()

Calculates the path of the maven unit test by replacing 'main' with 'test' and replacing '.java' with 'Test.java'.

Returns:

The path to the maven unit test.

forMavenUnitTestFromParent

public static ClassProvider forMavenUnitTestFromParent()

Calculates the path of the maven unit test by replacing 'main' with 'test' and replacing '.java' with 'Test.java'.

Returns:

The path to the maven unit test.

sameAsParentMergeClass

public static ClassProvider sameAsParentMergeClass()

Provider to provide the class to which the parent JavaForgerConfiguration was merged.

Returns:

the parent config merge class

provide

public String provide(String path)

Calculates the path to the class given the input path.

Parameters:

path - The input path.

Returns:

Path to the class defined by this provider.

provide

public String provide(String parentInputClass,
                      String parentMergeClass)

Selects one of the 2 input values depending on the ClassProvider.ProvideFrom that was set. Then uses that input to calculate the new path.

Parameters:

parentInputClass - The input path.

parentMergeClass - Path to the merge class to which the parent JavaForgerConfiguration was merged.

Returns:

Path to the class defined by this provider.

provideFrom

public ClassProvider.ProvideFrom provideFrom()

Defines what the provider requires as input to provide the output class.

Returns:

ClassProvider.ProvideFrom