org.openbase.jul.pattern.ConfigurableRemote Maven / Gradle / Ivy

Go to download
package org.openbase.jul.pattern;

/*
 * #%L
 * JUL Pattern Default
 * %%
 * Copyright (C) 2015 - 2017 openbase.org
 * %%
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation, either version 3 of the
 * License, or (at your option) any later version.
 * 
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Lesser Public License for more details.
 * 
 * You should have received a copy of the GNU General Lesser Public
 * License along with this program.  If not, see
 * .
 * #L%
 */
import org.openbase.jul.exception.NotAvailableException;
import org.openbase.jul.iface.Manageable;

/**
 *
 * @author Divine Threepwood
 * @param  Identifier
 * @param  Message
 * @param  Configuration
 */
public interface ConfigurableRemote extends IdentifiableRemote, Manageable, Remote {

    /**
     * Method returns the current configuration of this remote instance.
     *
     * @return the current configuration
     * @throws NotAvailableException if the configuration is not available
     */
    public CONFIG getConfig() throws NotAvailableException;

    /**
     * Method returns the class of the configuration instance.
     *
     * @return the class of the configuration.
     */
    public Class getConfigClass();

    /**
     * This method allows the registration of config observers to get informed about config updates.
     *
     * @param observer the observer added
     */
    public void addConfigObserver(final Observer observer);

    /**
     * This method removes already registered config observers.
     *
     * @param observer the observer removed
     */
    public void removeConfigObserver(final Observer observer);
}