com.whizzosoftware.hobson.api.disco

Class DeviceAdvertisement

java.lang.Object

com.whizzosoftware.hobson.api.disco.DeviceAdvertisement

public class DeviceAdvertisement
extends java.lang.Object

A DeviceAdvertisement is a message that devices broadcast to indicate their availability (or lack thereof). Generally, these objects will be consumed by plugins to determine if the advertised device is something they care about.

Author:

Dan Noguerol

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DeviceAdvertisement.Builder

Method Summary

Modifier and Type	Method and Description
java.lang.String	getId() Returns a unique identifier for this device advertisement.
java.lang.Object	getObject() Returns an object representation of the advertisement.
java.lang.String	getProtocolId() Returns the protocol the advertisement used (e.g.
java.lang.String	getRawData() Returns the raw data of the advertisement.
java.lang.String	getUri() Returns the URI associated with this advertisement.
void	setUri(java.lang.String uri) Sets the URI associated with this advertisement.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

getId

public java.lang.String getId()

Returns a unique identifier for this device advertisement.

Returns:

an ID

getProtocolId

public java.lang.String getProtocolId()

Returns the protocol the advertisement used (e.g. SSDP).

Returns:

the protocol

getUri

public java.lang.String getUri()

Returns the URI associated with this advertisement.

Returns:

a URI String

setUri

public void setUri(java.lang.String uri)

Sets the URI associated with this advertisement.

Parameters:

uri - a URI String

getObject

public java.lang.Object getObject()

Returns an object representation of the advertisement. It will fall upon consumers to cast to the correct class based on the protocol ID.

Returns:

an object

getRawData

public java.lang.String getRawData()

Returns the raw data of the advertisement.

Returns:

the raw data as a String

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object