BEGIN LICENSE BLOCK *****
Version: EPL 2.0/GPL 2.0/LGPL 2.1
The contents of this file are subject to the Eclipse Public
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.eclipse.org/legal/epl-v20.html
Software distributed under the License is distributed on an "AS
IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or
implied. See the License for the specific language governing
rights and limitations under the License.
Alternatively, the contents of this file may be used under the terms of
either of the GNU General Public License Version 2 or later (the "GPL"),
or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
in which case the provisions of the GPL or the LGPL are applicable instead
of those above. If you wish to allow use of your version of this file only
under the terms of either the GPL or the LGPL, and not to allow others to
use your version of this file under the terms of the EPL, indicate your
decision by deleting the provisions above and replace them with the notice
and other provisions required by the GPL or the LGPL. If you do not delete
the provisions above, a recipient may use your version of this file under
the terms of any one of the EPL, the GPL or the LGPL.
END LICENSE BLOCK /***** BEGIN LICENSE BLOCK *****
 * Version: EPL 2.0/GPL 2.0/LGPL 2.1
 *
 * The contents of this file are subject to the Eclipse Public
 * 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.eclipse.org/legal/epl-v20.html
 *
 * Software distributed under the License is distributed on an "AS
 * IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or
 * implied. See the License for the specific language governing
 * rights and limitations under the License.
 *
 * Alternatively, the contents of this file may be used under the terms of
 * either of the GNU General Public License Version 2 or later (the "GPL"),
 * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
 * in which case the provisions of the GPL or the LGPL are applicable instead
 * of those above. If you wish to allow use of your version of this file only
 * under the terms of either the GPL or the LGPL, and not to allow others to
 * use your version of this file under the terms of the EPL, indicate your
 * decision by deleting the provisions above and replace them with the notice
 * and other provisions required by the GPL or the LGPL. If you do not delete
 * the provisions above, a recipient may use your version of this file under
 * the terms of any one of the EPL, the GPL or the LGPL.
 ***** END LICENSE BLOCK *****/

package org.jruby.runtime.profile;

import org.jruby.internal.runtime.methods.DynamicMethod;

Implementations of this interface will be used to enhance methods with profiling information/ callbacks.
TODO This can be moved, I think it's also useful outside the profile package.
Author:
Andre Kullmann/**
 * Implementations of this interface will be used to enhance methods with profiling information/ callbacks.
 * TODO This can be moved, I think it's also useful outside the profile package.
 *
 * @author Andre Kullmann
 */
public interface MethodEnhancer {

    
Will be called with a method which should be enhanced.
e.g. with information or callback invocations required by the profiling.
In most cases you don't want to profile all methods, just the methods of your own code.
So you can add a simple filter here
if( isMyCode( delegate ) ) {
    return new ProfilingDynamicMethod( delegate );
} else {
    return delegate;
}

Params:
id – the name of the given delegate
delegate – the method to enhance
Returns:
the enhanced method. if nothing is to be done, the delegate itself can be returned/**
     * Will be called with a method which should be enhanced.
     * e.g. with information or callback invocations required by the profiling.
     * In most cases you don't want to profile all methods, just the methods of your own code.
     * So you can add a simple filter here
     * <pre>
     * if( isMyCode( delegate ) ) {
     *     return new ProfilingDynamicMethod( delegate );
     * } else {
     *     return delegate;
     * }
     * </pre>
     * @param id the name of the given delegate
     * @param delegate the method to enhance
     * @return the enhanced method. if nothing is to be done, the delegate itself can be returned
     */
    public DynamicMethod enhance(String id, DynamicMethod delegate);
}