com.helger.commons.functional.ICharFunction Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of ph-commons Show documentation

Java 1.8+ Library with tons of utility classes required in all projects

There is a newer version: 11.1.10

/*
 * Copyright (C) 2014-2022 Philip Helger (www.helger.com)
 * philip[at]helger[dot]com
 *
 * 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 com.helger.commons.functional;

import java.util.function.Function;

/**
 * Represents a function that accepts a char-valued argument and produces a
 * result. This is the {@code char}-consuming primitive specialization for
 * {@link Function}.
 * 
 * This is a functional interface whose functional method is
 * {@link #apply(char)}.
 *
 * @param 
 *        the type of the result of the function
 * @see Function
 * @since 9.0.0
 */
@FunctionalInterface
public interface ICharFunction 
{
  /**
   * Applies this function to the given argument.
   *
   * @param value
   *        the function argument
   * @return the function result
   */
  R apply (char value);
}