info.pppc.base.system

Class DeviceDescription

java.lang.Object

info.pppc.base.system.DeviceDescription

All Implemented Interfaces:

ISerializable

public final class DeviceDescription
extends java.lang.Object
implements ISerializable

The description of the device. The device description entails the well known services registered at the device. The device description can be observed by listeners and all calls to it are synchronized. Note that the device description supports serialization, however, registered listeners will not be serialized.

Author:

Marcus Handte

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ABBREVIATION The abbreviation used for this class during serialization.
static int	EVENT_SERVICE_ADDED Event constant that defines that a new known service has been added.
static int	EVENT_SERVICE_REMOVED Event constant that defines that a known service has been removed.
static short	TYPE_DESKTOP The device type constant for desktop personal computers.
static short	TYPE_LAPTOP The device type constant for notebook personal computers.
static short	TYPE_MAINFRAME The device type constant for servers.
static short	TYPE_PDA The device type constant for personal digital assistants.
static short	TYPE_PHONE The device type constant for mobile phones.
static short	TYPE_SENSOR The device type constant for embedded sensors.
static short	TYPE_TABLET The device type constant for tablet personal computers.
static short	TYPE_UNKOWN The device type constant that signals that the device type is unknown.
static short	TYPE_WRT The device type constant for access points.

Constructor Summary

Constructors

Constructor and Description
DeviceDescription() Creates a new uninitialized device description.
DeviceDescription(SystemID systemID, java.lang.String name, short type) Creates a new device description for the specified device.

Method Summary

Methods

Modifier and Type	Method and Description
void	addListener(int type, IListener listener) Registers a listener for the specified type of event.
void	addService(ObjectID id) Adds the id of a well known service and sends a notification to the registered listeners.
java.lang.String	getName() Returns the device name.
ObjectID[]	getServices() Returns the well known object ids of well known services of the device.
SystemID	getSystemID() Returns the system id of the device description.
short	getType() Returns the type of the device.
boolean	hasService(ObjectID id) Determines whether the service description contains the specified well known service.
void	readObject(IObjectInput input) Reads a description from a stream.
boolean	removeListener(int type, IListener listener) Unregisters the specified listener from the specified set of event types.
void	removeService(ObjectID id) Removes the specified id from the description and sends a notification to all registered listeners.
java.lang.String	toString() Returns a string representation of the device description.
void	writeObject(IObjectOutput output) Writes a description to a stream.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

ABBREVIATION

public static final java.lang.String ABBREVIATION

The abbreviation used for this class during serialization.

See Also:

Constant Field Values

TYPE_UNKOWN

public static final short TYPE_UNKOWN

The device type constant that signals that the device type is unknown.

See Also:

Constant Field Values

TYPE_LAPTOP

public static final short TYPE_LAPTOP

The device type constant for notebook personal computers.

See Also:

Constant Field Values

TYPE_DESKTOP

public static final short TYPE_DESKTOP

The device type constant for desktop personal computers.

See Also:

Constant Field Values

TYPE_MAINFRAME

public static final short TYPE_MAINFRAME

The device type constant for servers.

See Also:

Constant Field Values

TYPE_PHONE

public static final short TYPE_PHONE

The device type constant for mobile phones.

See Also:

Constant Field Values

TYPE_PDA

public static final short TYPE_PDA

The device type constant for personal digital assistants.

See Also:

Constant Field Values

TYPE_TABLET

public static final short TYPE_TABLET

The device type constant for tablet personal computers.

See Also:

Constant Field Values

TYPE_SENSOR

public static final short TYPE_SENSOR

The device type constant for embedded sensors.

See Also:

Constant Field Values

TYPE_WRT

public static final short TYPE_WRT

The device type constant for access points.

See Also:

Constant Field Values

EVENT_SERVICE_ADDED

public static final int EVENT_SERVICE_ADDED

Event constant that defines that a new known service has been added. The data object of the event will contain the added id.

See Also:

Constant Field Values

EVENT_SERVICE_REMOVED

public static final int EVENT_SERVICE_REMOVED

Event constant that defines that a known service has been removed. The data object of the event will contain the removed id.

See Also:

Constant Field Values

Constructor Detail

DeviceDescription

public DeviceDescription()

Creates a new uninitialized device description. This constructor is solely intended for deserialization purposes, it should not be called by user code.

DeviceDescription

public DeviceDescription(SystemID systemID,
                 java.lang.String name,
                 short type)

Creates a new device description for the specified device.

Parameters:

systemID - The system id of the device.

name - The name of the device used in user interfaces.

type - The type of the device used in user interfaces.

Method Detail

getName

public java.lang.String getName()

Returns the device name. This will be a string with the maximum length of 10 characters.

Returns:

The name of the device (human readable).

getType

public short getType()

Returns the type of the device. This should be one of the type constants defined in this class.

Returns:

The device type as a short.

getSystemID

public SystemID getSystemID()

Returns the system id of the device description.

Returns:

The system id of the device description.

addListener

public void addListener(int type,
               IListener listener)

Registers a listener for the specified type of event. The device description emits EVENT_SERVICE_ADDED events and EVENT_SERVICE_REMOVED events for changes to the set of well known services on the device. If such an event is fired, the data object will contain the object id of the removed or added well known service.

Parameters:

type - The type to register for. At the present time EVENT_SERVICE_REMOVED and EVENT_SERVICE_ADDED events are emitted for changed object ids.

listener - The listener to add.

removeListener

public boolean removeListener(int type,
                     IListener listener)

Unregisters the specified listener from the specified set of event types.

Parameters:

type - The types to unregister for.

listener - The listener to unregister.

Returns:

True if the listener is no longer registered for any event, false if the listener is still registered or if it has not been registered.

getServices

public ObjectID[] getServices()

Returns the well known object ids of well known services of the device. Note that the array returned by this method will be a copy of the array used by the description.

Returns:

The well known object ids.

hasService

public boolean hasService(ObjectID id)

Determines whether the service description contains the specified well known service.

Parameters:

id - The object id of the well known service to lookup.

Returns:

True if the service description contains the well known service, false otherwise.

addService

public void addService(ObjectID id)

Adds the id of a well known service and sends a notification to the registered listeners. If the id is already contained in the description, no change is propagated. The change is propagated in sync. Thus, all listeners will already hold the lock. The change is propagated as a EVENT_SERVICE_ADDED event that contains the added id as data object.

Parameters:

id - The id of the object to add.

removeService

public void removeService(ObjectID id)

Removes the specified id from the description and sends a notification to all registered listeners. If the id is not contained in the description, no change is propagated. The change is propagated in sync. Thus, all listeners will already hold the lock. The event is propagated as EVENT_SERVICE_REMOVED event that contains the removed id as data object.

Parameters:

id - The id of the object to remove.

readObject

public void readObject(IObjectInput input)
                throws java.io.IOException

Reads a description from a stream. Note that the listeners are not read from the stream, they are transient.

Specified by:

readObject in interface ISerializable

Parameters:

input - The stream to read from.

Throws:

java.io.IOException - Thrown by the stream.

writeObject

public void writeObject(IObjectOutput output)
                 throws java.io.IOException

Writes a description to a stream. Note that the listeners are not written to the stream, they are transient.

Specified by:

writeObject in interface ISerializable

Parameters:

output - The stream to write to.

Throws:

java.io.IOException - Thrown by the stream.

toString

public java.lang.String toString()

Returns a string representation of the device description.

Overrides:

toString in class java.lang.Object

Returns:

A string representation of the description.