ldap/src/main/java/org/apache/directory/shared/ldap/util/AbstractSimpleComponentsMonitor.java

/*
 *  Licensed to the Apache Software Foundation (ASF) under one
 *  or more contributor license agreements.  See the NOTICE file
 *  distributed with this work for additional information
 *  regarding copyright ownership.  The ASF licenses this file
 *  to you under the Apache License, Version 2.0 (the
 *  "License"); you may not use this file except in compliance
 *  with the License.  You may obtain a copy of the License at
 *  
 *    http://www.apache.org/licenses/LICENSE-2.0
 *  
 *  Unless required by applicable law or agreed to in writing,
 *  software distributed under the License is distributed on an
 *  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 *  KIND, either express or implied.  See the License for the
 *  specific language governing permissions and limitations
 *  under the License. 
 *  
 */

package org.apache.directory.shared.ldap.util;


import java.util.Arrays;
import java.util.Collections;
import java.util.LinkedList;
import java.util.List;

import org.apache.directory.shared.i18n.I18n;


public abstract class AbstractSimpleComponentsMonitor implements ComponentsMonitor
{
    private List<String> components;


    public AbstractSimpleComponentsMonitor(String[] components)
    {
        // register components
        this.components = new LinkedList<String>( Arrays.asList( components ) );
    }


    public ComponentsMonitor useComponent( String component ) throws IllegalArgumentException
    {
        if ( !components.remove( component ) )
        {
            throw new IllegalArgumentException( I18n.err( I18n.ERR_04336, component ) );
        }

        return this;
    }


    public boolean allComponentsUsed()
    {
        return components.isEmpty();
    }


    public List<String> getRemainingComponents()
    {
        return Collections.unmodifiableList( components );
    }


    public abstract boolean finalStateValid();
}