Docjar: A Java Source and Docuemnt Enginecom.*    java.*    javax.*    org.*    all    new    plug-in

Quick Search    Search Deep

edu.ou.kmi.buddyspace.core
Class BSPresenceInfo  view BSPresenceInfo download BSPresenceInfo.java

java.lang.Object
  extended byedu.ou.kmi.buddyspace.core.BSPresenceInfo

public class BSPresenceInfo
extends java.lang.Object

BSPresenceInfo contains presence information. It includes JID, availability, show and status information.


Field Summary
protected  boolean available
           
static java.lang.String FRIENDLY_SHOW_AWAY
           
static java.lang.String FRIENDLY_SHOW_CHAT
           
static java.lang.String FRIENDLY_SHOW_DND
           
static java.lang.String FRIENDLY_SHOW_LURKER
           
static java.lang.String FRIENDLY_SHOW_OFFLINE
           
static java.lang.String FRIENDLY_SHOW_ONLINE
          constants for friendly show text
static java.lang.String FRIENDLY_SHOW_XA
           
protected  JID jid
           
protected  boolean lurker
           
protected  boolean myself
           
protected  int priority
           
protected  java.lang.String show
           
static java.lang.String SHOW_AWAY
           
static java.lang.String SHOW_CHAT
           
static java.lang.String SHOW_DND
           
static java.lang.String SHOW_ONLINE
          presence show constants
static java.lang.String SHOW_XA
           
protected  java.lang.String status
           
static java.lang.String TYPE_AVAILABLE
          types
static java.lang.String TYPE_UNAVAILABLE
           
 
Constructor Summary
BSPresenceInfo(JID jid, boolean available, java.lang.String show, java.lang.String status)
          Constructor
BSPresenceInfo(org.jabber.jabberbeans.Presence p)
          Constructs BSPresenceInfo from Presence packet.
 
Method Summary
 java.lang.String getFriendlyShow()
          Returns friendly form of show for displaying
 JID getJID()
          Returns JID of the buddy
 org.jabber.jabberbeans.Presence getPresencePacket(JID toAddress)
          Returns new presence packet representing this.
 int getPriority()
          Returns priority level being set by this presence.
 java.lang.String getShow()
          Returns show
 java.lang.String getStatus()
          Returns status
 boolean isInRoster()
          Returns if the buddy is in roster.
 boolean isMyself()
          Returns if the buddy is myself it means the currently logged one.
 boolean isOnline()
          Returns if buddy is available/on-line
 void setIsInRoster(boolean inRoster)
          Sets if the buddy is in roster.
 void setIsMyself(boolean isMyself)
          Sets if the buddy is myself it means the currently logged one.
 void setJID(JID jid)
          Sets JID of the buddy
 void setPriority(int priority)
          Sets priority level being set by this presence.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

show

protected java.lang.String show

status

protected java.lang.String status

priority

protected int priority

jid

protected JID jid

available

protected boolean available

myself

protected boolean myself

lurker

protected boolean lurker

TYPE_AVAILABLE

public static final java.lang.String TYPE_AVAILABLE
types

See Also:
Constant Field Values

TYPE_UNAVAILABLE

public static final java.lang.String TYPE_UNAVAILABLE
See Also:
Constant Field Values

SHOW_ONLINE

public static final java.lang.String SHOW_ONLINE
presence show constants

See Also:
Constant Field Values

SHOW_AWAY

public static final java.lang.String SHOW_AWAY
See Also:
Constant Field Values

SHOW_CHAT

public static final java.lang.String SHOW_CHAT
See Also:
Constant Field Values

SHOW_DND

public static final java.lang.String SHOW_DND
See Also:
Constant Field Values

SHOW_XA

public static final java.lang.String SHOW_XA
See Also:
Constant Field Values

FRIENDLY_SHOW_ONLINE

public static java.lang.String FRIENDLY_SHOW_ONLINE
constants for friendly show text


FRIENDLY_SHOW_CHAT

public static java.lang.String FRIENDLY_SHOW_CHAT

FRIENDLY_SHOW_AWAY

public static java.lang.String FRIENDLY_SHOW_AWAY

FRIENDLY_SHOW_XA

public static java.lang.String FRIENDLY_SHOW_XA

FRIENDLY_SHOW_DND

public static java.lang.String FRIENDLY_SHOW_DND

FRIENDLY_SHOW_OFFLINE

public static java.lang.String FRIENDLY_SHOW_OFFLINE

FRIENDLY_SHOW_LURKER

public static java.lang.String FRIENDLY_SHOW_LURKER
Constructor Detail

BSPresenceInfo

public BSPresenceInfo(org.jabber.jabberbeans.Presence p)
Constructs BSPresenceInfo from Presence packet.


BSPresenceInfo

public BSPresenceInfo(JID jid,
                      boolean available,
                      java.lang.String show,
                      java.lang.String status)
Constructor

Method Detail

getPresencePacket

public org.jabber.jabberbeans.Presence getPresencePacket(JID toAddress)
                                                  throws java.lang.InstantiationException
Returns new presence packet representing this.


isOnline

public boolean isOnline()
Returns if buddy is available/on-line


getShow

public java.lang.String getShow()
Returns show


getStatus

public java.lang.String getStatus()
Returns status


getFriendlyShow

public java.lang.String getFriendlyShow()
Returns friendly form of show for displaying


setIsInRoster

public void setIsInRoster(boolean inRoster)
Sets if the buddy is in roster. Typically used to set that the buddy is NOT in roster.


isInRoster

public boolean isInRoster()
Returns if the buddy is in roster.


setIsMyself

public void setIsMyself(boolean isMyself)
Sets if the buddy is myself it means the currently logged one.


isMyself

public boolean isMyself()
Returns if the buddy is myself it means the currently logged one.


setPriority

public void setPriority(int priority)
Sets priority level being set by this presence.


getPriority

public int getPriority()
Returns priority level being set by this presence.


getJID

public JID getJID()
Returns JID of the buddy


setJID

public void setJID(JID jid)
Sets JID of the buddy