Package de.skuzzle.test.snapshots

Class SnapshotFile.SnapshotHeader

  • Enclosing class:
    SnapshotFile
    @API(status=EXPERIMENTAL)
public static final class SnapshotFile.SnapshotHeader
extends java.lang.Object

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.String DYNAMIC_DIRECTORY
      Stores per snapshot whether it had been taken with a dynamic directory.
      static java.lang.String SNAPSHOT_NAME  
      static java.lang.String SNAPSHOT_NUMBER  
      static java.lang.String TEST_CLASS  
      static java.lang.String TEST_METHOD  

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean equals​(java.lang.Object obj)  
      static SnapshotFile.SnapshotHeader fromMap​(java.util.Map<java.lang.String,​java.lang.String> values)  
      java.lang.String get​(java.lang.String key)  
      boolean getBoolean​(java.lang.String key, boolean defaultValue)
      Retrieves a boolean header value.
      int getInt​(java.lang.String key)  
      java.lang.String getOrDefault​(java.lang.String key, java.lang.String defaultValue)  
      int hashCode()  
      int lineNumberOffset()
      Returns the number of lines (including the blank separator line) that the header information are taking at the beginning of the snapshot file.
      static SnapshotFile.SnapshotHeader readFrom​(java.io.BufferedReader reader)  
      java.lang.String toString()  

      • Methods inherited from class java.lang.Object

        clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    • Field Detail

      • DYNAMIC_DIRECTORY

        @API(status=EXPERIMENTAL,
     since="1.2.2")
public static final java.lang.String DYNAMIC_DIRECTORY
        Stores per snapshot whether it had been taken with a dynamic directory. This information helps to improve static orphan detection.
        Since:
        1.2.2
        See Also:
        Constant Field Values

    • Method Detail

      • readFrom

        public static SnapshotFile.SnapshotHeader readFrom​(java.io.BufferedReader reader)
                                            throws java.io.IOException
        Throws:
        java.io.IOException

      • lineNumberOffset

        @API(status=EXPERIMENTAL,
     since="1.7.1")
public int lineNumberOffset()
        Returns the number of lines (including the blank separator line) that the header information are taking at the beginning of the snapshot file.
        Returns:
        Number of lines in the persisted snapshot file that are taken by header information.

      • getOrDefault

        public java.lang.String getOrDefault​(java.lang.String key,
                                     java.lang.String defaultValue)

      • get

        public java.lang.String get​(java.lang.String key)

      • getInt

        public int getInt​(java.lang.String key)

      • getBoolean

        @API(status=EXPERIMENTAL,
     since="1.2.2")
public boolean getBoolean​(java.lang.String key,
                          boolean defaultValue)
        Retrieves a boolean header value.
        Parameters:
        key - The name of the header to retrieve.
        defaultValue - Default value if no header for that key exists.
        Returns:
        The boolean value.
        Since:
        1.2.2

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object

      • equals

        public boolean equals​(java.lang.Object obj)
        Overrides:
        equals in class java.lang.Object

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object