org.apache.directory.api.util

Interface ComponentsMonitor

All Known Implementing Classes:

AbstractSimpleComponentsMonitor, MandatoryAndOptionalComponentsMonitor, MandatoryComponentsMonitor, OptionalComponentsMonitor

public interface ComponentsMonitor

Monitor used to track existence or duplication of components.

Method Summary

Modifier and Type	Method and Description
boolean	allComponentsUsed() Check if all components are used.
boolean	finalStateValid() Checks if the final state is valid.
java.util.List<java.lang.String>	getRemainingComponents() Gets the remaining components.
ComponentsMonitor	useComponent(java.lang.String component) Use a component.

Method Detail

useComponent

ComponentsMonitor useComponent(java.lang.String component)
                        throws java.lang.IllegalArgumentException

Use a component.

Parameters:

component - the component

Returns:

this components monitor

Throws:

java.lang.IllegalArgumentException - if the component is already used

allComponentsUsed

boolean allComponentsUsed()

Check if all components are used.

Returns:

true if all components are used

finalStateValid

boolean finalStateValid()

Checks if the final state is valid. That depends whether the components are mandatory or optional.

Returns:

true if the final state is valid

getRemainingComponents

java.util.List<java.lang.String> getRemainingComponents()

Gets the remaining components.

Returns:

the remaining components