1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one
3 * or more contributor license agreements. See the NOTICE file
4 * distributed with this work for additional information
5 * regarding copyright ownership. The ASF licenses this file
6 * to you under the Apache License, Version 2.0 (the
7 * "License"); you may not use this file except in compliance
8 * with the License. You may obtain a copy of the License at
9 *
10 * http://www.apache.org/licenses/LICENSE-2.0
11 *
12 * Unless required by applicable law or agreed to in writing,
13 * software distributed under the License is distributed on an
14 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15 * KIND, either express or implied. See the License for the
16 * specific language governing permissions and limitations
17 * under the License.
18 *
19 */
20 package org.apache.directory.api.util;
21
22
23 import java.util.List;
24
25
26 /**
27 * Monitor used to track existence or duplication of components.
28 *
29 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
30 */
31 public interface ComponentsMonitor
32 {
33
34 /**
35 * Use a component.
36 *
37 * @param component the component
38 * @return this components monitor
39 * @throws IllegalArgumentException if the component is already used
40 */
41 ComponentsMonitor useComponent( String component );
42
43
44 /**
45 * Check if all components are used.
46 *
47 * @return true if all components are used
48 */
49 boolean allComponentsUsed();
50
51
52 /**
53 * Checks if the final state is valid. That depends whether the components are mandatory
54 * or optional.
55 *
56 * @return true if the final state is valid
57 */
58 boolean finalStateValid();
59
60
61 /**
62 * Gets the remaining components.
63 *
64 * @return the remaining components
65 */
66 List<String> getRemainingComponents();
67
68 }