org.jerkar.tool.JkPlugin Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of core Show documentation
Build simpler, stronger, faster
The newest version!
package org.jerkar.tool;

import org.jerkar.api.utils.JkUtilsString;

/**
 * Plugin instances are owned by a JkRun instance. The relationship is bidirectional. JkRun instances may
 * invoke plugin methods or fields and plugin instances may invoke owner methods.
 *
 * Therefore plugins can interact with or load other plugins into the owner instance, which is quite common in Jerkar.
 */
public abstract class JkPlugin {

    private static final String CLASS_PREFIX = JkPlugin.class.getSimpleName();

    private final JkRun run;

    /*
     * Right after to be instantiated, plugin instances are likely to be configured by the owning run.
     * Therefore, every plugin members that are likely to be configured by the owning run must be
     * initialized in the constructor.
     */
    protected JkPlugin(JkRun run) {
        this.run = run;
    }

    @JkDoc("Displays help about this plugin.")
    public void help() {
        HelpDisplayer.helpPlugin(this);
    }

    /**
     * Override this method to modify the run itself or its bound plugins.
     */
    protected void activate() {
    }

    public final String name() {
        final String className = this.getClass().getSimpleName();
        if (! className.startsWith(CLASS_PREFIX) || className.equals(CLASS_PREFIX)) {
            throw new IllegalStateException(String.format("Plugin class not properly named. Name should be formatted as " +
                    "'%sXxxx' where xxxx is the name of the plugin (uncapitalized). Was %s.", CLASS_PREFIX, className));
        }
        final String suffix = className.substring(CLASS_PREFIX.length());
        return JkUtilsString.uncapitalize(suffix);
    }

    protected JkRun getRun() {
        return run;
    }

    @Override
    public String toString() {
        return this.getClass().getName();
    }
}