Index (core 0.9.4 API)

A B C D E F H I J M N O P R S T U V
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form

A

apply(Object) - Method in class org.approvej.print.ToStringPrinter
apply(Object) - Method in class org.approvej.print.ObjectPrinter
apply(String) - Method in class org.approvej.approve.FileApprover
apply(String) - Method in class org.approvej.approve.InplaceApprover
apply(String) - Method in class org.approvej.scrub.RegexScrubber
apply(String) - Method in class org.approvej.scrub.RelativeDateScrubber
apply(PathProvider) - Method in record class org.approvej.review.FileReviewerScript
ApprovalBuilder<T> - Class in org.approvej: A builder to configure an approval for a given value.
ApprovalError - Exception Class in org.approvej: An AssertionError thrown when an approval fails.
ApprovalError(String, String) - Constructor for exception class org.approvej.ApprovalError: Creates an ApprovalError for when the given received value does not match the previouslyApproved.
ApprovalResult - Interface in org.approvej: Interface for results of approvals.
approve(T) - Static method in class org.approvej.ApprovalBuilder: Creates a new builder for the given value.
APPROVED - Static variable in class org.approvej.approve.PathProviderBuilder: The infix of the file containing a previously approved value.
approvedPath() - Method in interface org.approvej.approve.PathProvider: The path of the file containing a previously approved value.
approvedPath(String) - Static method in class org.approvej.approve.PathProviderBuilder: Creates a new PathProvider that uses the given approved path}.
approvedPath(Path) - Static method in class org.approvej.approve.PathProviderBuilder: Creates a new PathProvider that uses the given approved Path.
Approver - Interface in org.approvej.approve: A Consumer that approved a printed value and (optionally) stores the value in some fashion if approved for a later execution.
Approvers - Class in org.approvej.approve: Collection of static methods to create Approver instances.
Approving - Search tag in class org.approvej.ApprovalBuilder: Section

B

basicIsoDates() - Static method in class org.approvej.scrub.Scrubbers: Creates a DateTimeScrubber for basic ISO-8601 dates, like 20190225, or 20190225+02:00.
by(Function<String, ApprovalResult>) - Method in class org.approvej.ApprovalBuilder: Approves the ApprovalBuilder.receivedValue by the given approver.
byFile() - Method in class org.approvej.ApprovalBuilder: Approves the receivedValue by a FileApprover, using a nextToTest PathProviderBuilder, and the used Printer's filenameExtension.
byFile(String) - Method in class org.approvej.ApprovalBuilder: Approves the receivedValue by a FileApprover with an PathProviderBuilder.approvedPath(Path) with the given path to the approved file.
byFile(Path) - Method in class org.approvej.ApprovalBuilder: Approves the receivedValue by a FileApprover with an PathProviderBuilder.approvedPath(Path) with the given Path to the approved file.
byFile(PathProvider) - Method in class org.approvej.ApprovalBuilder: Approves the receivedValue by a FileApprover with the given PathProvider.
byFile(PathProviderBuilder) - Method in class org.approvej.ApprovalBuilder: Approves the receivedValue by a FileApprover with the given PathProviderBuilder.
byValue(String) - Method in class org.approvej.ApprovalBuilder: Approves the value by an InplaceApprover with the given previouslyApproved value.

C

configuration - Static variable in record class org.approvej.Configuration: The loaded Configuration object.
Configuration - Record Class in org.approvej: Central configuration class for ApproveJ.
Configuration(Printer<Object>, FileReviewer) - Constructor for record class org.approvej.Configuration: Creates an instance of a Configuration record class.
ConfigurationError - Exception Class in org.approvej: An error that occurs when there is an issue with loading the Configuration.
ConfigurationError(String) - Constructor for exception class org.approvej.ConfigurationError: Creates a new ConfigurationError with the given message.
ConfigurationError(String, Throwable) - Constructor for exception class org.approvej.ConfigurationError: Creates a new ConfigurationError with the given message and cause.
create(Method) - Static method in interface org.approvej.approve.TestMethod: Tries to create a TestMethod from the given Method.
currentTestMethod() - Static method in class org.approvej.approve.StackTraceTestFinderUtil: Finds the current test method using the stack trace.

D

dateTimeFormat(String) - Static method in class org.approvej.scrub.Scrubbers: Creates DateTimeScrubber to replace date/time strings of the given pattern localized by the default Locale.
dateTimeFormat(String, Locale) - Static method in class org.approvej.scrub.Scrubbers: Creates DateTimeScrubber to replace date/time strings of the given pattern localized by the given locale.
DateTimeScrubber - Class in org.approvej.scrub: Special RegexScrubber to scrub date/time strings described by a DateTimeFormatter pattern like "yyyy-MM-dd" for local dates.
DEFAULT_FILENAME_EXTENSION - Static variable in interface org.approvej.print.Printer: The default filename extension for files that the printed value is written to.
defaultFileReviewer() - Method in record class org.approvej.Configuration: Returns the value of the defaultFileReviewer record component.
defaultPrinter() - Method in record class org.approvej.Configuration: Returns the value of the defaultPrinter record component.
directory() - Method in interface org.approvej.approve.PathProvider: The path of the directory containing the approved and received files.
directory(Path) - Method in class org.approvej.approve.PathProviderBuilder: Set the directory where the approved and received files are stored.

E

equals(Object) - Method in record class org.approvej.approve.FileApprovalResult: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class org.approvej.approve.InplaceApprovalResult: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class org.approvej.approve.TestMethod.JUnitTestMethod: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class org.approvej.approve.TestMethod.SpockTestMethod: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class org.approvej.approve.TestMethod.TestNGTestMethod: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class org.approvej.Configuration: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class org.approvej.review.FileReviewerScript: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class org.approvej.review.FileReviewResult: Indicates whether some other object is "equal to" this one.
EXCLUDED_METHODS - Static variable in class org.approvej.print.ObjectPrinter: A Set of methods that won't be regarded as property getters.

F

file(PathProvider) - Static method in class org.approvej.approve.Approvers: Creates a new Approver that uses the given PathProvider to determine the paths of approved and received files.
FileApprovalResult - Record Class in org.approvej.approve: ApprovalResult for files.
FileApprovalResult(String, String, PathProvider) - Constructor for record class org.approvej.approve.FileApprovalResult: Creates an instance of a FileApprovalResult record class.
FileApprover - Class in org.approvej.approve: Approver that compares the received value with the approved value stored in a file.
filenameAffix(String) - Method in class org.approvej.approve.PathProviderBuilder: Extends the PathProviderBuilder.baseFilename with the given String.
filenameExtension() - Method in interface org.approvej.print.Printer: Returns the suggested filename extension for the printed object.
filenameExtension(String) - Method in class org.approvej.approve.PathProviderBuilder: Creates a new PathProvider with the current values and the given filenameExtension.
FileReviewer - Interface in org.approvej.review: Interface for triggering a review by the user.
FileReviewerScript - Record Class in org.approvej.review: A FileReviewer implementation that executes the given script.
FileReviewerScript(String) - Constructor for record class org.approvej.review.FileReviewerScript: Creates an instance of a FileReviewerScript record class.
FileReviewResult - Record Class in org.approvej.review: Result class for FileReviewers.
FileReviewResult(boolean) - Constructor for record class org.approvej.review.FileReviewResult: Creates an instance of a FileReviewResult record class.
findTestSourcePath(Method) - Static method in class org.approvej.approve.StackTraceTestFinderUtil: Finds the source path of the test method, making the following assumptions: the test class' name is also the name of the source file, the base package is at most 10 levels deep, the filename extension of the file is java, kt, groovy, or scala

H

hashCode() - Method in record class org.approvej.approve.FileApprovalResult: Returns a hash code value for this object.
hashCode() - Method in record class org.approvej.approve.InplaceApprovalResult: Returns a hash code value for this object.
hashCode() - Method in record class org.approvej.approve.TestMethod.JUnitTestMethod: Returns a hash code value for this object.
hashCode() - Method in record class org.approvej.approve.TestMethod.SpockTestMethod: Returns a hash code value for this object.
hashCode() - Method in record class org.approvej.approve.TestMethod.TestNGTestMethod: Returns a hash code value for this object.
hashCode() - Method in record class org.approvej.Configuration: Returns a hash code value for this object.
hashCode() - Method in record class org.approvej.review.FileReviewerScript: Returns a hash code value for this object.
hashCode() - Method in record class org.approvej.review.FileReviewResult: Returns a hash code value for this object.

I

InplaceApprovalResult - Record Class in org.approvej.approve: A simple ApprovalResult, e.g.
InplaceApprovalResult(String, String) - Constructor for record class org.approvej.approve.InplaceApprovalResult: Creates an instance of a InplaceApprovalResult record class.
InplaceApprover - Class in org.approvej.approve: An Approver that checks if the received value is equal to a value given in place.
isoDates() - Static method in class org.approvej.scrub.Scrubbers: Creates a DateTimeScrubber for ISO-8601 dates, like 2019-02-25, or 2019-02-25+02:00.
isoDateTimes() - Static method in class org.approvej.scrub.Scrubbers: Creates a DateTimeScrubber for ISO-8601 date/times, like 2019-02-25T12:34:56, 2019-02-25T12:34:56.123456789, 2019-02-25T12:34:56+02:00, or 2019-02-25T12:34:56.123456789+02:00[Europe/Berlin].
isoDateTimes(Locale) - Static method in class org.approvej.scrub.Scrubbers: Creates a DateTimeScrubber for ISO-8601 date/times, like 2019-02-25T12:34:56, 2019-02-25T12:34:56.123456789, 2019-02-25T12:34:56+02:00, or 2019-02-25T12:34:56.123456789+02:00[Europe/Berlin].
isoInstants() - Static method in class org.approvej.scrub.Scrubbers: Creates a DateTimeScrubber for ISO-8601 instants, like 2019-02-25T12:34:56.123456789+02:00, or 2019-02-25T12:34:56.123456789Z.
isoLocalDates() - Static method in class org.approvej.scrub.Scrubbers: Creates a DateTimeScrubber for ISO-8601 local dates, like 2019-02-25.
isoLocalDateTimes() - Static method in class org.approvej.scrub.Scrubbers: Creates a DateTimeScrubber for ISO-8601 local date/times, like 12:34:56, 12:34:56+02:00, 12:34:56.123456789, or 12:34:56.123456789+02:00.
isoLocalTimes() - Static method in class org.approvej.scrub.Scrubbers: Creates a DateTimeScrubber for ISO-8601 local times, like 12:34:56, or 12:34:56.123456789.
isoOffsetDates() - Static method in class org.approvej.scrub.Scrubbers: Creates a DateTimeScrubber for ISO-8601 offset dates, like 2019-02-25+02:00.
isoOffsetDateTimes() - Static method in class org.approvej.scrub.Scrubbers: Creates a DateTimeScrubber for ISO-8601 offset date/times, like 2019-02-25T12:34:56+02:00, or 2019-02-25T12:34:56.123456789+02:00.
isoOffsetTimes() - Static method in class org.approvej.scrub.Scrubbers: Creates a DateTimeScrubber for ISO-8601 offset times, like 12:34:56+02:00, or 12:34:56.123456789+02:00.
isoOrdinalDates() - Static method in class org.approvej.scrub.Scrubbers: Creates a DateTimeScrubber for ISO-8601 ordinal dates, like 2019-86, or 2019-86+02:00:00.
isoTimes() - Static method in class org.approvej.scrub.Scrubbers: Creates a DateTimeScrubber for ISO-8601 times, like 12:34:56, 12:34:56+02:00, 12:34:56.123456789, or 12:34:56.123456789+02:00.
isoWeekDates() - Static method in class org.approvej.scrub.Scrubbers: Creates a DateTimeScrubber for ISO-8601 week dates, like 2019-W09-1, or 2019-W09-1+02:00:00.
isoZonedDateTimes() - Static method in class org.approvej.scrub.Scrubbers: Creates a DateTimeScrubber for ISO-8601 zoned date/times, like 2019-02-25T12:34:56+02:00, 2019-02-25T12:34:56.123456789+02:00, 2019-02-25T12:34:56+02:00[Europe/Berlin], or 2019-02-25T12:34:56.123456789+02:00[Europe/Berlin].
isoZonedDateTimes(Locale) - Static method in class org.approvej.scrub.Scrubbers: Creates a DateTimeScrubber for ISO-8601 zoned date/times, like 2019-02-25T12:34:56+02:00, 2019-02-25T12:34:56.123456789+02:00, 2019-02-25T12:34:56+02:00[Europe/Berlin], or 2019-02-25T12:34:56.123456789+02:00[Europe/Berlin].

J

JUnitTestMethod(Method) - Constructor for record class org.approvej.approve.TestMethod.JUnitTestMethod: Creates an instance of a JUnitTestMethod record class.

M

method() - Method in record class org.approvej.approve.TestMethod.JUnitTestMethod: Returns the value of the method record component.
method() - Method in interface org.approvej.approve.TestMethod: Returns the Method of the test case.
method() - Method in record class org.approvej.approve.TestMethod.SpockTestMethod: Returns the value of the method record component.
method() - Method in record class org.approvej.approve.TestMethod.TestNGTestMethod: Returns the value of the method record component.

N

named(String) - Method in class org.approvej.ApprovalBuilder: Sets a name for the current approval.
needsApproval() - Method in interface org.approvej.ApprovalResult: Determines if the result needs approval by a human reviewer.
needsReapproval() - Method in record class org.approvej.review.FileReviewResult: Returns the value of the needsReapproval record component.
needsReapproval() - Method in interface org.approvej.review.ReviewResult: Determines if the approval should be reapplied.
nextToTest() - Static method in class org.approvej.approve.PathProviderBuilder: Creates a PathProviderBuilder that uses a stack trace to determine the paths of the approved and received files.
nextToTestInSubdirectory() - Static method in class org.approvej.approve.PathProviderBuilder: Creates a PathProviderBuilder that uses a stack trace to determine the paths of the approved and received files in a subdirectory named after the currect test class simple name.
numbered() - Static method in class org.approvej.scrub.Replacements: Replaces each match with "[scrubbed #]" where '#' is the number of the distinct replacement.
numbered(String) - Static method in class org.approvej.scrub.Replacements: Replaces with "[label #]" where label is the given label and '#' is the number of the distinct replacement.

O

objectPrinter() - Static method in class org.approvej.print.ObjectPrinter: Creates a new ObjectPrinter instance.
ObjectPrinter<T> - Class in org.approvej.print: A generic printer for Java Objects that prints their properties and values one per line.
ObjectPrinter() - Constructor for class org.approvej.print.ObjectPrinter: Creates a new ObjectPrinter instance that prints the given object.
org.approvej - package org.approvej
org.approvej.approve - package org.approvej.approve
org.approvej.print - package org.approvej.print
org.approvej.review - package org.approvej.review
org.approvej.scrub - package org.approvej.scrub

P

pathProvider() - Method in record class org.approvej.approve.FileApprovalResult: Returns the value of the pathProvider record component.
PathProvider - Interface in org.approvej.approve: A provider for the paths of the approved and received files.
PathProviderBuilder - Class in org.approvej.approve: A builder for creating PathProvider instances.
previouslyApproved() - Method in interface org.approvej.ApprovalResult: Returns the previously approved value.
previouslyApproved() - Method in record class org.approvej.approve.FileApprovalResult: Returns the value of the previouslyApproved record component.
previouslyApproved() - Method in record class org.approvej.approve.InplaceApprovalResult: Returns the value of the previouslyApproved record component.
print() - Method in class org.approvej.ApprovalBuilder: Uses the default Printer to convert the ApprovalBuilder.receivedValue to a String.
Printer<T> - Interface in org.approvej.print: A Function that converts an object to a String.
Printing - Search tag in class org.approvej.ApprovalBuilder: Section
printWith(Function<T, String>) - Method in class org.approvej.ApprovalBuilder: Uses the given Function to convert the ApprovalBuilder.receivedValue to a String.
printWith(Printer<T>) - Method in class org.approvej.ApprovalBuilder: Uses the given Printer to convert the ApprovalBuilder.receivedValue to a String.

R

received() - Method in interface org.approvej.ApprovalResult: Returns the received value.
received() - Method in record class org.approvej.approve.FileApprovalResult: Returns the value of the received record component.
received() - Method in record class org.approvej.approve.InplaceApprovalResult: Returns the value of the received record component.
RECEIVED - Static variable in class org.approvej.approve.PathProviderBuilder: The infix of the file containing the latest received value that didn't match the previously approved.
receivedPath() - Method in interface org.approvej.approve.PathProvider: The path of the file containing the latest received value that didn't match the previously approved.
RegexScrubber - Class in org.approvej.scrub: Scrubs a String by replacing all occurrences of a pattern by applying the given replacement Function for each finding.
relativeDates(DateTimeFormatter) - Static method in class org.approvej.scrub.Scrubbers: Creates a Scrubber to replace date strings of the given pattern with relative descriptions, like [today], [yesterday], [2 days from now] , [21 days ago].
RelativeDateScrubber - Class in org.approvej.scrub: Scrubs a String by replacing all occurrences of a date pattern with relative descriptions, like [today], [yesterday], [2 days from now] , [21 days ago].
replacement(String) - Method in class org.approvej.scrub.RegexScrubber: Set the replacement Function always returning the given staticReplacement.
replacement(Function<Integer, Object>) - Method in class org.approvej.scrub.RegexScrubber: Set the replacement Function to be used.
Replacements - Class in org.approvej.scrub: Collection of replacement functions (Functions that take an Integer and return an Object) for use with Scrubbers.
ReviewResult - Interface in org.approvej.review: Interface for results of reviews.
reviewWith(String) - Method in class org.approvej.ApprovalBuilder: Creates a FileReviewerScript from the given script String to trigger if the received value is not equal to the previously approved.
reviewWith(FileReviewer) - Method in class org.approvej.ApprovalBuilder: Sets the given FileReviewer to trigger if the received value is not equal to the previously approved.
rfc1123DateTimes() - Static method in class org.approvej.scrub.Scrubbers: Creates a DateTimeScrubber for RFC-1123 date/times, like Mon, 35 Feb 2019 12:34:56 GMT.

S

script() - Method in record class org.approvej.review.FileReviewerScript: Returns the value of the script record component.
script(String) - Static method in record class org.approvej.review.FileReviewerScript: A FileReviewer implementation that executes the given script.
scrubbedOf(UnaryOperator<T>) - Method in class org.approvej.ApprovalBuilder: Applies the given scrubber to the current ApprovalBuilder.receivedValue.
Scrubber<T> - Interface in org.approvej.scrub: An UnaryOperator that scrubs certain information from a value.
Scrubbers - Class in org.approvej.scrub: Collection of static methods to create Scrubber instances.
Scrubbing - Search tag in class org.approvej.ApprovalBuilder: Section
SIMPLE_TYPES - Static variable in class org.approvej.print.ObjectPrinter: A Set of classes that will be printed directly.
SpockTestMethod(Method) - Constructor for record class org.approvej.approve.TestMethod.SpockTestMethod: Creates an instance of a SpockTestMethod record class.
StackTraceTestFinderUtil - Class in org.approvej.approve: Utility class to find the current test method using the stack trace.
string(String) - Static method in class org.approvej.scrub.Replacements: Replaces each match with the given static replacement string.
stringsMatching(String) - Static method in class org.approvej.scrub.Scrubbers: Creates a RegexScrubber with the given pattern.
stringsMatching(Pattern) - Static method in class org.approvej.scrub.Scrubbers: Creates a RegexScrubber with the given pattern.

T

testAnnotations() - Method in record class org.approvej.approve.TestMethod.JUnitTestMethod
testAnnotations() - Method in record class org.approvej.approve.TestMethod.SpockTestMethod
testAnnotations() - Method in interface org.approvej.approve.TestMethod: Returns all test related Annotations of the TestMethod.
testAnnotations() - Method in record class org.approvej.approve.TestMethod.TestNGTestMethod
testCaseName() - Method in record class org.approvej.approve.TestMethod.JUnitTestMethod
testCaseName() - Method in record class org.approvej.approve.TestMethod.SpockTestMethod
testCaseName() - Method in interface org.approvej.approve.TestMethod: Returns the name of the test case.
testCaseName() - Method in record class org.approvej.approve.TestMethod.TestNGTestMethod
testClass() - Method in record class org.approvej.approve.TestMethod.JUnitTestMethod
testClass() - Method in record class org.approvej.approve.TestMethod.SpockTestMethod
testClass() - Method in interface org.approvej.approve.TestMethod: Returns the Class of the TestMethod.
testClass() - Method in record class org.approvej.approve.TestMethod.TestNGTestMethod
TestMethod - Interface in org.approvej.approve: Represents a test method in a test class.
TestMethod.JUnitTestMethod - Record Class in org.approvej.approve: TestMethod implementation for JUnit/JUnit5.
TestMethod.SpockTestMethod - Record Class in org.approvej.approve: TestMethod implementation for Spock.
TestMethod.TestNGTestMethod - Record Class in org.approvej.approve: TestMethod implementation for TestNG.
TestNGTestMethod(Method) - Constructor for record class org.approvej.approve.TestMethod.TestNGTestMethod: Creates an instance of a TestNGTestMethod record class.
throwIfNotApproved() - Method in interface org.approvej.ApprovalResult: Throws an ApprovalError if ApprovalResult.needsApproval() returns true.
toString() - Method in record class org.approvej.approve.FileApprovalResult: Returns a string representation of this record class.
toString() - Method in record class org.approvej.approve.InplaceApprovalResult: Returns a string representation of this record class.
toString() - Method in record class org.approvej.approve.TestMethod.JUnitTestMethod: Returns a string representation of this record class.
toString() - Method in record class org.approvej.approve.TestMethod.SpockTestMethod: Returns a string representation of this record class.
toString() - Method in record class org.approvej.approve.TestMethod.TestNGTestMethod: Returns a string representation of this record class.
toString() - Method in record class org.approvej.Configuration: Returns a string representation of this record class.
toString() - Method in record class org.approvej.review.FileReviewerScript: Returns a string representation of this record class.
toString() - Method in record class org.approvej.review.FileReviewResult: Returns a string representation of this record class.
ToStringPrinter - Class in org.approvej.print: A simple Printer implementation that uses the Object.toString() method.
ToStringPrinter() - Constructor for class org.approvej.print.ToStringPrinter: Creates a new ToStringPrinter.

U

uuids() - Static method in class org.approvej.scrub.Scrubbers: RegexScrubber for UUIDs.

V

value(String) - Static method in class org.approvej.approve.Approvers: Creates a Approver using the given previouslyApproved value.

A B C D E F H I J M N O P R S T U V
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form