org.tinylog.Supplier Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of tinylog-api Show documentation

tinylog logging API

There is a newer version: 2.8.0-M1

/*
 * Copyright 2017 Martin Winandy
 *
 * 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 org.tinylog;

/**
 * This lazy value supplier is identical to {@link java.util.function.Supplier}. It is used in {@link Logger} and
 * {@link TaggedLogger} for lazy generation of messages and arguments. A message or argument can be provided as lambda
 * expression and will be only generated, if the log entry is really output.
 * 
 * 
 * tinylog provides its own supplier to ensure compatibility with Java prior to version 8.
 * {@link java.util.function.Supplier} was introduced with Java 8.
 * 
 *
 * @param 
 *            Type of generated value
 */
public interface Supplier {

	/**
	 * Generates the value.
	 * 
	 * @return Generated value
	 */
	T get();

}