spread
Class SpreadGroup

java.lang.Object
  |
  +--spread.SpreadGroup

public class SpreadGroup

extends java.lang.Object

A SpreadGroup object represents a group on a spread daemon. The group is either a group that has been joined or a private group. To join a group, first create a SpreadGroup object, then join it with join(SpreadConnection, String):

 SpreadGroup group = new SpreadGroup();
 group.join(connection, "users");
 

To leave the group, use leave():

 group.leave();
 

Constructor Summary

SpreadGroup()
Initializes a new SpreadGroup object.

Method Summary

boolean	equals(java.lang.Object object) Checks if two groups are the same.
void	join(SpreadConnection connection, java.lang.String name) Joins the group name on the connection connection.
void	leave() Leaves the group.
java.lang.String	toString() Returns the name of the group as a string.

Methods inherited from class java.lang.Object

getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

SpreadGroup

public SpreadGroup()

Initializes a new SpreadGroup object. To join a group with this object, use join(SpreadConnection, String).

See Also:

join(SpreadConnection, String)

Method Detail

join

public void join(SpreadConnection connection,
                 java.lang.String name)
          throws SpreadException

Joins the group name on the connection connection. Between when the group has been joined with this method and when it is left with leave(), all messages sent to the group will be received by the connection.

Parameters:

connection - the connection to join the group with

name - the name of the group to join

Throws:

SpreadException - if attempting to join again with the same group object, if an illegal character is in the group name, or if there is an error trying to join the group

See Also:

leave()

leave

public void leave()
           throws SpreadException

Leaves the group. No more messages will be received from this group after this method is called.

Throws:

SpreadException - if the group hasn't been joined, or if there is an error leaving the group

See Also:

join(SpreadConnection, String)

toString

public java.lang.String toString()

Returns the name of the group as a string.

Returns:

the name of the group

Overrides:

toString in class java.lang.Object

equals

public boolean equals(java.lang.Object object)

Checks if two groups are the same. Two groups are the same if they have the same name.

Parameters:

object - the object to compare against

Returns:

true if object is a SpreadGroup and it has the same name

Overrides:

equals in class java.lang.Object