com.mycila.plugin.spi.Binding Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of mycila-plugin Show documentation

Plugin Framework

There is a newer version: 1.10

/**
 * Copyright (C) 2008 Mathieu Carbou 
 * 
 * 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 com.mycila.plugin.spi;

import com.mycila.plugin.api.Plugin;
import com.mycila.plugin.api.PluginBinding;
import static com.mycila.plugin.spi.Ensure.*;

/**
 * @author Mathieu Carbou ([email protected])
 */
final class Binding implements PluginBinding, Comparable> {

    private final String name;
    private T plugin;

    Binding(String name) {
        notNull("Plugin name", name);
        this.name = name;
    }

    Binding withPlugin(T plugin) {
        notNull("Plugin instance", plugin);
        this.plugin = plugin;
        return this;
    }

    public T getPlugin() {
        return plugin;
    }

    public String getName() {
        return name;
    }

    public int compareTo(PluginBinding o) {
        notNull("Plugin binding", o);
        return getName().compareTo(o.getName());
    }

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

    @Override
    public boolean equals(Object o) {
        return this == o || o != null && (o instanceof String || o instanceof Binding) && toString().equals(o.toString());
    }

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