net.sf.mmm.util.component.api

Interface Refreshable

All Known Subinterfaces:

JaxbBeanHolder<T>, LuceneFieldManager, ManagedSearchEngine, SearchConfigurationHolder<T>, SearchEngineConfigurationHolder, SearchIndexerConfigurationHolder, SearchIndexerStateHolder, SearchQueryBuilder, SearchViewLogic

All Known Implementing Classes:

AbstractSearchEngine, AbstractSearchQueryBuilder, AbstractSearchServlet, GenericSearchServlet, JaxbBeanHolderImpl, LuceneFieldManagerImpl, LuceneSearchEngine, LuceneSearchQueryBuilder, SearchEngineConfigurationHolderImpl, SearchIndexerConfigurationHolderImpl, SearchIndexerStateHolderImpl

public interface Refreshable

This is the interface for an object that can be refreshed.

Since:

2.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

See Also:

Closeable, Flushable

Method Summary

Modifier and Type	Method and Description
boolean	refresh() This method refreshes the given object.

Method Detail

refresh

boolean refresh()

This method refreshes the given object. This can be anything from reloading configuration to rebuilding the internal state. An invocation of this method may be expensive and should only be invoked as needed. The implementation of this method should be thread-safe if the object itself is to be used by separate consumers at all.

Returns:

true if something has changed, false otherwise. If the implementation can not determine the change it should return true.