ApprovalNamer class abstract
ApprovalNamer
is an abstract class that defines a contract for generating
file names for approved and received files in a test approval process.
This class provides properties and methods for constructing file paths and names dynamically, considering optional configurations like descriptions, subfolder usage, and test name inclusion.
Constructors
Properties
- addTestName → bool
-
Determines whether the test name should be included in the generated file name.
no setter
- approved → String
-
The full path of the approved file.
no setter
- approvedFileName → String
-
The generated file name for the approved file.
no setter
- currentTestName → String
-
Retrieves the current test name to be used in naming the files.
no setter
- description → String?
-
An optional description to append to the file name for clarity.
no setter
- filePath → String?
-
The base file path where the approval and received files will be stored.
Can be
null
if not explicitly set.no setter - hashCode → int
-
The hash code for this object.
no setterinherited
- options → FileNamerOptions?
-
Configuration options that influence how file names are generated.
Can be
null
if default behavior is used.no setter - received → String
-
The full path of the received file.
no setter
- receivedFileName → String
-
The generated file name for the received file.
no setter
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- useSubfolder → bool
-
Determines whether files should be placed inside a subfolder.
no setter
Methods
-
copyWith(
{String? filePath, FileNamerOptions? options, bool? addTestName, String? description, bool? useSubfolder}) → ApprovalNamer -
Creates a copy of the current
ApprovalNamer
instance with overridden properties. -
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited