|
Extension SDK 10.1.2 | ||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object
oracle.ide.addin.Message
The Message
class is the base class for messages send to an link oracle.ide.addin.Observer} to notify it about a Subject
pending change and past change. An update message consists of four lists: add
, remove
, modify
, and container
lists. A subject simply includes all applicable change information in one or more update messages.
Observer
, Subject
Field Summary | |
protected java.util.List |
add Lists new object creations that may have ocurred during a subject change |
static java.lang.String |
COMMAND_ID_PROP The command ID property key. |
protected java.util.List |
container Lists the parents of objects recorded in add, remove, and/or modify lists |
protected Context |
context Holds the context under which notification is taking place. |
protected int |
messageID records the message id |
protected java.util.Map |
messageProperties Holds the user properties associated with this message. |
protected java.util.List |
modify Lists object modifications that may have ocurred during a subject change |
protected java.lang.Object |
origin records the Object which originated the message |
protected java.util.List |
remove Lists object deletions that may have ocurred during a subject change |
Constructor Summary | |
Message(int messageID, java.lang.Object origin) Constructs an update message of the specified message id. |
|
Message(Message msg) Constructs a new Message object which is a copy of the supplied Message . |
Method Summary | |
java.util.List |
getAddObjects() Retrieves the list of objects added during a Subject change. |
Context |
getContext() Get the context under which notification is taking place. |
java.lang.Object |
getExtraData() Get the user data associated with this message. |
int |
getMessageID() Retrieves the message identifier. |
java.util.List |
getModifyObjects() Retrieves the list of objects modified during a Subject change. |
java.lang.Object |
getOrigin() Retrieves the originator of the message. |
java.lang.Object |
getProperty(java.lang.Object key) Get the user property associated with this message. |
java.util.List |
getRemoveObjects() Retrieves the list of objects removed during a Subject change. |
void |
setContext(Context context) Set the context under which notification is taking place. |
void |
setExtraData(java.lang.Object extraData) Set the user data to be associated with this message. |
void |
setProperty(java.lang.Object key, java.lang.Object property) Stores the property to be associated with this message with the supplied key. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
public static final java.lang.String COMMAND_ID_PROP
protected int messageID
protected java.lang.Object origin
protected java.util.List add
protected java.util.List remove
protected java.util.List modify
protected java.util.List container
protected Context context
protected final java.util.Map messageProperties
Constructor Detail |
public Message(int messageID, java.lang.Object origin)
origin
- the Object which originated this message. Usually an Observer.messageID
- the message identifier.public Message(Message msg)
Message
object which is a copy of the supplied Message
.msg
- A Message
object.Method Detail |
public int getMessageID()
public java.lang.Object getOrigin()
public java.util.List getAddObjects()
Subject
change.Subject
change.public java.util.List getRemoveObjects()
Subject
change.Subject
change.public java.util.List getModifyObjects()
Subject
change.Subject
change.public Context getContext()
public void setContext(Context context)
public java.lang.Object getExtraData()
public void setExtraData(java.lang.Object extraData)
public java.lang.Object getProperty(java.lang.Object key)
key
- the property lookup key.public void setProperty(java.lang.Object key, java.lang.Object property)
key
- the key to use to store and look up this property.property
- the property value. If null, the proerty key is removed from the map.
|
Extension SDK | ||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Copyright © 1997, 2004, Oracle. All rights reserved.