001    /*
002     *  Licensed to the Apache Software Foundation (ASF) under one
003     *  or more contributor license agreements.  See the NOTICE file
004     *  distributed with this work for additional information
005     *  regarding copyright ownership.  The ASF licenses this file
006     *  to you under the Apache License, Version 2.0 (the
007     *  "License"); you may not use this file except in compliance
008     *  with the License.  You may obtain a copy of the License at
009     *  
010     *    http://www.apache.org/licenses/LICENSE-2.0
011     *  
012     *  Unless required by applicable law or agreed to in writing,
013     *  software distributed under the License is distributed on an
014     *  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
015     *  KIND, either express or implied.  See the License for the
016     *  specific language governing permissions and limitations
017     *  under the License. 
018     *  
019     */
020    
021    package org.apache.directory.shared.ldap.util;
022    
023    
024    import java.util.Arrays;
025    import java.util.Collections;
026    import java.util.LinkedList;
027    import java.util.List;
028    
029    import org.apache.directory.shared.i18n.I18n;
030    
031    
032    public abstract class AbstractSimpleComponentsMonitor implements ComponentsMonitor
033    {
034        private List<String> components;
035    
036    
037        public AbstractSimpleComponentsMonitor(String[] components)
038        {
039            // register components
040            this.components = new LinkedList<String>( Arrays.asList( components ) );
041        }
042    
043    
044        public ComponentsMonitor useComponent( String component ) throws IllegalArgumentException
045        {
046            if ( !components.remove( component ) )
047            {
048                throw new IllegalArgumentException( I18n.err( I18n.ERR_04336, component ) );
049            }
050    
051            return this;
052        }
053    
054    
055        public boolean allComponentsUsed()
056        {
057            return components.isEmpty();
058        }
059    
060    
061        public List<String> getRemainingComponents()
062        {
063            return Collections.unmodifiableList( components );
064        }
065    
066    
067        public abstract boolean finalStateValid();
068    }