AbstractNikobusItemConfig.java

/**
 * Copyright (c) 2010-2016 by the respective copyright holders.
 *
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 */
package org.openhab.binding.nikobus.internal.config;

import org.openhab.binding.nikobus.internal.NikobusBinding;
import org.openhab.binding.nikobus.internal.core.NikobusCommandListener;
import org.openhab.core.binding.BindingConfig;
import org.openhab.core.types.Command;

/**
 * Base class for all Nikobus devices like buttons, switch modules, motion
 * sensors, etc.
 *
 * To add binding configuration support for new devices, extend this class.
 *
 * @author Davy Vanherbergen
 * @since 1.3.0
 */
public abstract class AbstractNikobusItemConfig implements BindingConfig, NikobusCommandListener {

    private String name;

    private String address;

    /**
     * Default constructor.
     * 
     * @param name
     *            item name.
     * @param address
     *            device address.
     */
    protected AbstractNikobusItemConfig(String name, String address) {
        this.name = name;
        this.address = address;
    }

    /**
     * @return address of Nikobus component.
     */
    public String getAddress() {
        return address;
    }

    /**
     * @return name of the item which this binding is linked to
     */
    @Override
    public String getName() {
        return name;
    }

    /**
     * Process an openHab command for the current item binding.
     * 
     * @param command
     *            openHab command
     */
    public abstract void processCommand(Command command, NikobusBinding binding) throws Exception;
}