public abstract class SourceProvider extends Object implements Iterator<Source>
Constructor and Description |
---|
SourceProvider() |
Modifier and Type | Method and Description |
---|---|
abstract SourceProvider |
copy()
Returns a copy of this source provider in its initial state.
|
abstract void |
copyNotSetSettingsFrom(SourceProvider sourceProvider)
Copies settings which are not set in this source provider from another
source provider.
|
void |
init(ConfigurationHandlers configurationHandlers,
ControllerState controllerState)
Initializes the source provider.
|
protected abstract void |
initInternal(ConfigurationHandlers configurationHandlers,
ControllerState controllerState)
Initializes the sources provided by this SourceProvider.
|
boolean |
isInit()
Returns whether
init() was already called. |
void |
reset(ConfigurationHandlers configurationHandlers,
ControllerState controllerState)
Resets the source provider.
|
protected abstract void |
resetInternal(ConfigurationHandlers configurationHandlers,
ControllerState controllerState)
Resets the sources provided by this SourceProvider.
|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
forEachRemaining, hasNext, next, remove
public final void init(ConfigurationHandlers configurationHandlers, ControllerState controllerState) throws ConfigurationException
hasNext()
or next()
is invoked.configurationHandlers
- the configuration handlers, not null.controllerState
- the current controller state, not null.ConfigurationException
- if initializing fails.public final void reset(ConfigurationHandlers configurationHandlers, ControllerState controllerState) throws ConfigurationException
init()
must be called again.configurationHandlers
- the configuration handlers, not null.controllerState
- the current controller state, not null.ConfigurationException
- if resetting fails.protected abstract void initInternal(ConfigurationHandlers configurationHandlers, ControllerState controllerState) throws ConfigurationException
configurationHandlers
- the configuration handlers, not null.controllerState
- the current controller state, not null.ConfigurationException
- if initializing fails.protected abstract void resetInternal(ConfigurationHandlers configurationHandlers, ControllerState controllerState) throws ConfigurationException
configurationHandlers
- the configuration handlers, not null.controllerState
- the current controller state, not null.ConfigurationException
- if resetting fails.public boolean isInit()
init()
was already called.public abstract SourceProvider copy() throws ConfigurationException
init(ConfigurationHandlers, ControllerState)
method of the new source provider must be called before it can be used.ConfigurationException
- if the new SourceProvider cannot
be initialized.public abstract void copyNotSetSettingsFrom(SourceProvider sourceProvider)
sourceProvider
- the source provoder to copy the settings from.Copyright © 2000–2020 The Apache Software Foundation. All rights reserved.