com.helger.photon.basic.app.systemmsg

Class SystemMessageManager

java.lang.Object

com.helger.photon.basic.app.dao.impl.AbstractDAO

com.helger.photon.basic.app.dao.impl.AbstractSimpleDAO

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

All Implemented Interfaces:

IAutoSaveAware, IChangeable, IDAO

public final class SystemMessageManager
extends AbstractSimpleDAO

This class manages global system messages.

Author:

Philip Helger

Nested Class Summary

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

IDAO.EMode

Field Summary

Fields inherited from class com.helger.photon.basic.app.dao.impl.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() Create the XML document that should be saved to the file.
LocalDateTime	getLastUpdateDT()
ESystemMessageType	getMessageType()
String	getSystemMessage()
boolean	hasSystemMessage()
protected com.helger.commons.state.EChange	onRead(com.helger.xml.microdom.IMicroDocument aDoc) Fill the internal structures with from the passed XML document.
void	reload()
com.helger.commons.state.EChange	setSystemMessage(ESystemMessageType eMessageType, String sMessage)
String	toString()

Methods inherited from class com.helger.photon.basic.app.dao.impl.AbstractSimpleDAO

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

Methods inherited from class com.helger.photon.basic.app.dao.impl.AbstractDAO

beginWithoutAutoSave, endWithoutAutoSave, getExceptionHandlersRead, getExceptionHandlersWrite, hasPendingChanges, internalHasPendingChanges, internalIsAutoSaveEnabled, internalSetPendingChanges, isAutoSaveEnabled, isDebugLogging, performWithoutAutoSave, performWithoutAutoSave, performWithoutAutoSaveThrowing, performWithoutAutoSaveThrowing

Methods inherited from class java.lang.Object

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

Constructor Detail

SystemMessageManager

public SystemMessageManager(@Nullable
                            String sFilename)
                     throws DAOException

Throws:

DAOException

Method Detail

reload

public void reload()

onRead

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

Description copied from class: AbstractSimpleDAO

Fill the internal structures with from the passed XML document. This method is only called within a write lock!

Specified by:

onRead in class AbstractSimpleDAO

Parameters:

aDoc - The XML document to read from. Never null.

Returns:

EChange.CHANGED if reading the data changed something in the internal structures that requires a writing.

createWriteData

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

Description copied from class: AbstractSimpleDAO

Create the XML document that should be saved to the file. This method is only called within a write lock!

Specified by:

createWriteData in class AbstractSimpleDAO

Returns:

The non-null document to write to the file.

getLastUpdateDT

@Nullable
public LocalDateTime getLastUpdateDT()

getMessageType

@Nonnull
public ESystemMessageType getMessageType()

getSystemMessage

@Nullable
public String getSystemMessage()

hasSystemMessage

public boolean hasSystemMessage()

setSystemMessage

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

toString

public String toString()

Overrides:

toString in class AbstractSimpleDAO