Index (japprove-core 1.2.0 API)

A B C D E F G I J O R S T V W
All Classes All Packages

A

ApprovalTest - Annotation Type in org.japprove.annotations: @ApprovalTest is an extension of the @Test annotation and indicates the annotated test method is used for approval testing.
ApprovalTestingConfiguration - Class in org.japprove.config: A configuration class for approval testing.
ApprovalTestingConfiguration() - Constructor for class org.japprove.config.ApprovalTestingConfiguration
ApprovalTestingEngine - Class in org.japprove.engine: The central part of the approval testing application.
ApprovalTestingEngine(BaselineRepository, ApprovalTestingConfiguration) - Constructor for class org.japprove.engine.ApprovalTestingEngine
ApprovalTestingEngine(BaselineRepository, ApprovalTestingConfiguration, String) - Constructor for class org.japprove.engine.ApprovalTestingEngine
ApprovalTestParameterResolver - Class in org.japprove.parameterresolver: The parent class of the ParameterResolvers.
ApprovalTestParameterResolver() - Constructor for class org.japprove.parameterresolver.ApprovalTestParameterResolver
approveAllBaselineCandidates() - Method in class org.japprove.approver.Approver: Approves all existing baseline candidates at once.
approveBaselineCandidate(String) - Method in class org.japprove.approver.Approver: Approves a baseline candidate by its name.
Approver - Class in org.japprove.approver: A central class that is responsible for approving a new version of a file.
Approver(ApprovalTestingEngine) - Constructor for class org.japprove.approver.Approver
ApprovingFailedException - Exception in org.japprove.exceptions: This Exception is thrown if a unapproved File cannot be approved.
ApprovingFailedException(String) - Constructor for exception org.japprove.exceptions.ApprovingFailedException

B

baseline() - Method in annotation type org.japprove.annotations.ApprovalTest: Allows to specify a name for the baseline.
BaselineCandidateCreationFailedException - Exception in org.japprove.exceptions: This Exception is thrown if a baseline can not be created.
BaselineCandidateCreationFailedException(String) - Constructor for exception org.japprove.exceptions.BaselineCandidateCreationFailedException
BaselineCandidateNotFoundException - Exception in org.japprove.exceptions: This Exception is thrown if a wanted baseline candidate can not be found.
BaselineCandidateNotFoundException(String) - Constructor for exception org.japprove.exceptions.BaselineCandidateNotFoundException
BaselineCreationFailedException - Exception in org.japprove.exceptions: This Exception is thrown if a baseline can not be created.
BaselineCreationFailedException(String) - Constructor for exception org.japprove.exceptions.BaselineCreationFailedException
baselineExists(String) - Method in interface org.japprove.repositories.BaselineRepository: Returns true if the baseline exists and false otherwise.
baselineExists(String) - Method in class org.japprove.repositories.BaselineRepositoryImpl
BaselineNotFoundException - Exception in org.japprove.exceptions: This Exception is thrown if a wanted baseline can not be found.
BaselineNotFoundException(String) - Constructor for exception org.japprove.exceptions.BaselineNotFoundException
BaselineRepository - Interface in org.japprove.repositories: A central administration point for the baselines and the baseline candidates.
BaselineRepositoryImpl - Class in org.japprove.repositories: An implementation of the BaselineRepository with a text file based approach.
BaselineRepositoryImpl(ApprovalTestingConfiguration) - Constructor for class org.japprove.repositories.BaselineRepositoryImpl

C

callExternalDiffTool(String) - Method in class org.japprove.differ.Differ: Computes the differences of the baseline candidate and the baseline by calling an external diff tool.
copyBaselineCandidateToBaseline(String) - Method in interface org.japprove.repositories.BaselineRepository: Copies the content of the baseline candidate to the baseline.
copyBaselineCandidateToBaseline(String) - Method in class org.japprove.repositories.BaselineRepositoryImpl
CopyingFailedException - Exception in org.japprove.exceptions: This Exception is thrown if the content of the baseline candidate cannot be copied to the baseline.
CopyingFailedException(String) - Constructor for exception org.japprove.exceptions.CopyingFailedException
create() - Method in class org.japprove.files.JsonFile: Checks if the File already exists and creates a new one if not.
create() - Method in class org.japprove.files.TextFile: Checks if the File already exists and creates a new one if not.
createBaselineCandidate(JsonNode, String) - Method in interface org.japprove.repositories.BaselineRepository: Creates a new JsonFile and writes the data into this file.
createBaselineCandidate(JsonNode, String) - Method in class org.japprove.repositories.BaselineRepositoryImpl
createBaselineCandidate(String, String) - Method in interface org.japprove.repositories.BaselineRepository: Creates a new TextFile and writes the data into this file.
createBaselineCandidate(String, String) - Method in class org.japprove.repositories.BaselineRepositoryImpl

D

Differ - Class in org.japprove.differ: A central class that is responsible for computing differences of two strings or json nodes.
Differ(ApprovalTestingEngine, String) - Constructor for class org.japprove.differ.Differ
DiffingFailedException - Exception in org.japprove.exceptions: This Exception is thrown if the differences of two Files cannot be computed.
DiffingFailedException(String) - Constructor for exception org.japprove.exceptions.DiffingFailedException

E

exists() - Method in class org.japprove.files.JsonFile: Returns true if this file exists.

F

FileCreationFailedException - Exception in org.japprove.exceptions: This Exception is thrown if a file can not be created.
FileCreationFailedException(String) - Constructor for exception org.japprove.exceptions.FileCreationFailedException

G

getApprover() - Method in class org.japprove.engine.ApprovalTestingEngine: Returns a new Approver.
getBaseline() - Method in class org.japprove.engine.ApprovalTestingEngine: Returns the current baseline.
getBaselineAsFile(String) - Method in interface org.japprove.repositories.BaselineRepository: Returns the content of the baseline in a file.
getBaselineAsFile(String) - Method in class org.japprove.repositories.BaselineRepositoryImpl
getBaselineCandidateAsFile(String) - Method in interface org.japprove.repositories.BaselineRepository: Returns the content of the baseline candidate in a file.
getBaselineCandidateAsFile(String) - Method in class org.japprove.repositories.BaselineRepositoryImpl
getBaselineCandidateDirectory() - Method in class org.japprove.config.ApprovalTestingConfiguration: Returns the path to the baselineCandidate directory.
getBaselineCandidateNames() - Method in interface org.japprove.repositories.BaselineRepository: Returns a list of all baseline candidates names.
getBaselineCandidateNames() - Method in class org.japprove.repositories.BaselineRepositoryImpl
getBaselineDirectory() - Method in class org.japprove.config.ApprovalTestingConfiguration: Returns the path to the baseline directory.
getBaselineRepository() - Method in class org.japprove.engine.ApprovalTestingEngine: Returns the injected BaselineRepository.
getContentOfJsonBaseline(String) - Method in interface org.japprove.repositories.BaselineRepository: Returns the content of the requested baseline.
getContentOfJsonBaseline(String) - Method in class org.japprove.repositories.BaselineRepositoryImpl
getContentOfTextBaseline(String) - Method in interface org.japprove.repositories.BaselineRepository: Returns the content of the requested baseline.
getContentOfTextBaseline(String) - Method in class org.japprove.repositories.BaselineRepositoryImpl
getDiffer() - Method in class org.japprove.engine.ApprovalTestingEngine: Returns a new Differ.
getDifferences(JsonNode, JsonNode) - Method in class org.japprove.differ.Differ: Computes the differences for two passed json nodes.
getDifferences(String) - Method in interface org.japprove.repositories.BaselineRepository: Computes differences of the baseline candidate and the baseline.
getDifferences(String) - Method in class org.japprove.repositories.BaselineRepositoryImpl
getDifferences(String, String) - Method in class org.japprove.differ.Differ: Computes the differences for two passed strings.
getDiffTool() - Method in class org.japprove.config.ApprovalTestingConfiguration: Returns the path to the diff tool.
getJsonVerifier() - Method in class org.japprove.engine.ApprovalTestingEngine: Returns a new JsonVerifier.
getName() - Method in class org.japprove.files.JsonFile: Returns the name of the corresponding TextFile.
getStringVerifier() - Method in class org.japprove.engine.ApprovalTestingEngine: Returns a new StringVerifier.

I

ignore(String) - Method in class org.japprove.verifier.JsonVerifier: Receives a JSONPath that should be ignored on the verification process.

J

JsonFile - Class in org.japprove.files: JsonFile is a wrapper around TextFile that provides functionality to read and write data of JsonFiles.
JsonFile(String) - Constructor for class org.japprove.files.JsonFile
JsonVerifier - Class in org.japprove.verifier: The JsonVerifier provides a method to verify JSON objects within Approval Tests.
JsonVerifier(ApprovalTestingEngine) - Constructor for class org.japprove.verifier.JsonVerifier
JsonVerifierParameterResolver - Class in org.japprove.parameterresolver: JsonVerifierParameterResolver allows to use the JsonVerifier as parameter in Approval Tests.
JsonVerifierParameterResolver() - Constructor for class org.japprove.parameterresolver.JsonVerifierParameterResolver

O

org.japprove.annotations - package org.japprove.annotations
org.japprove.approver - package org.japprove.approver
org.japprove.config - package org.japprove.config
org.japprove.differ - package org.japprove.differ
org.japprove.engine - package org.japprove.engine
org.japprove.exceptions - package org.japprove.exceptions
org.japprove.exceptions.errors - package org.japprove.exceptions.errors
org.japprove.files - package org.japprove.files
org.japprove.parameterresolver - package org.japprove.parameterresolver
org.japprove.repositories - package org.japprove.repositories
org.japprove.verifier - package org.japprove.verifier

R

readData() - Method in class org.japprove.files.JsonFile: Reads the data of the JsonFile and returns a JsonNode.
readData() - Method in class org.japprove.files.TextFile: Reads the data of the TextFile line by line.
removeBaselineCandidate(String) - Method in interface org.japprove.repositories.BaselineRepository: Removes an baseline candidate by its name.
removeBaselineCandidate(String) - Method in class org.japprove.repositories.BaselineRepositoryImpl
resolveParameter(ParameterContext, ExtensionContext) - Method in class org.japprove.parameterresolver.ApprovalTestParameterResolver
resolveParameter(ParameterContext, ExtensionContext) - Method in class org.japprove.parameterresolver.JsonVerifierParameterResolver: Resolve an argument for the JsonVerifier.
resolveParameter(ParameterContext, ExtensionContext) - Method in class org.japprove.parameterresolver.StringVerifierParameterResolver: Resolve an argument for the StringVerifier.

S

startApprovingBatchProcess() - Method in class org.japprove.approver.Approver: Starts a batch process to approve or diff all baseline candidates step by step.
StringVerifier - Class in org.japprove.verifier: The StringVerifier provides methods to verify String objects or String lists within Approval Tests.
StringVerifier(ApprovalTestingEngine) - Constructor for class org.japprove.verifier.StringVerifier
StringVerifierParameterResolver - Class in org.japprove.parameterresolver: StringVerifierParameterResolver allows to use the StringVerifier as parameter in Approval Tests.
StringVerifierParameterResolver() - Constructor for class org.japprove.parameterresolver.StringVerifierParameterResolver
supportsParameter(ParameterContext, ExtensionContext) - Method in class org.japprove.parameterresolver.ApprovalTestParameterResolver
supportsParameter(ParameterContext, ExtensionContext) - Method in class org.japprove.parameterresolver.JsonVerifierParameterResolver: Returns true if the JsonVerifier is supported as a parameter.
supportsParameter(ParameterContext, ExtensionContext) - Method in class org.japprove.parameterresolver.StringVerifierParameterResolver: Returns true if the StringVerifier is supported as a parameter.

T

TextFile - Class in org.japprove.files: An extension of an File that provides functionality to read and write data of TextFile.
TextFile(String) - Constructor for class org.japprove.files.TextFile

V

VerificationFailedError - Error in org.japprove.exceptions.errors: This Error is thrown if a verification of an approval test fails.
VerificationFailedError(String) - Constructor for error org.japprove.exceptions.errors.VerificationFailedError
VerificationFailedException - Exception in org.japprove.exceptions: This Exception is thrown if the differences of two Files cannot be computed.
VerificationFailedException(String) - Constructor for exception org.japprove.exceptions.VerificationFailedException
Verifier - Class in org.japprove.verifier: The parent class of the verifiers.
Verifier(ApprovalTestingEngine) - Constructor for class org.japprove.verifier.Verifier
verify(JsonNode) - Method in class org.japprove.verifier.JsonVerifier: Receives a JsonNode that should be verified within an Approval Test.
verify(String) - Method in class org.japprove.verifier.StringVerifier: Receives a String that should be verified within an Approval Test.
verify(List<String>) - Method in class org.japprove.verifier.StringVerifier: Receives a List of Strings that should be verified within an Approval Test.
VersionNotApprovedError - Error in org.japprove.exceptions.errors: This Error is thrown if no approved version within an approval test exists.
VersionNotApprovedError(String) - Constructor for error org.japprove.exceptions.errors.VersionNotApprovedError

W

writeData(JsonNode) - Method in class org.japprove.files.JsonFile: Stores a JsonNode in the JsonFile.
writeData(String) - Method in class org.japprove.files.TextFile: Stores a String in the TextFile.

A B C D E F G I J O R S T V W
All Classes All Packages