com.sun.faban.harness.tools
Class ToolDescription

java.lang.Object
  com.sun.faban.harness.tools.ToolDescription

All Implemented Interfaces:

Serializable

public class ToolDescription
extends Object
implements Serializable

This class provides the description of a tool.

Author:

Sheetal Patil

See Also:

Serialized Form

Constructor Summary

ToolDescription(String id, String serviceName, String toolClass, String type, String location)
Constructs a tool description.

Method Summary

boolean	bind(Map<String,ServiceDescription> serviceMap) Binds the tool to the service.
boolean	equals(Object obj)
String	getId() Returns the tool id.
String	getLocation() Returns the path.
String	getLocationType() Returns the location type.
String	getServiceName() Returns the service name to which the tool is associated.
String	getToolClass() Returns the tool class.
int	hashCode()

Methods inherited from class java.lang.Object

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

Constructor Detail

ToolDescription

public ToolDescription(String id,
                       String serviceName,
                       String toolClass,
                       String type,
                       String location)

Constructs a tool description.

Parameters:

id - The tool id

serviceName - The service name

toolClass - The tool class name

type - The location type, services or benchmark

location - The actual location of the tool, if applicable.

Method Detail

bind

public boolean bind(Map<String,ServiceDescription> serviceMap)

Binds the tool to the service.

Parameters:

serviceMap - The service map

Returns:

boolean true if the tool is bound to a service

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getLocationType

public String getLocationType()

Returns the location type.

Returns:

"services" or "benchmarks".

getLocation

public String getLocation()

Returns the path.

Returns:

location.

getId

public String getId()

Returns the tool id.

Returns:

tool id as String.

getServiceName

public String getServiceName()

Returns the service name to which the tool is associated.

Returns:

service name as string.

getToolClass

public String getToolClass()

Returns the tool class.

Returns:

toolclass as string.