christophedelory.playlist.rmp
Class Server

java.lang.Object
  christophedelory.playlist.rmp.Server

public class Server
extends Object

The server definition in a Real Metadata Package.

Since:

0.3.0

Version:

$Revision: 92 $

Author:

Christophe Delory

Constructor Summary

Server()

Method Summary

String	getDescription() Returns the server description.
String	getKey() Returns the server key.
String	getLocation() Returns the server location.
String	getName() Returns the server name.
String	getNetName() Returns the server network name.
void	setDescription(String desc) Initializes the description of this server.
void	setKey(String key) Initializes the server key.
void	setLocation(String location) Initializes the server location.
void	setName(String name) Initializes the server name.
void	setNetName(String netName) Initializes the server network name.

Methods inherited from class java.lang.Object

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

Constructor Detail

Server

public Server()

Method Detail

getName

public String getName()

Returns the server name. Optional. Example: "Jazz Center".

Returns:

a name. May be null.

See Also:

setName(java.lang.String)

setName

public void setName(String name)

Initializes the server name.

Parameters:

name - a name. May be null.

See Also:

getName()

getDescription

public String getDescription()

Returns the server description. Optional. Example: "Your Center for Jazz".

Returns:

a description. May be null.

See Also:

setDescription(java.lang.String)

setDescription

public void setDescription(String desc)

Initializes the description of this server.

Parameters:

desc - a description. May be null.

See Also:

getDescription()

getNetName

public String getNetName()

Returns the server network name. Basically, the main portion of the URL for where the tracks will exist, minus the http:// that you would normally place in a browser URL.

Returns:

a network name. May be null.

See Also:

setNetName(java.lang.String)

setNetName

public void setNetName(String netName)

Initializes the server network name.

Parameters:

netName - a network name. May be null.

See Also:

getNetName()

getLocation

public String getLocation()

Returns the server location. This is the remainder of the path to the music tracks on the server.
Example: "/docs/rmpdemo/%f": if the network name is "docs.real.com", includes for tracks that exist on http://docs.real.com/docs/rmpdemo/. The %f tells RealJukebox to look in the tracklist for the exact filename that exists on the server.

%f

File name

%fid

Track id

%lid

Tracklist ID

%pid

Package id

Defaults to "%f".

Returns:

a location. Shall not be null.

See Also:

setLocation(java.lang.String)

setLocation

public void setLocation(String location)

Initializes the server location.

Parameters:

location - a location. Shall not be null.

Throws:

NullPointerException - if location is null.

See Also:

getLocation()

getKey

public String getKey()

Returns the server key. Currently not used.

Returns:

a key. May be null.

See Also:

setKey(java.lang.String)

setKey

public void setKey(String key)

Initializes the server key.

Parameters:

key - a key. May be null.

See Also:

getKey()