ilog.views.graphlayout.circular

Class IlvClusterName

java.lang.Object

ilog.views.graphlayout.circular.IlvClusterId

ilog.views.graphlayout.circular.IlvClusterName

All Implemented Interfaces:

IlvPersistentObject, Serializable

public class IlvClusterName
extends IlvClusterId

An object that is used to identify a cluster by a unique name (a string).

Since:

JViews 2.0

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
IlvClusterName(IlvInputStream stream) Reads an IlvClusterName from an IlvInputStream.
IlvClusterName(String name) Creates a new IlvClusterName to identify a cluster using a name.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj) Compares the IlvClusterName to the specified object.
String	getName() Returns the name attribute of the cluster identifier.
int	hashCode() Returns a hash code for the IlvClusterName.
String	toString() Returns a string representation of the IlvClusterName.
void	write(IlvOutputStream stream) Writes the object to an IlvOutputStream.

Methods inherited from class java.lang.Object

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

Constructor Detail

IlvClusterName

public IlvClusterName(String name)

Creates a new IlvClusterName to identify a cluster using a name.

Parameters:

name - The name of the cluster.

IlvClusterName

public IlvClusterName(IlvInputStream stream)
               throws IlvReadFileException

Reads an IlvClusterName from an IlvInputStream.

Parameters:

stream - The input stream.

Throws:

IlvReadFileException - when an error occurs while reading.

Method Detail

getName

public String getName()

Returns the name attribute of the cluster identifier.

Returns:

The name of the cluster.

hashCode

public int hashCode()

Returns a hash code for the IlvClusterName.

Specified by:

hashCode in class IlvClusterId

Returns:

a hash code value for the IlvClusterName

See Also:

Object.hashCode()

equals

public boolean equals(Object obj)

Compares the IlvClusterName to the specified object. The result is true if and only if the argument is not null, and if the argument is an instance of IlvClusterName and the method getName() called on it returns the same string as the name attribute of the IlvClusterName.

Specified by:

equals in class IlvClusterId

Parameters:

obj - The object with which to compare the IlvClusterName

Returns:

true if the IlvClusterName are equal; false otherwise.

toString

public String toString()

Returns a string representation of the IlvClusterName.

Specified by:

toString in class IlvClusterId

Returns:

The cluster name as a string.

write

public void write(IlvOutputStream stream)
           throws IOException

Writes the object to an IlvOutputStream.

Specified by:

write in interface IlvPersistentObject

Overrides:

write in class IlvClusterId

Parameters:

stream - The output stream.

Throws:

IOException - thrown when an exception occurs during the write operation for this object.