com.helger.photon.basic.app.systemmsg

Class SystemMessageManager

java.lang.Object

com.helger.dao.AbstractDAO

com.helger.dao.simple.AbstractSimpleDAO

com.helger.photon.basic.app.dao.AbstractPhotonSimpleDAO

com.helger.photon.basic.app.systemmsg.SystemMessageManager

All Implemented Interfaces:

com.helger.dao.IAutoSaveAware, com.helger.dao.IDAO

public final class SystemMessageManager
extends AbstractPhotonSimpleDAO

This class manages global system messages.

Author:

Philip Helger

Nested Class Summary

Nested classes/interfaces inherited from interface com.helger.dao.IDAO

com.helger.dao.IDAO.EMode

Field Summary

Fields inherited from class com.helger.dao.AbstractDAO

DEFAULT_AUTO_SAVE_ENABLED, m_aRWLock

Constructor Summary

Constructors

Constructor and Description
SystemMessageManager(String sFilename)

Method Summary

Modifier and Type	Method and Description
protected com.helger.xml.microdom.IMicroDocument	createWriteData()
LocalDateTime	getLastUpdateDT()
ESystemMessageType	getMessageType()
String	getSystemMessage()
boolean	hasSystemMessage()
boolean	isReloadable()
protected com.helger.commons.state.EChange	onRead(com.helger.xml.microdom.IMicroDocument aDoc)
void	reload()
com.helger.commons.state.EChange	setSystemMessage(ESystemMessageType eMessageType, String sMessage)
String	toString()

Methods inherited from class com.helger.dao.simple.AbstractSimpleDAO

beforeWriteToFile, getFilenameProvider, getInitCount, getIO, getLastFilename, getLastInitDateTime, getLastReadDateTime, getLastWriteDateTime, getReadCount, getSafeFile, getWriteCount, getXMLWriterSettings, initialRead, markAsChanged, modifyWriteData, onFilenameChange, onInit, triggerExceptionHandlersRead, triggerExceptionHandlersWrite, writeToFileOnPendingChanges

Methods inherited from class com.helger.dao.AbstractDAO

beginWithoutAutoSave, endWithoutAutoSave, exceptionHandlersRead, exceptionHandlersWrite, hasPendingChanges, internalHasPendingChanges, internalIsAutoSaveEnabled, internalSetPendingChanges, isAutoSaveEnabled, isDebugLogging

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.helger.dao.IAutoSaveAware

performWithoutAutoSave, performWithoutAutoSave, performWithoutAutoSaveThrowing, performWithoutAutoSaveThrowing

Constructor Detail

SystemMessageManager

public SystemMessageManager(@Nullable
                            String sFilename)
                     throws com.helger.dao.DAOException

Throws:

com.helger.dao.DAOException

Method Detail

isReloadable

public boolean isReloadable()

reload

public void reload()

onRead

protected com.helger.commons.state.EChange onRead(@Nonnull
                                                  com.helger.xml.microdom.IMicroDocument aDoc)

Specified by:

onRead in class com.helger.dao.simple.AbstractSimpleDAO

createWriteData

protected com.helger.xml.microdom.IMicroDocument createWriteData()

Specified by:

createWriteData in class com.helger.dao.simple.AbstractSimpleDAO

getLastUpdateDT

@Nullable
public LocalDateTime getLastUpdateDT()

Returns:

The date and time when the system message was last modified. May be null.

getMessageType

@Nonnull
public ESystemMessageType getMessageType()

Returns:

The type of system message. Never null.

getSystemMessage

@Nullable
public String getSystemMessage()

Returns:

The system message text itself. May be null.

hasSystemMessage

public boolean hasSystemMessage()

Returns:

true if a system message text is available, false if not.

setSystemMessage

@Nonnull
public com.helger.commons.state.EChange setSystemMessage(@Nonnull
                                                                   ESystemMessageType eMessageType,
                                                                   @Nullable
                                                                   String sMessage)

toString

public String toString()

Overrides:

toString in class com.helger.dao.simple.AbstractSimpleDAO