SnapshotFile.SnapshotHeader (Snapshot Tests Core 1.5.0 API)

java.lang.Object
- de.skuzzle.test.snapshots.SnapshotFile.SnapshotHeader

Enclosing class:: SnapshotFile

@API(status=EXPERIMENTAL)
public static final class SnapshotFile.SnapshotHeader
extends Object

Field Summary

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`boolean`	`equals(Object obj)`
`static SnapshotFile.SnapshotHeader`	`fromMap(Map<String,String> values)`
`String`	`get(String key)`
`boolean`	`getBoolean(String key, boolean defaultValue)`	Retrieves a boolean header value.
`int`	`getInt(String key)`
`String`	`getOrDefault(String key, String defaultValue)`
`int`	`hashCode()`
`static SnapshotFile.SnapshotHeader`	`readFrom(BufferedReader reader)`
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail
- TEST_CLASS
```
public static final String TEST_CLASS
```
  See Also:
  
  Constant Field Values
- TEST_METHOD
```
public static final String TEST_METHOD
```
  See Also:
  
  Constant Field Values
- SNAPSHOT_NUMBER
```
public static final String SNAPSHOT_NUMBER
```
  See Also:
  
  Constant Field Values
- SNAPSHOT_NAME
```
public static final String SNAPSHOT_NAME
```
  See Also:
  
  Constant Field Values
- DYNAMIC_DIRECTORY
```
@API(status=EXPERIMENTAL,
     since="1.2.2")
public static final 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

fromMap

public static SnapshotFile.SnapshotHeader fromMap(Map<String,String> values)

readFrom

public static SnapshotFile.SnapshotHeader readFrom(BufferedReader reader)
                                            throws IOException

Throws:: IOException

getOrDefault

public String getOrDefault(String key,
                           String defaultValue)

get
```
public String get(String key)
```

getInt
```
public int getInt(String key)
```

getBoolean
```
@API(status=EXPERIMENTAL,
     since="1.2.2")
public boolean getBoolean(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 Object

equals
```
public boolean equals(Object obj)
```
Overrides:

equals in class Object

toString
```
public String toString()
```
Overrides:

toString in class Object