Skip to content

Commit

Permalink
Add JavaDoc to Profiler API
Browse files Browse the repository at this point in the history
  • Loading branch information
Bram Ceulemans committed Aug 19, 2021
1 parent 7d0df33 commit 5ed644b
Showing 1 changed file with 15 additions and 0 deletions.
15 changes: 15 additions & 0 deletions spark-api/src/main/java/me/lucko/spark/api/profiler/Profiler.java
Original file line number Diff line number Diff line change
@@ -1,8 +1,23 @@
package me.lucko.spark.api.profiler;

import org.jetbrains.annotations.Nullable;

public interface Profiler {

/**
* Start the Spark Profiler using a profiler configuration.
* A configuration can be built using {@link ProfilerConfiguration#builder()}.
*
* @param configuration the configuration object
* @return if the profiler started successfully
*/
boolean start(ProfilerConfiguration configuration);

/**
* Stop the currently running profiler.
*
* @return the profiler report or null if no profiler was running.
*/
@Nullable
ProfilerReport stop();
}

0 comments on commit 5ed644b

Please sign in to comment.