Package com.yourkit.api

Class Annotations

java.lang.Object

com.yourkit.api.Annotations

public class Annotations
extends Object

Provides access to snapshot annotations. Snapshot annotation is a free-form text description of a snapshot stored directly in the snapshot file. You can see it in the profiler UI in "Summary" tab.

Method Summary

Modifier and Type	Method	Description
static String	readAnnotation(File snapshotFile)
static void	writeAnnotation(File snapshotFile, String annotation)

Methods inherited from class java.lang.Object

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

Method Details

readAnnotation

@Nullable
public static String readAnnotation(@NotNull
 File snapshotFile)

writeAnnotation

public static void writeAnnotation(@NotNull
 File snapshotFile,
 @Nullable
 String annotation)
                            throws Exception

Throws:

Exception