|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectspread.SpreadGroup
public class SpreadGroup
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();
Field Summary | |
---|---|
private SpreadConnection |
connection
|
private java.lang.String |
name
|
Constructor Summary | |
---|---|
|
SpreadGroup()
Initializes a new SpreadGroup object. |
protected |
SpreadGroup(SpreadConnection connection,
java.lang.String name)
|
Method Summary | |
---|---|
boolean |
equals(java.lang.Object object)
Checks if two groups are the same. |
int |
hashCode()
Returns the hash code of the group, which is defined as the hash code of its name. |
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 |
---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
private java.lang.String name
private SpreadConnection connection
Constructor Detail |
---|
protected SpreadGroup(SpreadConnection connection, java.lang.String name)
public SpreadGroup()
join(SpreadConnection, String)
.
join(SpreadConnection, String)
Method Detail |
---|
public void join(SpreadConnection connection, java.lang.String name) throws SpreadException
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.
connection
- the connection to join the group withname
- the name of the group to join
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 groupleave()
public void leave() throws SpreadException
SpreadException
- if the group hasn't been joined, or if there is an error leaving the groupjoin(SpreadConnection, String)
public java.lang.String toString()
toString
in class java.lang.Object
public boolean equals(java.lang.Object object)
equals
in class java.lang.Object
object
- the object to compare against
public int hashCode()
hashCode
in class java.lang.Object
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |