com.atlassian.confluence.event.events.content.attachment

Class AttachmentEvent

java.lang.Object

java.util.EventObject

org.springframework.context.ApplicationEvent

com.atlassian.event.Event

com.atlassian.confluence.event.events.ConfluenceEvent

com.atlassian.confluence.event.events.content.ContentEvent

com.atlassian.confluence.event.events.content.attachment.AttachmentEvent

All Implemented Interfaces:

Contented, Timestamped, Serializable

Direct Known Subclasses:

AttachmentTrashedEvent, AttachmentViewEvent, GeneralAttachmentBatchUploadCompletedEvent, GeneralAttachmentCreateEvent, GeneralAttachmentRemoveEvent, GeneralAttachmentRestoreEvent, GeneralAttachmentUpdateEvent, GeneralAttachmentVersionRemoveEvent

public abstract class AttachmentEvent
extends ContentEvent

Parent class for all attachment related events.

See Also:

Serialized Form

Field Summary

Fields inherited from class java.util.EventObject

source

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AttachmentEvent(Object src, Attachment attachment) Convenience method.
protected	AttachmentEvent(Object src, Attachment attachment, boolean suppressNotifications) Convenience method.
protected	AttachmentEvent(Object src, List<Attachment> attachments) Convenience method.
protected	AttachmentEvent(Object src, List<Attachment> attachments, boolean suppressNotifications) Constructs a multi-attachment event.

Method Summary

Modifier and Type	Method and Description
boolean	equals(@Nullable Object o) Equals for ConfluenceEvents is defined such that specific sub-events are only equal to events of the same type.
@NonNull ContentEntityObject	getAttachedTo()
Attachment	getAttachment() Returns the real content (the first attachment of the list or null if there is none)
@NonNull List<Attachment>	getAttachments()
@NonNull ContentEntityObject	getContent()
int	hashCode() Subclasses must override this to hash their own fields.

Methods inherited from class com.atlassian.confluence.event.events.content.ContentEvent

isSuppressNotifications, setSuppressNotifications

Methods inherited from class org.springframework.context.ApplicationEvent

getTimestamp

Methods inherited from class java.util.EventObject

getSource, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.atlassian.confluence.event.events.Timestamped

getTimestamp

Constructor Detail

AttachmentEvent

protected AttachmentEvent(Object src,
                          List<Attachment> attachments,
                          boolean suppressNotifications)

Constructs a multi-attachment event. All attachments in the list must have the same container.

Parameters:

src - the object publishing the event

attachments - the list of attachments that this event is about

suppressNotifications - whether or not to trigger notifications (e.g. emails to users watching the page)

AttachmentEvent

protected AttachmentEvent(Object src,
                          List<Attachment> attachments)

Convenience method. Equivalent to calling new AttachmentEvent(src, attachments, false)

See Also:

AttachmentEvent(java.lang.Object, java.util.List, boolean)

AttachmentEvent

protected AttachmentEvent(Object src,
                          Attachment attachment)

Convenience method. Equivalent to calling new AttachmentEvent(src, Collections.singletonList(attachment), false)

See Also:

AttachmentEvent(java.lang.Object, java.util.List, boolean)

AttachmentEvent

protected AttachmentEvent(Object src,
                          Attachment attachment,
                          boolean suppressNotifications)

Convenience method. Equivalent to calling new AttachmentEvent(src, Collections.singletonList(attachment), suppressNotifications)

See Also:

AttachmentEvent(java.lang.Object, java.util.List, boolean)

Method Detail

getContent

public @NonNull ContentEntityObject getContent()

getAttachedTo

public @NonNull ContentEntityObject getAttachedTo()

getAttachment

public Attachment getAttachment()

Returns the real content (the first attachment of the list or null if there is none)

See Also:

getAttachments()

getAttachments

public @NonNull List<Attachment> getAttachments()

equals

public boolean equals(@Nullable Object o)

Description copied from class: ConfluenceEvent

Equals for ConfluenceEvents is defined such that specific sub-events are only equal to events of the same type. It is incorrect to try to make an instance of a subclass equal to an instance of any of its superclasses.

Subclasses must override this to compare their own fields.

Overrides:

equals in class ContentEvent

Parameters:

o - the object to compare.

Returns:

true, if the given object has the same runtime class as this object's runtime class, and the event sources are equal.

See Also:

Event.equals(Object)

hashCode

public int hashCode()

Description copied from class: ConfluenceEvent

Subclasses must override this to hash their own fields.

Overrides:

hashCode in class ContentEvent

Returns:

the hashcode

See Also:

Event.hashCode()