Index (java-snapshot-testing-core 4.2.1 API)

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

A

apply(Object, SnapshotSerializerContext) - Method in class au.com.origin.snapshots.serializers.v1.Base64SnapshotSerializer
apply(Object, SnapshotSerializerContext) - Method in class au.com.origin.snapshots.serializers.v1.ToStringSnapshotSerializer
au.com.origin.snapshots - package au.com.origin.snapshots
au.com.origin.snapshots.annotations - package au.com.origin.snapshots.annotations
au.com.origin.snapshots.comparators - package au.com.origin.snapshots.comparators
au.com.origin.snapshots.comparators.v1 - package au.com.origin.snapshots.comparators.v1
au.com.origin.snapshots.config - package au.com.origin.snapshots.config
au.com.origin.snapshots.exceptions - package au.com.origin.snapshots.exceptions
au.com.origin.snapshots.logging - package au.com.origin.snapshots.logging
au.com.origin.snapshots.reporters - package au.com.origin.snapshots.reporters
au.com.origin.snapshots.reporters.v1 - package au.com.origin.snapshots.reporters.v1
au.com.origin.snapshots.serializers - package au.com.origin.snapshots.serializers
au.com.origin.snapshots.serializers.v1 - package au.com.origin.snapshots.serializers.v1
au.com.origin.snapshots.utils - package au.com.origin.snapshots.utils

B

BASE64 - Enum constant in enum class au.com.origin.snapshots.serializers.SerializerType
Base64SnapshotSerializer - Class in au.com.origin.snapshots.serializers: Deprecated.
Base64SnapshotSerializer - Class in au.com.origin.snapshots.serializers.v1: This Serializer converts a byte[] into a base64 encoded string.
Base64SnapshotSerializer() - Constructor for class au.com.origin.snapshots.serializers.Base64SnapshotSerializer: Deprecated.
Base64SnapshotSerializer() - Constructor for class au.com.origin.snapshots.serializers.v1.Base64SnapshotSerializer

C

cleanup() - Method in class au.com.origin.snapshots.SnapshotFile
comparator(SnapshotComparator) - Method in class au.com.origin.snapshots.Expect: Apply a custom comparator for this snapshot
comparator(String) - Method in class au.com.origin.snapshots.Expect: Apply a custom comparator for this snapshot
compareTo(Snapshot) - Method in class au.com.origin.snapshots.Snapshot
createDebugFile(Snapshot) - Method in class au.com.origin.snapshots.SnapshotFile
createFileIfNotExists(String) - Method in class au.com.origin.snapshots.SnapshotFile

D

delete() - Method in class au.com.origin.snapshots.SnapshotFile
deleteDebugFile() - Method in class au.com.origin.snapshots.SnapshotFile
deprecatedV5(Logger, String) - Static method in class au.com.origin.snapshots.logging.LoggingHelper

E

Expect - Class in au.com.origin.snapshots
Expect() - Constructor for class au.com.origin.snapshots.Expect
expectCondition(Method, Object) - Method in class au.com.origin.snapshots.SnapshotVerifier

F

findFieldByPredicate(Class<?>, Predicate<Field>) - Static method in class au.com.origin.snapshots.utils.ReflectionUtils: Find Field by given predicate.
from(SnapshotContext) - Static method in class au.com.origin.snapshots.SnapshotSerializerContext
fromJson(String) - Static method in class au.com.origin.snapshots.SnapshotHeader

G

getComparator() - Method in class au.com.origin.snapshots.config.PropertyResolvingSnapshotConfig
getComparator() - Method in interface au.com.origin.snapshots.config.SnapshotConfig: Optional Override to supply your own custom comparator function
getDiffString(Patch<String>) - Static method in class au.com.origin.snapshots.reporters.v1.PlainTextSnapshotReporter
getIdentifier() - Method in class au.com.origin.snapshots.Snapshot
getInstance(String) - Static method in enum class au.com.origin.snapshots.SnapshotProperties
getInstances(String) - Static method in enum class au.com.origin.snapshots.SnapshotProperties
getOrThrow(String) - Static method in enum class au.com.origin.snapshots.SnapshotProperties
getOutputDir() - Method in class au.com.origin.snapshots.config.PropertyResolvingSnapshotConfig
getOutputDir() - Method in interface au.com.origin.snapshots.config.SnapshotConfig: The base directory where files get written (excluding package directories) default: "src/test/java"
getOutputFormat() - Method in interface au.com.origin.snapshots.serializers.SnapshotSerializer
getOutputFormat() - Method in class au.com.origin.snapshots.serializers.v1.Base64SnapshotSerializer
getOutputFormat() - Method in class au.com.origin.snapshots.serializers.v1.ToStringSnapshotSerializer
getReporters() - Method in class au.com.origin.snapshots.config.PropertyResolvingSnapshotConfig
getReporters() - Method in interface au.com.origin.snapshots.config.SnapshotConfig: Optional Override to supply your own custom reporter functions Reporters will run in the same sequence as provided.
getSerializer() - Method in class au.com.origin.snapshots.config.PropertyResolvingSnapshotConfig
getSerializer() - Method in interface au.com.origin.snapshots.config.SnapshotConfig: Optional Override to supply your own custom serialization function
getSnapshotConfig() - Method in interface au.com.origin.snapshots.config.SnapshotConfigInjector
getSnapshotDir() - Method in class au.com.origin.snapshots.config.PropertyResolvingSnapshotConfig
getSnapshotDir() - Method in interface au.com.origin.snapshots.config.SnapshotConfig: Subdirectory to store snapshots in

H

header(String, String) - Method in class au.com.origin.snapshots.Expect: Add anything you like to the snapshot header.

I

INSTANCE - Enum constant in enum class au.com.origin.snapshots.SnapshotProperties
isCI() - Method in class au.com.origin.snapshots.config.PropertyResolvingSnapshotConfig
isCI() - Method in interface au.com.origin.snapshots.config.SnapshotConfig: Optional This method is meant to detect if we're running on a CI environment.

J

JSON - Enum constant in enum class au.com.origin.snapshots.serializers.SerializerType
JVM_UPDATE_SNAPSHOTS_PARAMETER - Static variable in interface au.com.origin.snapshots.config.SnapshotConfig: Deprecated.

L

LoggingHelper - Class in au.com.origin.snapshots.logging
LoggingHelper() - Constructor for class au.com.origin.snapshots.logging.LoggingHelper
LogGithubIssueException - Exception in au.com.origin.snapshots.exceptions
LogGithubIssueException(String) - Constructor for exception au.com.origin.snapshots.exceptions.LogGithubIssueException

M

makeAccessible(Field) - Static method in class au.com.origin.snapshots.utils.ReflectionUtils
mask(String, String) - Method in class au.com.origin.snapshots.Expect: Mask all matches of a regular expression in the serialized snapshot body.
matches(Snapshot, Snapshot) - Method in interface au.com.origin.snapshots.comparators.SnapshotComparator
matches(Snapshot, Snapshot) - Method in class au.com.origin.snapshots.comparators.v1.PlainTextEqualsComparator
MissingSnapshotPropertiesKeyException - Exception in au.com.origin.snapshots.exceptions
MissingSnapshotPropertiesKeyException(String) - Constructor for exception au.com.origin.snapshots.exceptions.MissingSnapshotPropertiesKeyException

O

of(SnapshotVerifier, Method) - Static method in class au.com.origin.snapshots.Expect

P

parse(String) - Static method in class au.com.origin.snapshots.Snapshot
PlainTextEqualsComparator - Class in au.com.origin.snapshots.comparators: Deprecated.
PlainTextEqualsComparator - Class in au.com.origin.snapshots.comparators.v1
PlainTextEqualsComparator() - Constructor for class au.com.origin.snapshots.comparators.PlainTextEqualsComparator: Deprecated.
PlainTextEqualsComparator() - Constructor for class au.com.origin.snapshots.comparators.v1.PlainTextEqualsComparator
PlainTextSnapshotReporter - Class in au.com.origin.snapshots.reporters: Deprecated.
PlainTextSnapshotReporter - Class in au.com.origin.snapshots.reporters.v1
PlainTextSnapshotReporter() - Constructor for class au.com.origin.snapshots.reporters.PlainTextSnapshotReporter: Deprecated.
PlainTextSnapshotReporter() - Constructor for class au.com.origin.snapshots.reporters.v1.PlainTextSnapshotReporter
PropertyResolvingSnapshotConfig - Class in au.com.origin.snapshots.config
PropertyResolvingSnapshotConfig() - Constructor for class au.com.origin.snapshots.config.PropertyResolvingSnapshotConfig
pushDebugSnapshot(Snapshot) - Method in class au.com.origin.snapshots.SnapshotFile
pushSnapshot(Snapshot) - Method in class au.com.origin.snapshots.SnapshotFile

R

raw() - Method in class au.com.origin.snapshots.Snapshot: The raw string representation of the snapshot as it would appear in the *.snap file.
ReflectionUtils - Class in au.com.origin.snapshots.utils
ReflectionUtils() - Constructor for class au.com.origin.snapshots.utils.ReflectionUtils
report(Snapshot, Snapshot) - Method in interface au.com.origin.snapshots.reporters.SnapshotReporter
report(Snapshot, Snapshot) - Method in class au.com.origin.snapshots.reporters.v1.PlainTextSnapshotReporter
reporters(SnapshotReporter...) - Method in class au.com.origin.snapshots.Expect: Apply a list of custom reporters for this snapshot This will replace the default reporters defined in the config
reporters(String) - Method in class au.com.origin.snapshots.Expect: Apply a list of custom reporters for this snapshot This will replace the default reporters defined in the config
ReservedWordException - Exception in au.com.origin.snapshots.exceptions
ReservedWordException(String) - Constructor for exception au.com.origin.snapshots.exceptions.ReservedWordException
ReservedWordException(String, String, List<String>) - Constructor for exception au.com.origin.snapshots.exceptions.ReservedWordException

S

scenario(String) - Method in class au.com.origin.snapshots.Expect: Normally a snapshot can be applied only once to a test method.
serializer(SnapshotSerializer) - Method in class au.com.origin.snapshots.Expect: Apply a custom serializer for this snapshot
serializer(Class<? extends SnapshotSerializer>) - Method in class au.com.origin.snapshots.Expect: Apply a custom serializer for this snapshot.
serializer(String) - Method in class au.com.origin.snapshots.Expect: Apply a custom serializer for this snapshot
SerializerType - Enum Class in au.com.origin.snapshots.serializers
Snapshot - Class in au.com.origin.snapshots
Snapshot() - Constructor for class au.com.origin.snapshots.Snapshot
SnapshotComparator - Interface in au.com.origin.snapshots.comparators
SnapshotConfig - Interface in au.com.origin.snapshots.config: Snapshot Configuration ----------------------
SnapshotConfigInjector - Interface in au.com.origin.snapshots.config
SnapshotContext - Class in au.com.origin.snapshots
SnapshotExtensionException - Exception in au.com.origin.snapshots.exceptions
SnapshotExtensionException(String) - Constructor for exception au.com.origin.snapshots.exceptions.SnapshotExtensionException
SnapshotExtensionException(String, Throwable) - Constructor for exception au.com.origin.snapshots.exceptions.SnapshotExtensionException
SnapshotFile - Class in au.com.origin.snapshots
SnapshotFile(String, String, Class<?>) - Constructor for class au.com.origin.snapshots.SnapshotFile
SnapshotHeader - Class in au.com.origin.snapshots
SnapshotHeader() - Constructor for class au.com.origin.snapshots.SnapshotHeader
SnapshotMatchException - Error in au.com.origin.snapshots.exceptions
SnapshotMatchException(String) - Constructor for error au.com.origin.snapshots.exceptions.SnapshotMatchException
SnapshotMatchException(String, Throwable) - Constructor for error au.com.origin.snapshots.exceptions.SnapshotMatchException
SnapshotMatchException(String, List<Throwable>) - Constructor for error au.com.origin.snapshots.exceptions.SnapshotMatchException
SnapshotName - Annotation Interface in au.com.origin.snapshots.annotations
SnapshotProperties - Enum Class in au.com.origin.snapshots
SnapshotReporter - Interface in au.com.origin.snapshots.reporters
SnapshotSerializer - Interface in au.com.origin.snapshots.serializers
SnapshotSerializerContext - Class in au.com.origin.snapshots: Contains details of the pending snapshot that can be modified in the Serializer prior to calling toSnapshot().
SnapshotSerializerContext() - Constructor for class au.com.origin.snapshots.SnapshotSerializerContext
SnapshotVerifier - Class in au.com.origin.snapshots
SnapshotVerifier(SnapshotConfig, Class<?>) - Constructor for class au.com.origin.snapshots.SnapshotVerifier
SnapshotVerifier(SnapshotConfig, Class<?>, boolean) - Constructor for class au.com.origin.snapshots.SnapshotVerifier: Instantiate before any tests have run for a given class
SPLIT_STRING - Static variable in class au.com.origin.snapshots.SnapshotFile
supportsFormat(String) - Method in interface au.com.origin.snapshots.reporters.SnapshotReporter
supportsFormat(String) - Method in class au.com.origin.snapshots.reporters.v1.PlainTextSnapshotReporter

T

TEXT - Enum constant in enum class au.com.origin.snapshots.serializers.SerializerType
toJson() - Method in class au.com.origin.snapshots.SnapshotHeader
toMatchSnapshot() - Method in class au.com.origin.snapshots.SnapshotContext
toMatchSnapshot(Object) - Method in class au.com.origin.snapshots.Expect: Make an assertion on the given input parameters against what already exists
toSnapshot(String) - Method in class au.com.origin.snapshots.SnapshotSerializerContext
toString() - Method in class au.com.origin.snapshots.Snapshot
ToStringSnapshotSerializer - Class in au.com.origin.snapshots.serializers: Deprecated.
ToStringSnapshotSerializer - Class in au.com.origin.snapshots.serializers.v1: This Serializer does a snapshot of the Object.toString() method
ToStringSnapshotSerializer() - Constructor for class au.com.origin.snapshots.serializers.ToStringSnapshotSerializer: Deprecated.
ToStringSnapshotSerializer() - Constructor for class au.com.origin.snapshots.serializers.v1.ToStringSnapshotSerializer

U

updateSnapshot() - Method in class au.com.origin.snapshots.config.PropertyResolvingSnapshotConfig
updateSnapshot() - Method in interface au.com.origin.snapshots.config.SnapshotConfig: Optional
UseSnapshotConfig - Annotation Interface in au.com.origin.snapshots.annotations

V

validateSnapshots() - Method in class au.com.origin.snapshots.SnapshotVerifier
value() - Element in annotation interface au.com.origin.snapshots.annotations.SnapshotName
value() - Element in annotation interface au.com.origin.snapshots.annotations.UseSnapshotConfig
valueOf(String) - Static method in enum class au.com.origin.snapshots.serializers.SerializerType: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class au.com.origin.snapshots.SnapshotProperties: Returns the enum constant of this class with the specified name.
values() - Static method in enum class au.com.origin.snapshots.serializers.SerializerType: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class au.com.origin.snapshots.SnapshotProperties: Returns an array containing the constants of this enum class, in the order they are declared.

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