org.eu.zajc.ef.supplier.CharSupplier Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of extended-functions Show documentation

Specializations and support utilities for functional interfaces that are missing from the standard library

The newest version!

// SPDX-License-Identifier: Apache-2.0
/*
 * extended-functions
 * Copyright 2021-2024 Marko Zajc
 *
 * 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.eu.zajc.ef.supplier;

import java.util.function.Supplier;

/**
 * Represents a supplier of {@code char}-valued results. This is the
 * {@code char}-producing primitive specialization of {@link Supplier}.
 *
 * 
 * There is no requirement that a new or distinct result be returned each time the
 * supplier is invoked.
 *
 * 
 * This is a functional interface whose functional method is {@link #getAsChar()}.
 *
 * @see Supplier
 *
 * @author Marko Zajc
 */
public interface CharSupplier {

	/**
	 * Gets a result.
	 *
	 * @return a result
	 */
	char getAsChar();

}