org.multiverse.instrumentation.AbstractInstrumentationPhase Maven / Gradle / Ivy

Go to download
package org.multiverse.instrumentation;

/**
 * Abstract {@link InstrumentationPhase} that provides some basic plumbing.
 *
 * @author Peter Veentjer
 */
public abstract class AbstractInstrumentationPhase implements InstrumentationPhase {

    private final String name;

    public AbstractInstrumentationPhase(String name) {
        if (name == null) {
            throw new NullPointerException();
        }

        this.name = name;
    }

    public String getName() {
        return name;
    }

    @Override
    public Clazz instrument(Environment environment, Clazz originalClazz) {
        InstrumenterLogger log = environment.getLog();

        log.lessImportant("   Multiverse: %s: instrumenting class %s", name, originalClazz.getName());

        doInit();

        return doInstrument(environment, originalClazz);
    }

    @Override
    public String toString() {
        return name;
    }

    protected void doInit() {
    }

    protected abstract Clazz doInstrument(Environment environment, Clazz clazz);
}