Coverage Report - org.apache.maven.doxia.module.site.manager.SiteModuleManager
 
Classes in this File Line Coverage Branch Coverage Complexity
SiteModuleManager
N/A
N/A
1
 
 1  
 package org.apache.maven.doxia.module.site.manager;
 2  
 
 3  
 /*
 4  
  * Licensed to the Apache Software Foundation (ASF) under one
 5  
  * or more contributor license agreements.  See the NOTICE file
 6  
  * distributed with this work for additional information
 7  
  * regarding copyright ownership.  The ASF licenses this file
 8  
  * to you under the Apache License, Version 2.0 (the
 9  
  * "License"); you may not use this file except in compliance
 10  
  * with the License.  You may obtain a copy of the License at
 11  
  *
 12  
  *   http://www.apache.org/licenses/LICENSE-2.0
 13  
  *
 14  
  * Unless required by applicable law or agreed to in writing,
 15  
  * software distributed under the License is distributed on an
 16  
  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 17  
  * KIND, either express or implied.  See the License for the
 18  
  * specific language governing permissions and limitations
 19  
  * under the License.
 20  
  */
 21  
 
 22  
 import org.apache.maven.doxia.module.site.SiteModule;
 23  
 
 24  
 import java.util.Collection;
 25  
 
 26  
 /**
 27  
  * Handles SiteModule lookups.
 28  
  *
 29  
  * @author <a href="mailto:jason@maven.org">Jason van Zyl</a>
 30  
  * @version $Id: SiteModuleManager.java 1090706 2011-04-09 23:15:28Z hboutemy $
 31  
  * @since 1.0
 32  
  */
 33  
 public interface SiteModuleManager
 34  
 {
 35  
     /** The Plexus lookup role. */
 36  
     String ROLE = SiteModuleManager.class.getName();
 37  
 
 38  
     /**
 39  
      * Returns a collection of SiteModules.
 40  
      *
 41  
      * @return The SiteModules.
 42  
      */
 43  
     Collection<SiteModule> getSiteModules();
 44  
 
 45  
     /**
 46  
      * Returns the SiteModule that corresponds to the given id.
 47  
      *
 48  
      * @param id The identifier.
 49  
      * @return The corresponding SiteModule.
 50  
      * @throws org.apache.maven.doxia.module.site.manager.SiteModuleNotFoundException if no SiteModule could be found
 51  
      * for the given id.
 52  
      */
 53  
     SiteModule getSiteModule( String id )
 54  
         throws SiteModuleNotFoundException;
 55  
 }