cern.colt.function.ByteProcedure Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of nuiton-matrix Show documentation

Matrix core module

The newest version!

package cern.colt.function;

/*
 Copyright  1999 CERN - European Organization for Nuclear Research.
 Permission to use, copy, modify, distribute and sell this software and its documentation for any purpose 
 is hereby granted without fee, provided that the above copyright notice appear in all copies and 
 that both that copyright notice and this permission notice appear in supporting documentation. 
 CERN makes no representations about the suitability of this software for any purpose. 
 It is provided "as is" without expressed or implied warranty.
%%Ignore-License
 */
/**
 * Interface that represents a procedure object: a procedure that takes a single
 * argument and does not return a value.
 */
public interface ByteProcedure {
	/**
	 * Applies a procedure to an argument. Optionally can return a boolean flag
	 * to inform the object calling the procedure.
	 * 
	 * 
	 * Example: forEach() methods often use procedure objects. To signal to a
	 * forEach() method whether iteration should continue normally or terminate
	 * (because for example a matching element has been found), a procedure can
	 * return false to indicate termination and true to
	 * indicate continuation.
	 * 
	 * @param element
	 *            element passed to the procedure.
	 * @return a flag to inform the object calling the procedure.
	 */
	abstract public boolean apply(byte element);
}