Peer (The Adobe Experience Manager SDK 2020.7.3975.20200730T192432Z-200604)

All Known Implementing Classes:

AppModel, AreaContainer, ArrayNodeList, Bind, BindingNode, BindItems, BooleanValue, Border, Button, Calculate, Caption, Chars, Color, Comment, CompoundAssertion, ConfigurationElement, ConfigurationKey, ConfigurationModel, ConfigurationUri, ConfigurationValue, Connect, ConnectionSetModel, Container, Content, ContentArea, DataModel, DataModel.AttributeWrapper, DataNode, DataWindow, DateTimeEdit, DateTimeValue, DateValue, DecimalValue, Delta, Dispatcher, Document, Draw, DSigData, EffectiveInputPolicy, EffectiveOutputPolicy, EffectivePolicy, Element, ElementNodeList, EventPseudoModel, EventTag, ExclGroup, ExDataValue, Field, Fill, FloatValue, FormChoiceListField, FormDataListener, FormExclGroup, FormField, FormInstanceManager, FormItemsDataListener, FormListener, FormManifest, FormModel, FormSubform, FormSubformSet, GenericNode, GenericTextContainer, HostPseudoModel, ImageValue, InstanceManager, IntegerValue, Items, Keep, LayoutNode, Linear, ListBase, LocaleSetModel, Manifest, Margin, Model, ModelPeer, Node, NodeList, Obj, Occur, Packet, PageArea, PageSet, Picture, Policy, PrimitiveAssertion, ProcessingInstruction, Proto, ProtoableNode, PseudoModel, RectangleValue, RichTextNode, Script, ScriptDispatcher, SetProperty, Subform, SubformSet, SVGNode, SVGTextData, TemplateModel, TextEdit, TextNode, TextValue, TimeValue, Traverse, UI, Value, Variables, WSDLBindingOperation, WSDLConnection, WSDLDocument, WSDLExten, WSDLMessage, WSDLNode, WSDLOperation, WSDLPart, XFAList, XMLConnection, XMLMultiSelectNode, XSDConnection
```
public interface Peer
```

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ATTR_CHANGED`
`static int`	`CHILD_ADDED`
`static int`	`CHILD_REMOVED`
`static int`	`DESCENDENT_ADDED`
`static int`	`DESCENDENT_ATTR_CHANGED`
`static int`	`DESCENDENT_REMOVED`
`static int`	`DESCENDENT_VALUE_CHANGED`
`static int`	`PARENT_CHANGED`
`static int`	`PERMS_LOCK_CLEARED`
`static int`	`PERMS_LOCK_SET`
`static int`	`PROTO_ATTR_CHANGED`
`static int`	`PROTO_CHILD_ADDED`
`static int`	`PROTO_CHILD_REMOVED`
`static int`	`PROTO_DESCENDENT_ADDED`
`static int`	`PROTO_DESCENDENT_ATTR_CHANGED`
`static int`	`PROTO_DESCENDENT_REMOVED`
`static int`	`PROTO_DESCENDENT_VALUE_CHANGED`
`static int`	`PROTO_VALUE_CHANGED`
`static int`	`UPDATED` This interface must be implemented by objects that use the `PeerList.add()` and `PeerList.remove()` methods.
`static int`	`VALUE_CHANGED`

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`addPeer(Peer peerNode)` Add a peer node to be notified of state changes.
`void`	`addPeeredNode(Peer peer)`
`void`	`clearPeers()` Removes this node from all peer relationships.
`void`	`deafen()` Makes this peer deaf to any updateFromPeer calls made by notifyPeers
`Peer`	`getPeer(int nPeer)` return the requested peer
`boolean`	`isDeaf()` Checks if this peer is deaf.
`boolean`	`isMute()` Checks if this peer is mute.
`void`	`mute()` Makes this peer no longer notify its peers when notifyPeers is called
`void`	`notifyPeers(int eventType, String arg1, Object arg2)` Sends notification to the peer nodes that this object has changed.
`void`	`peerRemoved(Peer peer)` Called when this Peer is removed from `peer`.
`void`	`removePeer(Peer peerNode)` Remove a peer node from the notification list.
`void`	`removePeeredNode(Peer peer)`
`void`	`unDeafen()` Allows this peer to receive updateFromPeer calls
`void`	`unMute()` Allows this peer to notify its peers when notifyPeers is called.
`void`	`updateFromPeer(Object peerNode, int eventType, String arg1, Object arg2)` This method will be called by the peer whenever its state changes.

- Field Detail
  - UPDATED
```
static final int UPDATED
```
    This interface must be implemented by objects that use the PeerList.add() and PeerList.remove() methods.
    A Peer can add another Peer to its peer list via addPeer(). All Peers in the peer list will be notified of peer changes when updateFromPeer() is called.
    
    See Also:
    
    Constant Field Values
  - ATTR_CHANGED
```
static final int ATTR_CHANGED
```
    See Also:
    
    Constant Field Values
  - VALUE_CHANGED
```
static final int VALUE_CHANGED
```
    See Also:
    
    Constant Field Values
  - PARENT_CHANGED
```
static final int PARENT_CHANGED
```
    See Also:
    
    Constant Field Values
  - CHILD_ADDED
```
static final int CHILD_ADDED
```
    See Also:
    
    Constant Field Values
  - CHILD_REMOVED
```
static final int CHILD_REMOVED
```
    See Also:
    
    Constant Field Values
  - DESCENDENT_ATTR_CHANGED
```
static final int DESCENDENT_ATTR_CHANGED
```
    See Also:
    
    Constant Field Values
  - DESCENDENT_VALUE_CHANGED
```
static final int DESCENDENT_VALUE_CHANGED
```
    See Also:
    
    Constant Field Values
  - DESCENDENT_ADDED
```
static final int DESCENDENT_ADDED
```
    See Also:
    
    Constant Field Values
  - DESCENDENT_REMOVED
```
static final int DESCENDENT_REMOVED
```
    See Also:
    
    Constant Field Values
  - PERMS_LOCK_SET
```
static final int PERMS_LOCK_SET
```
    See Also:
    
    Constant Field Values
  - PERMS_LOCK_CLEARED
```
static final int PERMS_LOCK_CLEARED
```
    See Also:
    
    Constant Field Values
  - PROTO_ATTR_CHANGED
```
static final int PROTO_ATTR_CHANGED
```
    See Also:
    
    Constant Field Values
  - PROTO_VALUE_CHANGED
```
static final int PROTO_VALUE_CHANGED
```
    See Also:
    
    Constant Field Values
  - PROTO_CHILD_ADDED
```
static final int PROTO_CHILD_ADDED
```
    See Also:
    
    Constant Field Values
  - PROTO_CHILD_REMOVED
```
static final int PROTO_CHILD_REMOVED
```
    See Also:
    
    Constant Field Values
  - PROTO_DESCENDENT_ATTR_CHANGED
```
static final int PROTO_DESCENDENT_ATTR_CHANGED
```
    See Also:
    
    Constant Field Values
  - PROTO_DESCENDENT_VALUE_CHANGED
```
static final int PROTO_DESCENDENT_VALUE_CHANGED
```
    See Also:
    
    Constant Field Values
  - PROTO_DESCENDENT_ADDED
```
static final int PROTO_DESCENDENT_ADDED
```
    See Also:
    
    Constant Field Values
  - PROTO_DESCENDENT_REMOVED
```
static final int PROTO_DESCENDENT_REMOVED
```
    See Also:
    
    Constant Field Values
- Method Detail
  - addPeer
```
void addPeer(Peer peerNode)
```
    Add a peer node to be notified of state changes.
    
    Parameters:
    
    peerNode - - The reference to the peer object to be added.
  - addPeeredNode
```
void addPeeredNode(Peer peer)
```
  - clearPeers
```
void clearPeers()
```
    Removes this node from all peer relationships.
  - deafen
```
void deafen()
```
    Makes this peer deaf to any updateFromPeer calls made by notifyPeers
  - getPeer
```
Peer getPeer(int nPeer)
```
    return the requested peer
    
    Parameters:
    
    nPeer - - the 0-based position of the peer to retrieve.
    
    Returns:
    
    the peer at the requested position. When there are not more peers to return, this will return a null object.
  - isDeaf
```
boolean isDeaf()
```
    Checks if this peer is deaf.
    
    Returns:
    
    true if this peer does not listen to notifyPeer calls, else false.
  - isMute
```
boolean isMute()
```
    Checks if this peer is mute.
    
    Returns:
    
    true if this peer does not notify its peers when notifyPeers is called, else false.
  - mute
```
void mute()
```
    Makes this peer no longer notify its peers when notifyPeers is called
  - notifyPeers
```
void notifyPeers(int eventType,
                 String arg1,
                 Object arg2)
```
    Sends notification to the peer nodes that this object has changed.
    
    Parameters:
    
    eventType - the event type as enumerated in this class
    
    arg1 - additional event information
    
    arg2 - additional event information
  - removePeer
```
void removePeer(Peer peerNode)
```
    Remove a peer node from the notification list.
    
    Parameters:
    
    peerNode - the peer object to be removed
  - removePeeredNode
```
void removePeeredNode(Peer peer)
```
  - unDeafen
```
void unDeafen()
```
    Allows this peer to receive updateFromPeer calls
  - unMute
```
void unMute()
```
    Allows this peer to notify its peers when notifyPeers is called.
  - updateFromPeer
```
void updateFromPeer(Object peerNode,
                    int eventType,
                    String arg1,
                    Object arg2)
```
    This method will be called by the peer whenever its state changes.
```
 eventType                        (String)arg1  (Object)arg2
 
 UPDATED                          update type   (optional)
 ATTR_CHANGED                     attr name     (optional)
 CHILD_ADDED                      (optional)    added node
 CHILD_REMOVED                    (optional)    removed node
 VALUE_CHANGED                    new data      (optional)
 PARENT_CHANGED                   (optional)    new parent
 DESCENDENT_ATTR_CHANGED          attr name     changed node
 DESCENDENT_VALUE_CHANGED         (optional)    changed node
 DESCENDENT_ADDED                 (optional)    added node
 DESCENDENT_REMOVED               (optional)    removed node
 PERMS_LOCK_SET                   (optional)    (optional)
 PERMS_LOCK_CLEARED               (optional)    (optional)
 PROTO_ATTR_CHANGED               attr name     changed node
 PROTO_CHILD_ADDED                (optional)    added node of the protoype
 PROTO_CHILD_REMOVED              (optional)    removed node from the prototype
 PROTO_VALUE_CHANGED              new data      prototype node
 PROTO_DESCENDENT_ATTR_CHANGED    attr name     changed prototype node
 PROTO_DESCENDENT_VALUE_CHANGED   (optional)    changed prototype node
 PROTO_DESCENDENT_ADDED           (optional)    added node to the prototype
 PROTO_DESCENDENT_REMOVED         (optional)    removed node from the prototype
 
```
    Parameters:
    
    peerNode - the peer to this object.
    
    eventType - the event type as enumerated in this class
    
    arg1 - additional event information
    
    arg2 - additional event information
  - peerRemoved
```
void peerRemoved(Peer peer)
```
    Called when this Peer is removed from peer. Derived classes can override this method to receive direct notifications when a peer is removed.
    
    Parameters:
    
    peer - the Peer from which this Peer has been removed from notification.

Interface Peer

Field Summary

Method Summary

Field Detail

UPDATED

ATTR_CHANGED

VALUE_CHANGED

PARENT_CHANGED

CHILD_ADDED

CHILD_REMOVED

DESCENDENT_ATTR_CHANGED

DESCENDENT_VALUE_CHANGED

DESCENDENT_ADDED

DESCENDENT_REMOVED

PERMS_LOCK_SET

PERMS_LOCK_CLEARED

PROTO_ATTR_CHANGED

PROTO_VALUE_CHANGED

PROTO_CHILD_ADDED

PROTO_CHILD_REMOVED

PROTO_DESCENDENT_ATTR_CHANGED

PROTO_DESCENDENT_VALUE_CHANGED

PROTO_DESCENDENT_ADDED

PROTO_DESCENDENT_REMOVED

Method Detail

addPeer

addPeeredNode

clearPeers

deafen

getPeer

isDeaf

isMute

mute

notifyPeers

removePeer

removePeeredNode

unDeafen

unMute

updateFromPeer

peerRemoved