com.helger.photon.basic.object.client

Class ClientManager

java.lang.Object

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

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

com.helger.photon.basic.object.client.ClientManager

All Implemented Interfaces:

IAutoSaveAware, IChangeable, IDAO, IClientResolver

public class ClientManager
extends AbstractSimpleDAO
implements IClientResolver

Manages all available clients.

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
ClientManager(String sFilename)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	containsAllClientsWithID(Collection<String> aIDs) Check if all passed client IDs are contained
boolean	containsClientWithID(String sID)
IClient	createClient(String sClientID, String sDisplayName)
protected com.helger.commons.microdom.IMicroDocument	createWriteData() Create the XML document that should be saved to the file.
Set<String>	getAllClientIDs()
Collection<? extends IClient>	getAllClients()
int	getClientCount()
IClient	getClientOfID(String sID) Get the client of the specified ID.
boolean	hasAnyClient()
boolean	hasAnyClientExceptGlobal()
protected com.helger.commons.state.EChange	onInit() Custom initialization routine.
protected com.helger.commons.state.EChange	onRead(com.helger.commons.microdom.IMicroDocument aDoc) Fill the internal structures with from the passed XML document.
String	toString()
com.helger.commons.state.EChange	updateClient(String sClientID, String sDisplayName)

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, triggerExceptionHandlersRead, triggerExceptionHandlersWrite, writeToFileOnPendingChanges

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

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

Methods inherited from class java.lang.Object

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

Constructor Detail

ClientManager

public ClientManager(@Nonnull@Nonempty
             String sFilename)
              throws DAOException

Throws:

DAOException

Method Detail

onInit

@Nonnull
protected com.helger.commons.state.EChange onInit()

Description copied from class: AbstractSimpleDAO

Custom initialization routine. Called only if the underlying file does not exist yet. This method is only called within a write lock!

Overrides:

onInit in class AbstractSimpleDAO

Returns:

EChange.CHANGED if something was modified inside this method

onRead

@Nonnull
protected com.helger.commons.state.EChange onRead(@Nonnull
                                              com.helger.commons.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

@Nonnull
protected com.helger.commons.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.

createClient

@Nullable
public IClient createClient(@Nonnull@Nonempty
                            String sClientID,
                            @Nonnull@Nonempty
                            String sDisplayName)

updateClient

@Nonnull
public com.helger.commons.state.EChange updateClient(@Nonnull@Nonempty
                                                    String sClientID,
                                                    @Nonnull@Nonempty
                                                    String sDisplayName)

hasAnyClient

public boolean hasAnyClient()

hasAnyClientExceptGlobal

public boolean hasAnyClientExceptGlobal()

getClientCount

@Nonnegative
public int getClientCount()

getAllClients

@Nonnull
@ReturnsMutableCopy
public Collection<? extends IClient> getAllClients()

getAllClientIDs

@Nonnull
@ReturnsMutableCopy
public Set<String> getAllClientIDs()

getClientOfID

@Nullable
public IClient getClientOfID(@Nullable
                             String sID)

Description copied from interface: IClientResolver

Get the client of the specified ID.

Specified by:

getClientOfID in interface IClientResolver

Parameters:

sID - The ID to be resolved. May be null.

Returns:

null if no such client exists.

containsClientWithID

public boolean containsClientWithID(@Nullable
                           String sID)

containsAllClientsWithID

public boolean containsAllClientsWithID(@Nullable
                               Collection<String> aIDs)

Check if all passed client IDs are contained

Parameters:

aIDs - The IDs to be checked. May be null.

Returns:

true if either an empty collection was passed or if really all passed client IDs are contained!

toString

public String toString()

Overrides:

toString in class AbstractSimpleDAO