blob: 5d4b6246267364f722b7b9481179e21240a8ed7a [file] [log] [blame]
/*******************************************************************************
* Copyright (c) 2014 Dirk Fauth and others.
*
* This program and the accompanying materials
* are made available under the terms of the Eclipse Public License 2.0
* which accompanies this distribution, and is available at
* https://www.eclipse.org/legal/epl-2.0/
*
* SPDX-License-Identifier: EPL-2.0
*
* Contributors:
* Dirk Fauth <dirk.fauth@googlemail.com> - initial API and implementation
*******************************************************************************/
package org.eclipse.e4.core.services.nls;
/**
* Function interface that is used to bind a property of an object (e.g. a SWT
* control) to a field of a Messages instance. This interface is intended to be
* used with implementations that use Java 8, so it is possible to operate using
* method references and lambdas.
* <p>
* This is a functional interface whose functional method is {@link #apply(M)}.
* </p>
* <p>
* When updating to Java 8 this interface can be removed and replaced with the
* general <code>java.util.function.Function</code>
* </p>
*
* @since 2.0
*
* @param <M>
* the message class type
*/
public interface MessageFunction<M> {
/**
*
* @param m
* The message instance from which the value should be retrieved.
* @return The message value out of the given messages instance.
*/
String apply(M m);
}