software.xdev.time.HierarchicalLoggingStopWatch Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of hierarchical-stopwatch Show documentation

hierarchical-stopwatch

There is a newer version: 1.1.1

Show newest version

/*
 * Copyright © 2024 XDEV Software (https://xdev.software)
 *
 * 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
 *
 *     http://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 software.xdev.time;

import java.util.function.Consumer;


/**
 * Same as {@link HierarchicalStopWatch} but with a Consumer that handles
 * {@link HierarchicalStopWatch#getPrettyPrinted()}
 *
 * @see HierarchicalStopWatch
 */
public class HierarchicalLoggingStopWatch extends HierarchicalStopWatch
{
	protected final Consumer logConsumer;
	
	public HierarchicalLoggingStopWatch(
		final String taskName,
		final Consumer logConsumer,
		final boolean async,
		final boolean enabled)
	{
		super(taskName, async, enabled);
		this.logConsumer = logConsumer;
	}
	
	@Override
	public void close()
	{
		super.close();
		this.stopAll();
		if(this.isEnabled())
		{
			this.logConsumer.accept(this.getPrettyPrinted());
		}
	}
	
	public static HierarchicalLoggingStopWatch createStarted(
		final String taskName,
		final Consumer logConsumer,
		final boolean async,
		final boolean enabled)
	{
		final HierarchicalLoggingStopWatch sw = new HierarchicalLoggingStopWatch(taskName, logConsumer, async,
			enabled);
		sw.start();
		return sw;
	}
	
	public static HierarchicalLoggingStopWatch createStarted(
		final String taskName,
		final Consumer logConsumer,
		final boolean enabled)
	{
		return createStarted(taskName, logConsumer, false, enabled);
	}
}