core/src/main/java/org/apache/directory/server/core/subtree/SubentryCache.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.server.core.subtree;


import java.util.HashMap;
import java.util.Iterator;
import java.util.Map;

import org.apache.directory.shared.ldap.subtree.SubtreeSpecification;


/**
 * A cache for subtree specifications.
 *
 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
 * @version $Rev$
 */
public class SubentryCache
{
    private final Map name2subentry = new HashMap();
    
    
    final Subentry getSubentry( String normalizedName )
    {
        return ( Subentry ) name2subentry.get( normalizedName );
    }
    
    
    final Subentry removeSubentry( String normalizedName )
    {
        return ( Subentry ) name2subentry.remove( normalizedName );
    }
    
    
    final Subentry setSubentry( String normalizedName, SubtreeSpecification ss, int types )
    {
        Subentry old = ( Subentry ) name2subentry.get( normalizedName );
        Subentry subentry = new Subentry();
        subentry.setSubtreeSpecification( ss );
        subentry.setTypes( types );
        name2subentry.put( normalizedName, subentry );
        return old;
    }
    
    
    final boolean hasSubentry( String normalizedName )
    {
        return name2subentry.containsKey( normalizedName );
    }
    
    
    final Iterator nameIterator()
    {
        return name2subentry.keySet().iterator();
    }
}