Index (Approvals-Java 0.6.0 API)

A B C D E F G H I J K L M N O P R S T V W

A

active - Variable in enum com.github.writethemfirst.approvals.reporters.SupportedOs
apply(IN1) - Method in interface com.github.writethemfirst.approvals.utils.functions.Function1: Applies the function to the provided argument and returns the result.
apply(IN1, IN2) - Method in interface com.github.writethemfirst.approvals.utils.functions.Function2: Applies the function to the provided arguments and returns the result.
apply(IN1, IN2, IN3) - Method in interface com.github.writethemfirst.approvals.utils.functions.Function3: Applies the function to the provided arguments and returns the result.
apply(IN1, IN2, IN3, IN4) - Method in interface com.github.writethemfirst.approvals.utils.functions.Function4: Applies the function to the provided arguments and returns the result.
apply(IN1, IN2, IN3, IN4, IN5) - Method in interface com.github.writethemfirst.approvals.utils.functions.Function5: Applies the function to the provided arguments and returns the result.
applyCombinations(Iterable<IN1>, Function1<IN1, ?>) - Static method in class com.github.writethemfirst.approvals.utils.FunctionUtils: Applies the provided function to all combinations of all the provided arguments for the function, and returns the produced results as a String.
applyCombinations(Iterable<IN1>, Iterable<IN2>, Function2<IN1, IN2, ?>) - Static method in class com.github.writethemfirst.approvals.utils.FunctionUtils: Applies the provided function to all combinations of all the provided arguments for the function, and returns the produced results as a String.
applyCombinations(Iterable<IN1>, Iterable<IN2>, Iterable<IN3>, Function3<IN1, IN2, IN3, ?>) - Static method in class com.github.writethemfirst.approvals.utils.FunctionUtils: Applies the provided function to all combinations of all the provided arguments for the function, and returns the produced results as a String.
applyCombinations(Iterable<IN1>, Iterable<IN2>, Iterable<IN3>, Iterable<IN4>, Function4<IN1, IN2, IN3, IN4, ?>) - Static method in class com.github.writethemfirst.approvals.utils.FunctionUtils: Applies the provided function to all combinations of all the provided arguments for the function, and returns the produced results as a String.
applyCombinations(Iterable<IN1>, Iterable<IN2>, Iterable<IN3>, Iterable<IN4>, Iterable<IN5>, Function5<IN1, IN2, IN3, IN4, IN5, ?>) - Static method in class com.github.writethemfirst.approvals.utils.FunctionUtils: Applies the provided function to all combinations of all the provided arguments for the function, and returns the produced results as a String.
ApprovalFiles - Class in com.github.writethemfirst.approvals.files: ApprovalFiles
ApprovalFiles(Path, String) - Constructor for class com.github.writethemfirst.approvals.files.ApprovalFiles: Constructs a pair of approval entries from the provided folder and method name.
ApprovalFiles(Path, Path) - Constructor for class com.github.writethemfirst.approvals.files.ApprovalFiles
ApprovalFolders - Class in com.github.writethemfirst.approvals.files: ApprovalFolders is similar to ApprovalFiles : it holds a pair of Paths, approved and received.
ApprovalFolders(Path, String) - Constructor for class com.github.writethemfirst.approvals.files.ApprovalFolders: Constructs a pair of approval entries from the provided folder and method name.
Approvals - Class in com.github.writethemfirst.approvals
approved - Variable in class com.github.writethemfirst.approvals.files.ApprovalFiles: Path to an approved entry.
approvedContent() - Method in class com.github.writethemfirst.approvals.files.ApprovalFiles
Approver - Class in com.github.writethemfirst.approvals.approvers: # Approvals
Approver() - Constructor for class com.github.writethemfirst.approvals.approvers.Approver: Standard approvals, with default Reporter and file name detected from the test class used to apply the constructor and the test method used to apply a Approver.verify(Object) method.
ARAXIS - Static variable in interface com.github.writethemfirst.approvals.reporters.windows.Windows

B

BEYOND_COMPARE - Static variable in interface com.github.writethemfirst.approvals.reporters.linux.Linux
BEYOND_COMPARE_3 - Static variable in interface com.github.writethemfirst.approvals.reporters.windows.Windows
BEYOND_COMPARE_4 - Static variable in interface com.github.writethemfirst.approvals.reporters.windows.Windows

C

callerClass(Class<?>...) - Static method in class com.github.writethemfirst.approvals.utils.StackUtils: Returns the caller class of the first potential reference class found by searching the current thread stacktrace.
callerMethod(Class<?>) - Static method in class com.github.writethemfirst.approvals.utils.StackUtils: Returns the caller method of the provided referenceClass.
cleanupReceivedFiles() - Method in class com.github.writethemfirst.approvals.files.MatchesAndMismatches
CODE_COMPARE - Static variable in interface com.github.writethemfirst.approvals.reporters.windows.Windows
com.github.writethemfirst.approvals - package com.github.writethemfirst.approvals: Approvals Package
com.github.writethemfirst.approvals.approvers - package com.github.writethemfirst.approvals.approvers: Approvers Package
com.github.writethemfirst.approvals.files - package com.github.writethemfirst.approvals.files: Files Package
com.github.writethemfirst.approvals.reporters - package com.github.writethemfirst.approvals.reporters: Reporters Package
com.github.writethemfirst.approvals.reporters.linux - package com.github.writethemfirst.approvals.reporters.linux: Linux Reporters Package
com.github.writethemfirst.approvals.reporters.macos - package com.github.writethemfirst.approvals.reporters.macos: # Mac OS Reporters Package *Approvals-Java* aims at using available merge tools on the developer's workstation in order to review and approve the differences between the *approval files*.
com.github.writethemfirst.approvals.reporters.windows - package com.github.writethemfirst.approvals.reporters.windows: Windows Reporters Package
com.github.writethemfirst.approvals.utils - package com.github.writethemfirst.approvals.utils: Utils Package
com.github.writethemfirst.approvals.utils.functions - package com.github.writethemfirst.approvals.utils.functions: Functions Package
Command - Class in com.github.writethemfirst.approvals.reporters.windows: Wrapper around an executable command outside the JVM.
Command(String, String) - Constructor for class com.github.writethemfirst.approvals.reporters.windows.Command: Represents the latest version of the executable found by scanning subfolders of path.
CommandReporter - Class in com.github.writethemfirst.approvals.reporters.windows: A reporter which delegates execution to an external command.
CommandReporter(Command) - Constructor for class com.github.writethemfirst.approvals.reporters.windows.CommandReporter
CommandReporter(Command, String) - Constructor for class com.github.writethemfirst.approvals.reporters.windows.CommandReporter: Constructs the reporter with a single String of arguments, split on spaces.
copy(Path, Path) - Static method in class com.github.writethemfirst.approvals.utils.FileUtils: Copies the content of a file found at a specified Path to another file located at another specified Path.
copyToFolder(Path, Path) - Static method in class com.github.writethemfirst.approvals.utils.FileUtils: Copies the content of a file found at a specified Path to another file located in the specified destinationFolder.
createEmptyApprovedFileIfNeeded() - Method in class com.github.writethemfirst.approvals.files.ApprovalFiles: Creates an empty approval file if it doesn’t exist yet.
createParentDirectories(Path) - Static method in class com.github.writethemfirst.approvals.utils.FileUtils

D

DEFAULT - Static variable in interface com.github.writethemfirst.approvals.Reporter: Global property allowing to retrieve the default reporter for the current execution context.
DEFAULT - Static variable in interface com.github.writethemfirst.approvals.reporters.linux.Linux
DEFAULT - Static variable in interface com.github.writethemfirst.approvals.reporters.linux.MacOs
DEFAULT - Static variable in interface com.github.writethemfirst.approvals.reporters.windows.Windows

E

equals(Object) - Method in class com.github.writethemfirst.approvals.files.ApprovalFiles: Overriding equals to allow filtering of duplicates.

F

FileUtils - Class in com.github.writethemfirst.approvals.utils: FileUtils
FileUtils() - Constructor for class com.github.writethemfirst.approvals.utils.FileUtils
FirstWorkingReporter - Class in com.github.writethemfirst.approvals.reporters: FirstWorkingReporter
FirstWorkingReporter(Reporter...) - Constructor for class com.github.writethemfirst.approvals.reporters.FirstWorkingReporter: Constructs a FirstWorkingReporter with a list of potentially usable reporters
Function1<IN1,OUT> - Interface in com.github.writethemfirst.approvals.utils.functions: Function1
Function2<IN1,IN2,OUT> - Interface in com.github.writethemfirst.approvals.utils.functions: Function2
Function3<IN1,IN2,IN3,OUT> - Interface in com.github.writethemfirst.approvals.utils.functions: Function3
Function4<IN1,IN2,IN3,IN4,OUT> - Interface in com.github.writethemfirst.approvals.utils.functions: Function4
Function5<IN1,IN2,IN3,IN4,IN5,OUT> - Interface in com.github.writethemfirst.approvals.utils.functions: Function5
FunctionUtils - Class in com.github.writethemfirst.approvals.utils: FunctionUtils
FunctionUtils() - Constructor for class com.github.writethemfirst.approvals.utils.FunctionUtils

G

GVIM - Static variable in interface com.github.writethemfirst.approvals.reporters.windows.Windows: Download GVim from http://www.vim.org/download.php

H

hashCode() - Method in class com.github.writethemfirst.approvals.files.ApprovalFiles: Overriding hashCode to allow filtering of duplicates.
haveSameContent() - Method in class com.github.writethemfirst.approvals.files.ApprovalFiles: Checks if both files have the same content (by reading them and comparing the data afterwards).

I

IDEA - Static variable in interface com.github.writethemfirst.approvals.reporters.windows.Windows
IDEA_CE - Static variable in interface com.github.writethemfirst.approvals.reporters.linux.MacOs
IDEA_COMMUNITY - Static variable in interface com.github.writethemfirst.approvals.reporters.linux.Linux
IDEA_COMMUNITY - Static variable in interface com.github.writethemfirst.approvals.reporters.linux.MacOs
IDEA_ULTIMATE - Static variable in interface com.github.writethemfirst.approvals.reporters.linux.Linux
IDEA_ULTIMATE - Static variable in interface com.github.writethemfirst.approvals.reporters.linux.MacOs
isAvailable() - Method in interface com.github.writethemfirst.approvals.Reporter: A Reporter may not be relevant in all contexts, and they should provide some automated checks validating that they’re actually able to perform what they’re supposed to do in the current execution customFiles (like libraries available in the classpath or Diff / Merge programs available on the computer).
isAvailable() - Method in class com.github.writethemfirst.approvals.reporters.FirstWorkingReporter: Checks if a working reporter has been found or not.
isAvailable() - Method in class com.github.writethemfirst.approvals.reporters.JUnit5Reporter: Checks if the JUnit5Reporter.JUNIT5_ASSERTIONS JUnit 5 class we need is present in the classpath.
isAvailable() - Method in class com.github.writethemfirst.approvals.reporters.ThrowsReporter: A ThrowsReporter is considered as always available since it has no external requirements at all.
isAvailable() - Method in class com.github.writethemfirst.approvals.reporters.windows.Command: Tests if an executable file was found in the path.
isAvailable() - Method in class com.github.writethemfirst.approvals.reporters.windows.CommandReporter

J

JUnit5Reporter - Class in com.github.writethemfirst.approvals.reporters: JUnit5Reporter
JUnit5Reporter() - Constructor for class com.github.writethemfirst.approvals.reporters.JUnit5Reporter

K

KDIFF - Static variable in interface com.github.writethemfirst.approvals.reporters.linux.MacOs
KDIFF - Static variable in interface com.github.writethemfirst.approvals.reporters.windows.Windows: Download KDiff3 from https://sourceforge.net/projects/kdiff3/files/

L

Linux - Interface in com.github.writethemfirst.approvals.reporters.linux: Defines Reporters which work on Linux only.
listFiles(Path) - Static method in class com.github.writethemfirst.approvals.utils.FileUtils: Returns a list of all regular files found in a base directory up to a depth of MAX_DEPTH.

M

MacOs - Interface in com.github.writethemfirst.approvals.reporters.linux: Defines Reporters which work on Linux only.
matchesAndMismatches() - Method in class com.github.writethemfirst.approvals.files.ApprovalFolders: Compares the content of files in approved and received folders (only makes sense if approved and received are folders).
MatchesAndMismatches - Class in com.github.writethemfirst.approvals.files: Holds 2 lists of matches (files with same content) and mismatches (different files).
mismatch(ApprovalFiles) - Method in interface com.github.writethemfirst.approvals.Reporter: A Reporter is called whenever a difference is found while comparing the output of a Program Under Tests and the existing approved files linked to the tests.
mismatch(ApprovalFiles) - Method in class com.github.writethemfirst.approvals.reporters.FirstWorkingReporter: Reports a mismatch between the provided approved and received files using the first working reporter found.
mismatch(ApprovalFiles) - Method in class com.github.writethemfirst.approvals.reporters.JUnit5Reporter
mismatch(ApprovalFiles) - Method in class com.github.writethemfirst.approvals.reporters.ThrowsReporter
mismatch(ApprovalFiles) - Method in class com.github.writethemfirst.approvals.reporters.windows.CommandReporter

N

namedArguments(String...) - Method in class com.github.writethemfirst.approvals.approvers.Approver: Specifies a header naming the arguments of the function under test.

O

osDefaultReporter() - Static method in enum com.github.writethemfirst.approvals.reporters.SupportedOs: Identifies the current OS and the associated Reporter.

P

parent() - Method in class com.github.writethemfirst.approvals.files.ApprovalFiles
prepareFolders(Path) - Method in class com.github.writethemfirst.approvals.files.ApprovalFolders: Creates the approved folder and copies files from actual to received folder.

R

received - Variable in class com.github.writethemfirst.approvals.files.ApprovalFiles: Path to an received entry.
receivedContent() - Method in class com.github.writethemfirst.approvals.files.ApprovalFiles
Reporter - Interface in com.github.writethemfirst.approvals: Reporter
reportMismatches(Reporter) - Method in class com.github.writethemfirst.approvals.files.MatchesAndMismatches
reportTo(Reporter) - Method in class com.github.writethemfirst.approvals.approvers.Approver: Specifies the reporter used to report mismatches.
resolve(Path) - Method in class com.github.writethemfirst.approvals.files.ApprovalFolders: Appends to the approved and received paths the name of a file.

S

silentRead(Path) - Static method in class com.github.writethemfirst.approvals.utils.FileUtils: Reads the file located at the specified Path, and returns its content in case the file exists.
silentRecursiveRemove(Path) - Static method in class com.github.writethemfirst.approvals.utils.FileUtils: Removes recursively all elements if path is a directory, then removes path.
silentRecursiveRemove(File) - Static method in class com.github.writethemfirst.approvals.utils.FileUtils: Removes recursively all elements if file is a directory, then removes file.
silentRemove(Path) - Static method in class com.github.writethemfirst.approvals.utils.FileUtils: Removes the file located at the specified Path if it exists.
StackUtils - Class in com.github.writethemfirst.approvals.utils: StackUtils
StackUtils() - Constructor for class com.github.writethemfirst.approvals.utils.StackUtils
SupportedOs - Enum in com.github.writethemfirst.approvals.reporters: SupportedOs

T

testing(Class<?>) - Method in class com.github.writethemfirst.approvals.approvers.Approver: Specifies the testClass to use as a folder name to store approved and received files.
throwMismatches() - Method in class com.github.writethemfirst.approvals.files.MatchesAndMismatches
ThrowsReporter - Class in com.github.writethemfirst.approvals.reporters: ThrowsReporter
ThrowsReporter() - Constructor for class com.github.writethemfirst.approvals.reporters.ThrowsReporter
TORTOISE_SVN - Static variable in interface com.github.writethemfirst.approvals.reporters.windows.Windows: Download TortoiseSVN from https://tortoisesvn.net/downloads.html

V

valueOf(String) - Static method in enum com.github.writethemfirst.approvals.reporters.SupportedOs: Returns the enum constant of this type with the specified name.
values() - Static method in enum com.github.writethemfirst.approvals.reporters.SupportedOs: Returns an array containing the constants of this enum type, in the order they are declared.
verify(Object) - Static method in class com.github.writethemfirst.approvals.Approvals: Compares the actual output of your program (the function’s argument) and the content of the approved file matching with the test method.
verify(Path) - Static method in class com.github.writethemfirst.approvals.Approvals: Compares the actual output of your program (the function’s argument) and the content of the approved file matching with the test method.
verify(Object) - Method in class com.github.writethemfirst.approvals.approvers.Approver: Compares the actual output of your program (the function’s argument) and the content of the approved file matching with the test method.
verify(Path) - Method in class com.github.writethemfirst.approvals.approvers.Approver: Compares the actual output of your program (the function’s argument) and the content of the approved file matching with the test method.
verifyAllCombinations(Iterable<I1>, Function1<I1, ?>) - Static method in class com.github.writethemfirst.approvals.Approvals: Compares the actual output of your program and the content of the approved file matching with the test method (see Approvals.verify(Object) for details).
verifyAllCombinations(I1[], Function1<I1, ?>) - Static method in class com.github.writethemfirst.approvals.Approvals: Compares the actual output of your program and the content of the approved file matching with the test method (see Approvals.verify(Object) for details).
verifyAllCombinations(Iterable<I1>, Iterable<I2>, Function2<I1, I2, ?>) - Static method in class com.github.writethemfirst.approvals.Approvals: Compares the actual output of your program and the content of the approved file matching with the test method (see Approvals.verify(Object) for details).
verifyAllCombinations(I1[], I2[], Function2<I1, I2, ?>) - Static method in class com.github.writethemfirst.approvals.Approvals: Compares the actual output of your program and the content of the approved file matching with the test method (see Approvals.verify(Object) for details).
verifyAllCombinations(Iterable<I1>, Iterable<I2>, Iterable<I3>, Function3<I1, I2, I3, ?>) - Static method in class com.github.writethemfirst.approvals.Approvals: Compares the actual output of your program and the content of the approved file matching with the test method (see Approvals.verify(Object) for details).
verifyAllCombinations(I1[], I2[], I3[], Function3<I1, I2, I3, ?>) - Static method in class com.github.writethemfirst.approvals.Approvals: Compares the actual output of your program and the content of the approved file matching with the test method (see Approvals.verify(Object) for details).
verifyAllCombinations(Iterable<I1>, Iterable<I2>, Iterable<I3>, Iterable<I4>, Function4<I1, I2, I3, I4, ?>) - Static method in class com.github.writethemfirst.approvals.Approvals: Compares the actual output of your program and the content of the approved file matching with the test method (see Approvals.verify(Object) for details).
verifyAllCombinations(I1[], I2[], I3[], I4[], Function4<I1, I2, I3, I4, ?>) - Static method in class com.github.writethemfirst.approvals.Approvals: Compares the actual output of your program and the content of the approved file matching with the test method (see Approvals.verify(Object) for details).
verifyAllCombinations(Iterable<I1>, Iterable<I2>, Iterable<I3>, Iterable<I4>, Iterable<I5>, Function5<I1, I2, I3, I4, I5, ?>) - Static method in class com.github.writethemfirst.approvals.Approvals: Compares the actual output of your program and the content of the approved file matching with the test method (see Approvals.verify(Object) for details).
verifyAllCombinations(I1[], I2[], I3[], I4[], I5[], Function5<I1, I2, I3, I4, I5, ?>) - Static method in class com.github.writethemfirst.approvals.Approvals: Compares the actual output of your program and the content of the approved file matching with the test method (see Approvals.verify(Object) for details).
verifyAllFiles(Path) - Static method in class com.github.writethemfirst.approvals.Approvals: Compares the actual output of your program (files in the folder actualFolder) and the content of the approved “Master” folder matching with the test method.

W

Windows - Interface in com.github.writethemfirst.approvals.reporters.windows: Defines Reporters which work on Windows only.
WINMERGE - Static variable in interface com.github.writethemfirst.approvals.reporters.windows.Windows
write(String, Path) - Static method in class com.github.writethemfirst.approvals.utils.FileUtils: Writes the specified content in the file located at the specified Path.
writeTo(String) - Method in class com.github.writethemfirst.approvals.approvers.Approver: Specifies the name to use for approved and received files.
writeToFolder(String) - Method in class com.github.writethemfirst.approvals.approvers.Approver: Specifies the folder name to store approved and received files.

A B C D E F G H I J K L M N O P R S T V W