/* ###
 * IP: GHIDRA
 *
 * 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 ghidra.app.decompiler.component;

import java.awt.Color;
import java.util.function.Function;

import ghidra.app.decompiler.ClangToken;

/**
 * Functional interface to allow us to map a token to a color.
 * 
 * <p>This class allows us to avoid the namespace conflicts of Java's Function and Ghidra's
 * Function since we can declare a {@code ColorProvider} as a parameter to methods instead of
 * a {@link Function}.
 */
public interface ColorProvider {

	/**
	 * Returns a color for the given token
	 * 
	 * @param token the token
	 * @return the color
	 */
	public Color getColor(ClangToken token);
}
