/*
* Copyright 2017-2020 original authors
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package io.micronaut.scheduling.instrument;
import edu.umd.cs.findbugs.annotations.NonNull;
import io.micronaut.core.annotation.Experimental;
Instrumentation represents an ongoing instrumentation with a given context of InvocationInstrumenter
if any. To force cleanup after the invocation, use the instance returned by forceCleanup()
instead, such as:
try (Instrumentation ignored = instrumenter.newInstrumentation().forceCleanup()) {
...
}
Author: lgathy Since: 2.0
/**
* Instrumentation represents an ongoing instrumentation with a given context of {@link InvocationInstrumenter} if any.
* <p/>
* To force cleanup after the invocation, use the instance returned by {@link #forceCleanup()} instead, such as:
* <p/>
* <pre>
* try (Instrumentation ignored = instrumenter.newInstrumentation().forceCleanup()) {
* ...
* }
* </pre>
*
* @author lgathy
* @since 2.0
*/
@Experimental
public interface Instrumentation extends AutoCloseable {
Closes the active instrumentation with cleanup flag.
Params: - cleanup – Whether to enforce cleanup
/**
* Closes the active instrumentation with cleanup flag.
*
* @param cleanup Whether to enforce cleanup
*/
void close(boolean cleanup);
Closes the active instrumentation.
/**
* Closes the active instrumentation.
*/
@Override
default void close() {
close(false);
}
Return an instance which guarantees that cleanup will be forced to the instrumenter upon closing. The returned instance will always invoke close(boolean)
with cleanup=true
even if close(boolean)
gets called with cleanup=false
Returns: a new instance which forces cleanup upon leaving the protected block.
/**
* Return an instance which guarantees that cleanup will be forced to the instrumenter upon closing. The returned
* instance will always invoke {@link #close(boolean)} with {@code cleanup=true}
* even if {@link #close(boolean)} gets called with {@code cleanup=false}
*
* @return a new instance which forces cleanup upon leaving the protected block.
*/
default @NonNull Instrumentation forceCleanup() {
return new Instrumentation() {
@Override
public void close(boolean cleanup) {
Instrumentation.this.close(true);
}
@Override
public void close() {
Instrumentation.this.close(true);
}
@Override
public @NonNull Instrumentation forceCleanup() {
return this;
}
};
}
Returns: an instance which does no instrumentation
/**
* @return an instance which does no instrumentation
*/
static @NonNull Instrumentation noop() {
return NoopInstrumentation.INSTANCE;
}
}