OpenJDK / amber / amber
changeset 59605:2080e45e61ea
8237014: Missing javadoc for jdk.jfr.Recording(Map)
Reviewed-by: mgronlun, mseledtsov
| author | egahlin |
|---|---|
| date | Tue, 14 Jan 2020 14:17:41 +0100 |
| parents | 8654e0b4763a |
| children | 65bdd314d1ca |
| files | src/jdk.jfr/share/classes/jdk/jfr/Recording.java |
| diffstat | 1 files changed, 15 insertions(+), 0 deletions(-) [+] |
line wrap: on
line diff
--- a/src/jdk.jfr/share/classes/jdk/jfr/Recording.java Tue Jan 14 11:45:29 2020 +0000 +++ b/src/jdk.jfr/share/classes/jdk/jfr/Recording.java Tue Jan 14 14:17:41 2020 +0100 @@ -93,6 +93,21 @@ private final PlatformRecording internal; + /** + * Creates a recording with settings from a map of name-value pairs. + * <p> + * A newly created recording is in the {@link RecordingState#NEW} state. To start + * the recording, invoke the {@link Recording#start()} method. + * + * @throws IllegalStateException if Flight Recorder can't be created (for + * example, if the Java Virtual Machine (JVM) lacks Flight Recorder + * support, or if the file repository can't be created or accessed) + * + * @throws SecurityException If a security manager is used and + * FlightRecorderPermission "accessFlightRecorder" is not set. + * + * @see jdk.jfr + */ public Recording(Map<String, String> settings) { PlatformRecorder r = FlightRecorder.getFlightRecorder().getInternal(); synchronized (r) {