1 /* 2 * Copyright 2022 Carl Mastrangelo 3 * 4 * Licensed under the Apache License, Version 2.0 (the "License"); 5 * you may not use this file except in compliance with the License. 6 * You may obtain a copy of the License at 7 * 8 * http://www.apache.org/licenses/LICENSE-2.0 9 * 10 * Unless required by applicable law or agreed to in writing, software 11 * distributed under the License is distributed on an "AS IS" BASIS, 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 * See the License for the specific language governing permissions and 14 * limitations under the License. 15 */ 16 17 package io.perfmark.impl; 18 19 /** 20 * A local MarkHolder is a class that gets the "current" MarkHolder based on context. For example, a thread local 21 * MarkHolder could use this class to pull the local MarkHolder from the threadlocal variable. Other implementations 22 * are possible as well. 23 */ 24 public abstract class LocalMarkHolder { 25 26 /** 27 * Removes the local markholder storage. 28 */ clear()29 public abstract void clear(); 30 31 /** 32 * Get's the current MarkHolder for mutation. Only called from a tracing thread. 33 */ acquire()34 public abstract MarkHolder acquire(); 35 36 /** 37 * Releases the MarkHolder from being written too. Usually called very shortly after {@link #acquire()}. 38 * This method is meant to be overridden and should not be called from subclasses. 39 */ release(MarkHolder markHolder)40 public void release(MarkHolder markHolder) {} 41 } 42