Package org.japprove.repositories

Class BaselineRepositoryImpl

java.lang.Object

org.japprove.repositories.BaselineRepositoryImpl

All Implemented Interfaces:

BaselineRepository

public class BaselineRepositoryImpl
extends java.lang.Object
implements BaselineRepository

An implementation of the BaselineRepository with a text file based approach.

Constructor Summary

Constructors

Constructor	Description
BaselineRepositoryImpl(ApprovalTestingConfiguration config)

Method Summary

Modifier and Type	Method	Description
boolean	baselineExists(java.lang.String baselineCandidateName)	Returns true if the baseline exists and false otherwise.
void	copyBaselineCandidateToBaseline(java.lang.String baselineCandidateName)	Copies the content of the baseline candidate to the baseline.
void	createBaselineCandidate(com.fasterxml.jackson.databind.JsonNode data, java.lang.String name)	Creates a new JsonFile and writes the data into this file.
void	createBaselineCandidate(java.lang.String data, java.lang.String name)	Creates a new TextFile and writes the data into this file.
java.io.File	getBaselineAsFile(java.lang.String name)	Returns the content of the baseline in a file.
java.io.File	getBaselineCandidateAsFile(java.lang.String name)	Returns the content of the baseline candidate in a file.
java.util.List<java.lang.String>	getBaselineCandidateNames()	Returns a list of all baseline candidates names.
com.fasterxml.jackson.databind.JsonNode	getContentOfJsonBaseline(java.lang.String baseline)	Returns the content of the requested baseline.
java.lang.String	getContentOfTextBaseline(java.lang.String baseline)	Returns the content of the requested baseline.
java.lang.String	getDifferences(java.lang.String baselineCandidateName)	Computes differences of the baseline candidate and the baseline.
boolean	removeBaselineCandidate(java.lang.String name)	Removes an baseline candidate by its name.

Methods inherited from class java.lang.Object

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

Constructor Details

BaselineRepositoryImpl

public BaselineRepositoryImpl(ApprovalTestingConfiguration config)

Method Details

createBaselineCandidate

public void createBaselineCandidate(java.lang.String data, java.lang.String name) throws BaselineCandidateCreationFailedException

Description copied from interface: BaselineRepository

Creates a new TextFile and writes the data into this file.

Specified by:

createBaselineCandidate in interface BaselineRepository

Parameters:

data - The data that should be stored in the TextFile

name - The name of the current baseline

Throws:

BaselineCandidateCreationFailedException - if the baseline candidate cannot be created

createBaselineCandidate

public void createBaselineCandidate(com.fasterxml.jackson.databind.JsonNode data, java.lang.String name) throws BaselineCandidateCreationFailedException

Description copied from interface: BaselineRepository

Creates a new JsonFile and writes the data into this file.

Specified by:

createBaselineCandidate in interface BaselineRepository

Parameters:

data - The data that should be stored in the JsonFile

name - The name of the current baseline

Throws:

BaselineCandidateCreationFailedException - if the baseline candidate cannot be created

removeBaselineCandidate

public boolean removeBaselineCandidate(java.lang.String name)

Description copied from interface: BaselineRepository

Removes an baseline candidate by its name.

Specified by:

removeBaselineCandidate in interface BaselineRepository

Parameters:

name - the name of the baseline candidate that should be removed

Returns:

true if the baseline candidate has successfully been removed, false otherwise.

getBaselineCandidateNames

public java.util.List<java.lang.String> getBaselineCandidateNames()

Description copied from interface: BaselineRepository

Returns a list of all baseline candidates names.

Specified by:

getBaselineCandidateNames in interface BaselineRepository

Returns:

a list of all baseline candidates names.

getContentOfJsonBaseline

public com.fasterxml.jackson.databind.JsonNode getContentOfJsonBaseline(java.lang.String baseline) throws BaselineNotFoundException

Description copied from interface: BaselineRepository

Returns the content of the requested baseline.

Specified by:

getContentOfJsonBaseline in interface BaselineRepository

Parameters:

baseline - the baseline for which the content should be returned

Returns:

the content of the baseline

Throws:

BaselineNotFoundException - if the baseline cannot be found

getContentOfTextBaseline

public java.lang.String getContentOfTextBaseline(java.lang.String baseline) throws BaselineNotFoundException

Description copied from interface: BaselineRepository

Returns the content of the requested baseline.

Specified by:

getContentOfTextBaseline in interface BaselineRepository

Parameters:

baseline - the baseline for which the content should be returned

Returns:

the content of the baseline

Throws:

BaselineNotFoundException - if the baseline cannot be found

copyBaselineCandidateToBaseline

public void copyBaselineCandidateToBaseline(java.lang.String baselineCandidateName) throws BaselineCandidateNotFoundException, BaselineCreationFailedException, CopyingFailedException

Description copied from interface: BaselineRepository

Copies the content of the baseline candidate to the baseline.

Specified by:

copyBaselineCandidateToBaseline in interface BaselineRepository

Parameters:

baselineCandidateName - the name of the baseline candidate

Throws:

BaselineCandidateNotFoundException - if the candidate of the baseline cannot be found

BaselineCreationFailedException - if the baseline cannot be created

CopyingFailedException - in the case the content of the baseline candidate cannot be copied to the baseline

getDifferences

public java.lang.String getDifferences(java.lang.String baselineCandidateName) throws BaselineCandidateNotFoundException, BaselineNotFoundException

Description copied from interface: BaselineRepository

Computes differences of the baseline candidate and the baseline.

Specified by:

getDifferences in interface BaselineRepository

Parameters:

baselineCandidateName - the name of the baseline candidate

Returns:

a string with the differences

Throws:

BaselineCandidateNotFoundException - if the candidate of the baseline cannot be found

BaselineNotFoundException - if the baseline cannot be found

baselineExists

public boolean baselineExists(java.lang.String baselineCandidateName)

Description copied from interface: BaselineRepository

Returns true if the baseline exists and false otherwise.

Specified by:

baselineExists in interface BaselineRepository

Parameters:

baselineCandidateName - the baseline candidate for which the baseline should be found.

Returns:

true if the baseline exists and false otherwise.

getBaselineCandidateAsFile

public java.io.File getBaselineCandidateAsFile(java.lang.String name) throws java.io.IOException

Description copied from interface: BaselineRepository

Returns the content of the baseline candidate in a file.

Specified by:

getBaselineCandidateAsFile in interface BaselineRepository

Parameters:

name - the name of the baseline candidate.

Returns:

the content of the baseline candidate in a file.

Throws:

java.io.IOException - in the case of problems with the created file.

getBaselineAsFile

public java.io.File getBaselineAsFile(java.lang.String name) throws java.io.IOException

Description copied from interface: BaselineRepository

Returns the content of the baseline in a file.

Specified by:

getBaselineAsFile in interface BaselineRepository

Parameters:

name - the name of the baseline.

Returns:

the content of the baseline in a file.

Throws:

java.io.IOException - in the case of problems with the created file.