pf4j/pf4j/src/main/java/org/pf4j/PluginState.java

/*
 * Copyright (C) 2012-present the original author or authors.
 *
 * 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 org.pf4j;

/**
 * @author Decebal Suiu
 */
public class PluginState {

    /**
     * The runtime knows the plugin is there. It knows about the plugin path, the plugin descriptor.
     */
    public static final PluginState CREATED = new PluginState("CREATED");

    /**
     * The plugin cannot be used.
     */
    public static final PluginState DISABLED = new PluginState("DISABLED");

    /**
     * The plugin is created. All the dependencies are created and resolved.
     * The plugin is ready to be started.
     */
    public static final PluginState RESOLVED = new PluginState("RESOLVED");

    /**
     * The {@link Plugin#start()} has executed. A started plugin may contribute extensions.
     */
    public static final PluginState STARTED = new PluginState("STARTED");

    /**
     * The {@link Plugin#stop()} has executed.
     */
    public static final PluginState STOPPED = new PluginState("STOPPED");

    private String status;

    private PluginState(String status) {
        this.status = status;
    }

    @Override
    public boolean equals(Object o) {
        if (this == o) return true;
        if (o == null || getClass() != o.getClass()) return false;

        PluginState that = (PluginState) o;

        return status.equals(that.status);
    }

    @Override
    public int hashCode() {
        return status.hashCode();
    }

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

}