ilog.views.graphlayout.circular

Class IlvClusterNumber

java.lang.Object

ilog.views.graphlayout.circular.IlvClusterId

ilog.views.graphlayout.circular.IlvClusterNumber

All Implemented Interfaces:

IlvPersistentObject, Serializable

public class IlvClusterNumber
extends IlvClusterId

An object that identifies a cluster by a unique integer number.

Since:

JViews 2.0

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
IlvClusterNumber(IlvInputStream stream) Reads an IlvClusterNumber from an IlvInputStream.
IlvClusterNumber(int number) Creates a new IlvClusterNumber to identify a cluster using an integer value.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj) Compares the IlvClusterNumber to the specified object.
int	getNumber() Returns the number attribute of the cluster identifier.
int	hashCode() Returns a hash code for the IlvClusterNumber.
String	toString() Returns a string representation of the IlvClusterNumber.
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

IlvClusterNumber

public IlvClusterNumber(int number)

Creates a new IlvClusterNumber to identify a cluster using an integer value.

Parameters:

number - The integer value to identify the cluster.

IlvClusterNumber

public IlvClusterNumber(IlvInputStream stream)
                 throws IlvReadFileException

Reads an IlvClusterNumber from an IlvInputStream.

Parameters:

stream - The input stream.

Throws:

IlvReadFileException - when an error occurs while reading.

Method Detail

getNumber

public int getNumber()

Returns the number attribute of the cluster identifier.

Returns:

The number attribute of the cluster identifier.

hashCode

public int hashCode()

Returns a hash code for the IlvClusterNumber.

Specified by:

hashCode in class IlvClusterId

Returns:

a hash code value for the IlvClusterNumber

See Also:

Object.hashCode()

equals

public boolean equals(Object obj)

Compares the IlvClusterNumber 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 IlvClusterNumber and the method getNumber() called on it returns the same value as the number attribute of the IlvClusterNumber.

Specified by:

equals in class IlvClusterId

Parameters:

obj - The object with which to compare the IlvClusterNumber

Returns:

true if the cluster numbers are equal and false otherwise.

toString

public String toString()

Returns a string representation of the IlvClusterNumber.

Specified by:

toString in class IlvClusterId

Returns:

A string representation of the cluster number.

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.