de.flapdoodle.testdoc

Class Recording

java.lang.Object

de.flapdoodle.testdoc.Recording

All Implemented Interfaces:

org.junit.jupiter.api.extension.AfterAllCallback, org.junit.jupiter.api.extension.Extension

public class Recording
extends Object
implements org.junit.jupiter.api.extension.AfterAllCallback

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Recording(TemplateReference templateReference, List<String> testSourceCode, TabSize tabSize)

Method Summary

Modifier and Type	Method and Description
void	afterAll(org.junit.jupiter.api.extension.ExtensionContext extensionContext)
void	begin()
void	begin(String label)
void	end()
void	include(Class<?> clazz, Includes... includeOptions)
void	output(String label, String content)
Recording	replacementNotFoundFallback(BiFunction<String,Set<String>,String> fallback)
void	resource(Class<?> clazz, String resourceName, ResourceFilter... filters)
Recording	resource(String label, Class<?> clazz, String resourceName, ResourceFilter... filters)
protected static Consumer<Runnable>	runWithTemplateConsumer(BiConsumer<String,String> consumer)
Recording	sourceCodeOf(String label, Class<?> clazz, Includes... includeOptions)
Recording	thisMethod(String label) Deprecated.
protected static void	writeResult(String templateName, String renderedTemplate)

Methods inherited from class java.lang.Object

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

Constructor Detail

Recording

protected Recording(TemplateReference templateReference,
                    List<String> testSourceCode,
                    TabSize tabSize)

Method Detail

sourceCodeOf

public Recording sourceCodeOf(String label,
                              Class<?> clazz,
                              Includes... includeOptions)

thisMethod

@Deprecated
public Recording thisMethod(String label)

Deprecated.

use with care, it is not stable, it can happen that the wrong fragment is used

Parameters:

label - name for this segment

resource

public Recording resource(String label,
                          Class<?> clazz,
                          String resourceName,
                          ResourceFilter... filters)

replacementNotFoundFallback

public Recording replacementNotFoundFallback(BiFunction<String,Set<String>,String> fallback)

afterAll

public void afterAll(org.junit.jupiter.api.extension.ExtensionContext extensionContext)
              throws Exception

Specified by:

afterAll in interface org.junit.jupiter.api.extension.AfterAllCallback

Throws:

Exception

writeResult

protected static void writeResult(String templateName,
                                  String renderedTemplate)

include

public void include(Class<?> clazz,
                    Includes... includeOptions)

resource

public void resource(Class<?> clazz,
                     String resourceName,
                     ResourceFilter... filters)

output

public void output(String label,
                   String content)

begin

public void begin()

begin

public void begin(String label)

end

public void end()

runWithTemplateConsumer

protected static Consumer<Runnable> runWithTemplateConsumer(BiConsumer<String,String> consumer)