org.eclipse.ecf.presence
Class Presence

java.lang.Object
  extended by org.eclipse.ecf.presence.Presence
All Implemented Interfaces:
java.io.Serializable, org.eclipse.core.runtime.IAdaptable, IPresence

public class Presence
extends java.lang.Object
implements IPresence

Base presence class implementing IPresence. Subclasses may be created as appropriate.

See Also:
Serialized Form

Nested Class Summary
 
Nested classes/interfaces inherited from interface org.eclipse.ecf.presence.IPresence
IPresence.Mode, IPresence.Type
 
Field Summary
protected  IPresence.Mode mode
           
protected  byte[] pictureData
           
protected  java.util.Map properties
           
protected  java.lang.String status
           
protected  IPresence.Type type
           
 
Constructor Summary
Presence()
           
Presence(IPresence.Type type)
           
Presence(IPresence.Type type, java.lang.String status, IPresence.Mode mode)
           
Presence(IPresence.Type type, java.lang.String status, IPresence.Mode mode, java.util.Map props)
           
Presence(IPresence.Type type, java.lang.String status, IPresence.Mode mode, java.util.Map props, byte[] picture)
           
 
Method Summary
 java.lang.Object getAdapter(java.lang.Class adapter)
           
 IPresence.Mode getMode()
          Get the presence mode for this presence
 byte[] getPictureData()
          Get picture data for this presence
 java.util.Map getProperties()
          Get properties for this presence
 java.lang.String getStatus()
          Get status information for this presence information.
 IPresence.Type getType()
          Get presence type information for this presence.
 java.lang.String toString()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

type

protected IPresence.Type type

mode

protected IPresence.Mode mode

status

protected java.lang.String status

properties

protected java.util.Map properties

pictureData

protected byte[] pictureData
Constructor Detail

Presence

public Presence()

Presence

public Presence(IPresence.Type type)

Presence

public Presence(IPresence.Type type,
                java.lang.String status,
                IPresence.Mode mode,
                java.util.Map props,
                byte[] picture)

Presence

public Presence(IPresence.Type type,
                java.lang.String status,
                IPresence.Mode mode,
                java.util.Map props)

Presence

public Presence(IPresence.Type type,
                java.lang.String status,
                IPresence.Mode mode)
Method Detail

getMode

public IPresence.Mode getMode()
Description copied from interface: IPresence
Get the presence mode for this presence

Specified by:
getMode in interface IPresence
Returns:
Mode the mode information for this presence. Will not return null.

getProperties

public java.util.Map getProperties()
Description copied from interface: IPresence
Get properties for this presence

Specified by:
getProperties in interface IPresence
Returns:
Map of properties for this presence information. Will not return null.

getStatus

public java.lang.String getStatus()
Description copied from interface: IPresence
Get status information for this presence information.

Specified by:
getStatus in interface IPresence
Returns:
String status information for this presence info. May return null.

getType

public IPresence.Type getType()
Description copied from interface: IPresence
Get presence type information for this presence.

Specified by:
getType in interface IPresence
Returns:
Type the type of presence. Will not return null.

getAdapter

public java.lang.Object getAdapter(java.lang.Class adapter)
Specified by:
getAdapter in interface org.eclipse.core.runtime.IAdaptable

getPictureData

public byte[] getPictureData()
Description copied from interface: IPresence
Get picture data for this presence

Specified by:
getPictureData in interface IPresence
Returns:
byte [] image data. Empty array will be returned if not picture data.

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object