net.happybrackets.core.config

Class KnownDeviceID

java.lang.Object

net.happybrackets.core.config.KnownDeviceID

public class KnownDeviceID
extends java.lang.Object

Stores the way the device is displayed and is stored in Known Config.

Constructor Summary

Constructors

Constructor and Description
KnownDeviceID() Create a representation of how this device will be displayed with a default values
KnownDeviceID(int device_id, java.lang.String friendly_name) Create a representation of how this device will be displayed
KnownDeviceID(java.lang.String hostname, int device_id, java.lang.String friendly_name) Create a representation of how this device will be displayed

Method Summary

Modifier and Type	Method and Description
int	getConnectToServerPort() Return the TCP port we are on and others need to connect to
int	getDeviceId()
java.lang.String	getFriendlyName()
java.lang.String	getHostName()
java.lang.String	getSaveLine() Get the line of text we need to save this device to a known config file
static KnownDeviceID	restore(java.lang.String restore_line) Create a KnownDeviceId based on the line of text to restore.
void	setConnectToServerPort(int connectToServerPort) Set the value after operating system has given us the port
void	setDeviceId(int deviceId)
void	setFriendlyName(java.lang.String friendlyName)

Methods inherited from class java.lang.Object

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

Constructor Detail

KnownDeviceID

public KnownDeviceID(java.lang.String hostname,
                     int device_id,
                     java.lang.String friendly_name)

Create a representation of how this device will be displayed

Parameters:

hostname - The hostname of device

device_id - the integer device ID

friendly_name - the friendly name for the device

KnownDeviceID

public KnownDeviceID(int device_id,
                     java.lang.String friendly_name)

Create a representation of how this device will be displayed

Parameters:

device_id - the integer device ID

friendly_name - the friendly name for the device

KnownDeviceID

public KnownDeviceID()

Create a representation of how this device will be displayed with a default values

Method Detail

getHostName

public java.lang.String getHostName()

getConnectToServerPort

public int getConnectToServerPort()

Return the TCP port we are on and others need to connect to

Returns:

the Port we need to connect to TCP server

setConnectToServerPort

public void setConnectToServerPort(int connectToServerPort)

Set the value after operating system has given us the port

Parameters:

connectToServerPort - the Port we need to connect to TCP server

getDeviceId

public int getDeviceId()

setDeviceId

public void setDeviceId(int deviceId)

getFriendlyName

public java.lang.String getFriendlyName()

setFriendlyName

public void setFriendlyName(java.lang.String friendlyName)

restore

public static KnownDeviceID restore(java.lang.String restore_line)

Create a KnownDeviceId based on the line of text to restore.

Parameters:

restore_line - the space delimited line fof text. May look like "hb-001d43201188 1 Dancer_1"

Returns:

If the line is valid, a new KnownDeviceID is created, otherwise null

getSaveLine

public java.lang.String getSaveLine()

Get the line of text we need to save this device to a known config file

Returns:

The line of text we use to save