Coverage Report - org.apache.commons.configuration.resolver.EntityRegistry
 
Classes in this File Line Coverage Branch Coverage Complexity
EntityRegistry
N/A
N/A
1
 
 1  
 /*
 2  
  * Licensed to the Apache Software Foundation (ASF) under one or more
 3  
  * contributor license agreements.  See the NOTICE file distributed with
 4  
  * this work for additional information regarding copyright ownership.
 5  
  * The ASF licenses this file to You under the Apache License, Version 2.0
 6  
  * (the "License"); you may not use this file except in compliance with
 7  
  * the License.  You may obtain a copy of the License at
 8  
  *
 9  
  *     http://www.apache.org/licenses/LICENSE-2.0
 10  
  *
 11  
  * Unless required by applicable law or agreed to in writing, software
 12  
  * distributed under the License is distributed on an "AS IS" BASIS,
 13  
  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 14  
  * See the License for the specific language governing permissions and
 15  
  * limitations under the License.
 16  
  */
 17  
 package org.apache.commons.configuration.resolver;
 18  
 
 19  
 import java.net.URL;
 20  
 import java.util.Map;
 21  
 
 22  
 /**
 23  
  * Interface used for registering and retrieving PUBLICID to URL mappings.
 24  
  * @author <a
 25  
  * href="http://commons.apache.org/configuration/team-list.html">Commons
 26  
  * Configuration team</a>
 27  
  * @since 1.7
 28  
  * @version $Id: EntityRegistry.java 1206577 2011-11-26 20:25:52Z oheger $
 29  
  */
 30  
 public interface EntityRegistry
 31  
 {
 32  
     /**
 33  
      * <p>
 34  
      * Registers the specified URL for the specified public identifier.
 35  
      * </p>
 36  
      * <p>
 37  
      * This implementation maps {@code PUBLICID}'s to URLs (from which
 38  
      * the resource will be loaded). A common use case for this method is to
 39  
      * register local URLs (possibly computed at runtime by a class loader) for
 40  
      * DTDs and Schemas. This allows the performance advantage of using a local
 41  
      * version without having to ensure every {@code SYSTEM} URI on every
 42  
      * processed XML document is local. This implementation provides only basic
 43  
      * functionality. If more sophisticated features are required, either calling
 44  
      * {@code XMLConfiguration.setDocumentBuilder(DocumentBuilder)} to set a custom
 45  
      * {@code DocumentBuilder} (which also can be initialized with a
 46  
      * custom {@code EntityResolver}) or creating a custom entity resolver
 47  
      * and registering it with the XMLConfiguration is recommended.
 48  
      * </p>
 49  
      *
 50  
      * @param publicId Public identifier of the Entity to be resolved
 51  
      * @param entityURL The URL to use for reading this Entity
 52  
      * @throws IllegalArgumentException if the public ID is undefined
 53  
      */
 54  
     void registerEntityId(String publicId, URL entityURL);
 55  
 
 56  
     /**
 57  
      * Returns a map with the entity IDs that have been registered using the
 58  
      * {@code registerEntityId()} method.
 59  
      *
 60  
      * @return a map with the registered entity IDs
 61  
      */
 62  
     Map<String, URL> getRegisteredEntities();
 63  
 }