com.jivesoftware.community.widget
Class WidgetDescriptor

java.lang.Object
  com.jivesoftware.community.widget.WidgetDescriptor

All Implemented Interfaces:

Serializable

public class WidgetDescriptor
extends Object
implements Serializable

A simple bean class to store installed Widget information.

See Also:

Serialized Form

Field Summary

static long

LOCAL_WIDGET

Constructor Summary

WidgetDescriptor(long widgetID, String className)

WidgetDescriptor(long widgetID, String className, long bridgeID, long remoteWidgetID)

Method Summary

boolean	equals(Object o)
long	getBridgeID() Returns the bridge ID of the widget if it is remote, otherwise returns LOCAL_WIDGET.
String	getClassName() Returns the classname of the widget
long	getInternalID() Returns the internal id of the widget
long	getRemoteWidgetID() Returns the remote widget ID of the widget if it is remote, otherwise returns LOCAL_WIDGET.
int	hashCode()
boolean	isRemote() Indicates if this widget desriptor references a remote widget.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

LOCAL_WIDGET

public static final long LOCAL_WIDGET

See Also:

Constant Field Values

Constructor Detail

WidgetDescriptor

public WidgetDescriptor(long widgetID,
                        String className)

WidgetDescriptor

public WidgetDescriptor(long widgetID,
                        String className,
                        long bridgeID,
                        long remoteWidgetID)

Method Detail

getInternalID

public long getInternalID()

Returns the internal id of the widget

Returns:

the internal id of the widget

getClassName

public String getClassName()

Returns the classname of the widget

Returns:

the classname of the widget

getBridgeID

public long getBridgeID()

Returns the bridge ID of the widget if it is remote, otherwise returns LOCAL_WIDGET.

Returns:

the bridge ID of the widget if it is remote, otherwise returns LOCAL_WIDGET.

getRemoteWidgetID

public long getRemoteWidgetID()

Returns the remote widget ID of the widget if it is remote, otherwise returns LOCAL_WIDGET.

Returns:

the remote widget ID of the widget if it is remote, otherwise returns LOCAL_WIDGET.

isRemote

public boolean isRemote()

Indicates if this widget desriptor references a remote widget.

Returns:

true if this descriptor references a remote widget, otherwise false.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object