org.archive.spring.OverlayContext Maven / Gradle / Ivy

/*
 *  This file is part of the Heritrix web crawler (crawler.archive.org).
 *
 *  Licensed to the Internet Archive (IA) by one or more individual 
 *  contributors. 
 *
 *  The IA 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.archive.spring;

import java.util.ArrayList;
import java.util.Map;

/**
 * Interface for objects that can contribute 'overlays' to replace the
 * usual values in configured objects. 
 * @author gojomo
 */
public interface OverlayContext {
    /** test if this context has actually been configured with overlays
     * (even if in fact no overlays were added) */
    public boolean haveOverlayNamesBeenSet();
    /** return a list of the names of overlay maps to consider */ 
    ArrayList getOverlayNames();
    /** get the map corresponding to the overlay name */ 
    Map getOverlayMap(String name);
}