de.cuioss.tools.logging.CuiLoggerFactory Maven / Gradle / Ivy
Show all versions of cui-java-tools Show documentation
/*
* Copyright 2023 the original author or 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 de.cuioss.tools.logging;
import static de.cuioss.tools.reflect.MoreReflection.findCaller;
import java.util.Set;
import java.util.function.Supplier;
import de.cuioss.tools.collect.CollectionLiterals;
import lombok.experimental.UtilityClass;
/**
* Class provide factory method for CuiLogger instance
*/
@UtilityClass
public class CuiLoggerFactory {
static final Set MARKER_CLASS_NAMES = CollectionLiterals.immutableSet(CuiLogger.class.getName(),
CuiLoggerFactory.class.getName());
private static final Supplier ILLEGAL_STATE_EXCEPTION_SUPPLIER = () -> new IllegalStateException(
"Unable to detect caller class name. Make sure '" + MARKER_CLASS_NAMES + "' was used for creation.");
/**
* Automatic determine the caller class.
*
* @return {@link CuiLogger}
* @throws IllegalStateException if caller couldn't be detected
*/
public static CuiLogger getLogger() {
return getLogger(findCaller(MARKER_CLASS_NAMES).orElseThrow(ILLEGAL_STATE_EXCEPTION_SUPPLIER));
}
/**
* Create logger and use the hand-over class name as logger name
*
* @param className must not be null
* @return {@link CuiLogger}
*/
public static CuiLogger getLogger(final String className) {
return new CuiLogger(className);
}
/**
* Create logger and use the hand-over class name as logger name
*
* @param clazz must not be null
* @return {@link CuiLogger}
*/
public static CuiLogger getLogger(final Class clazz) {
return new CuiLogger(clazz);
}
}