eu.hgross.blaubot.core.IBlaubotDevice Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of blaubot Show documentation

An easy to use publish/subscribe middleware to create and communicate through dynamically created adhoc networks.

There is a newer version: 2.0.0-beta.2

package eu.hgross.blaubot.core;

/**
 * Abstraction for blaubot devices.
 *
 * A blaubot device is in most cases a simple wrapper class above
 * a unique address specific to its related {@link IBlaubotAdapter}
 * uniquely identified by the {@link String} retrievable via it's
 * getUniqueDeviceID() method. In most cases this will be the
 * MAC address.   
 * 
 * Please implement the equals and hashcode methods properly. 
 * These methods should be bound to ONE blaubot instance (i.e. by
 * comparing the UUID or smthg else).
 * 
 * @author Henning Gross 
 *
 */
public interface IBlaubotDevice extends Comparable {
	/**
	 * Note that ; and | are reserved characters which are not allowed to be used as part of the uniqueId
	 * @return returns a String representing a unique id for this device (most probably a MAC or something similar)
	 */
	public String getUniqueDeviceID();
	
	/**
	 * @return some sort of readable name that (not necessarily uniquely) identifies this device 
	 */
	public String getReadableName();
}