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 *    https://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
021package org.apache.directory.api.util;
022
023
024import java.util.Arrays;
025import java.util.Collections;
026import java.util.LinkedList;
027import java.util.List;
028
029import org.apache.directory.api.i18n.I18n;
030
031
032/**
033 * Abstract implementation of a components monitor.
034 *
035 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
036 */
037public abstract class AbstractSimpleComponentsMonitor implements ComponentsMonitor
038{
039
040    /** The components. */
041    private List<String> components;
042
043
044    /**
045     * Instantiates a new abstract simple components monitor.
046     *
047     * @param components the components
048     */
049    public AbstractSimpleComponentsMonitor( String[] components )
050    {
051        // register components
052        this.components = new LinkedList<>( Arrays.asList( components ) );
053    }
054
055
056    /**
057     * {@inheritDoc}
058     */
059    @Override
060    public ComponentsMonitor useComponent( String component )
061    {
062        if ( !components.remove( component ) )
063        {
064            throw new IllegalArgumentException( I18n.err( I18n.ERR_17026_UNREGISTRED_COMPONENT, component ) );
065        }
066
067        return this;
068    }
069
070
071    /**
072     * {@inheritDoc}
073     */
074    @Override
075    public boolean allComponentsUsed()
076    {
077        return components.isEmpty();
078    }
079
080
081    /**
082     * {@inheritDoc}
083     */
084    @Override
085    public List<String> getRemainingComponents()
086    {
087        return Collections.unmodifiableList( components );
088    }
089
090}