freenet.node.useralerts

Class AbstractUserAlert

java.lang.Object

freenet.node.useralerts.AbstractUserAlert

All Implemented Interfaces:

UserAlert

Direct Known Subclasses:

AbstractUserEvent, BookmarkFeedUserAlert, DownloadFeedUserAlert, InvalidAddressOverrideUserAlert, IPDetectorPluginManager.MyUserAlert, IPDetectorPluginManager.PortForwardAlert, IPUndetectedUserAlert, JVMVersionAlert, MeaningfulNodeNameUserAlert, N2NTMUserAlert, NotEnoughNiceLevelsUserAlert, PeerManagerUserAlert, PeersOffersUserAlert, ProxyUserAlert, RevocationKeyFoundUserAlert, SimpleUserAlert, TimeSkewDetectedUserAlert, UpdatedVersionAvailableUserAlert, UpgradeConnectionSpeedUserAlert

public abstract class AbstractUserAlert
extends java.lang.Object
implements UserAlert

Abstract base implementation of a UserAlert.

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	valid

Fields inherited from interface freenet.node.useralerts.UserAlert

CRITICAL_ERROR, ERROR, MINOR, WARNING

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractUserAlert()
protected	AbstractUserAlert(boolean userCanDismiss, java.lang.String title, java.lang.String text, java.lang.String shortText, HTMLNode htmlText, short priorityClass, boolean valid, java.lang.String dismissButtonText, boolean shouldUnregisterOnDismiss, java.lang.Object userIdentifier)

Method Summary

Modifier and Type	Method and Description
java.lang.String	anchor()
java.lang.String	dismissButtonText()
FCPMessage	getFCPMessage()
HTMLNode	getHTMLText() Content of alert (HTML).
short	getPriorityClass() Priority class
java.lang.String	getShortText() *Really* concise text of alert.
java.lang.String	getText() Content of alert (plain text).
java.lang.String	getTitle() Title of alert (must be short!).
long	getUpdatedTime()
boolean	isEvent()
boolean	isEventNotification()
boolean	isValid() Is the alert valid right now? Suggested use is to synchronize on the alert, then check this, then get the data.
void	isValid(boolean valid)
void	onDismiss() Method to be called upon alert dismissal
boolean	shouldUnregisterOnDismiss()
boolean	userCanDismiss() Can the user dismiss the alert? If not, it persists until it is unregistered.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

valid

protected boolean valid

Constructor Detail

AbstractUserAlert

protected AbstractUserAlert()

AbstractUserAlert

protected AbstractUserAlert(boolean userCanDismiss,
                            java.lang.String title,
                            java.lang.String text,
                            java.lang.String shortText,
                            HTMLNode htmlText,
                            short priorityClass,
                            boolean valid,
                            java.lang.String dismissButtonText,
                            boolean shouldUnregisterOnDismiss,
                            java.lang.Object userIdentifier)

Method Detail

userCanDismiss

public boolean userCanDismiss()

Can the user dismiss the alert? If not, it persists until it is unregistered.

Specified by:

userCanDismiss in interface UserAlert

getTitle

public java.lang.String getTitle()

Title of alert (must be short!).

Specified by:

getTitle in interface UserAlert

getText

public java.lang.String getText()

Content of alert (plain text).

Specified by:

getText in interface UserAlert

getShortText

public java.lang.String getShortText()

Description copied from interface: UserAlert

*Really* concise text of alert. Should be comfortably under a line even when translated into a verbose language. Will link to the full details.

Specified by:

getShortText in interface UserAlert

getHTMLText

public HTMLNode getHTMLText()

Content of alert (HTML).

Specified by:

getHTMLText in interface UserAlert

getPriorityClass

public short getPriorityClass()

Priority class

Specified by:

getPriorityClass in interface UserAlert

isValid

public boolean isValid()

Is the alert valid right now? Suggested use is to synchronize on the alert, then check this, then get the data.

Specified by:

isValid in interface UserAlert

isValid

public void isValid(boolean valid)

Specified by:

isValid in interface UserAlert

dismissButtonText

public java.lang.String dismissButtonText()

Specified by:

dismissButtonText in interface UserAlert

shouldUnregisterOnDismiss

public boolean shouldUnregisterOnDismiss()

Specified by:

shouldUnregisterOnDismiss in interface UserAlert

onDismiss

public void onDismiss()

Method to be called upon alert dismissal

Specified by:

onDismiss in interface UserAlert

anchor

public java.lang.String anchor()

Specified by:

anchor in interface UserAlert

Returns:

A unique, short name for the alert. Can be simply hashCode(), not visible to the user. MUST NOT contain spaces or commas.

isEventNotification

public boolean isEventNotification()

Specified by:

isEventNotification in interface UserAlert

Returns:

True if this is an event notification. Event notifications can be bulk deleted. Eventually they will be handled differently - logged to a separate event log, and only the last few displayed on the homepage.

isEvent

public boolean isEvent()

getUpdatedTime

public long getUpdatedTime()

Specified by:

getUpdatedTime in interface UserAlert

Returns:

The Unix timestamp of when the alert was last updated

getFCPMessage

public FCPMessage getFCPMessage()

Specified by:

getFCPMessage in interface UserAlert

Returns:

A FCPMessage that is sent subscribing FCPClients