Package org.approvej.approve

Class NextToTestPathProvider

java.lang.Object
org.approvej.approve.NextToTestPathProvider
All Implemented Interfaces:
PathProvider
@NullMarked @Deprecated(since="0.8.3", forRemoval=true) public class NextToTestPathProvider extends Object implements PathProvider
Deprecated, for removal: This API element is subject to removal in a future version.
use PathProviderBuilder.nextToTest()/PathProviderBuilder.nextToTestInSubdirectory() instead
A PathProvider that uses a stack trace to determine the paths of the approved and received files.

  • Field Summary

    Fields inherited from interface org.approvej.approve.PathProvider

    APPROVED, DEFAULT_FILENAME_EXTENSION, RECEIVED

  • Method Summary

    Modifier and Type
    Method
    Description
    Path
    approvedPath()
    Deprecated, for removal: This API element is subject to removal in a future version.
    The path of the file containing a previously approved value.
    Path
    directory()
    Deprecated, for removal: This API element is subject to removal in a future version.
    The path of the directory containing the approved and received files.
    NextToTestPathProvider
    filenameExtension(String filenameExtension)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Use the given filenameExtension for the approved and received files.
    NextToTestPathProvider
    inSubdirectory()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Use a subdirectory named after the test class name.
    Path
    receivedPath()
    Deprecated, for removal: This API element is subject to removal in a future version.
    The path of the file containing the latest received value that didn't match the previously approved.

    Methods inherited from class java.lang.Object

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

  • Method Details

    • inSubdirectory

      public NextToTestPathProvider inSubdirectory()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Use a subdirectory named after the test class name.
      Returns:
      this

    • filenameExtension

      public NextToTestPathProvider filenameExtension(String filenameExtension)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Use the given filenameExtension for the approved and received files.
      Parameters:
      filenameExtension - the filename extension to use
      Returns:
      this

    • directory

      public Path directory()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Description copied from interface: PathProvider
      The path of the directory containing the approved and received files.
      Specified by:
      directory in interface PathProvider
      Returns:
      the Path to the directory

    • receivedPath

      public Path receivedPath()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Description copied from interface: PathProvider
      The path of the file containing the latest received value that didn't match the previously approved.
      Specified by:
      receivedPath in interface PathProvider
      Returns:
      the Path to the received file

    • approvedPath

      public Path approvedPath()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Description copied from interface: PathProvider
      The path of the file containing a previously approved value.
      Specified by:
      approvedPath in interface PathProvider
      Returns:
      the Path to the approved file