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 import org.apache.maven.doxia.parser.module.ParserModuleManager; 24 25 import java.util.Collection; 26 27 /** 28 * Handles SiteModule lookups. 29 * 30 * @author <a href="mailto:jason@maven.org">Jason van Zyl</a> 31 * @version $Id: SiteModuleManager.java 1546011 2013-11-27 12:18:20Z hboutemy $ 32 * @since 1.0 33 * @deprecated use ParserModuleManager 34 * @see ParserModuleManager 35 */ 36 public interface SiteModuleManager 37 { 38 /** The Plexus lookup role. */ 39 String ROLE = SiteModuleManager.class.getName(); 40 41 /** 42 * Returns a collection of SiteModules. 43 * 44 * @return The SiteModules. 45 */ 46 Collection<SiteModule> getSiteModules(); 47 48 /** 49 * Returns the SiteModule that corresponds to the given id. 50 * 51 * @param id The identifier. 52 * @return The corresponding SiteModule. 53 * @throws org.apache.maven.doxia.module.site.manager.SiteModuleNotFoundException if no SiteModule could be found 54 * for the given id. 55 */ 56 SiteModule getSiteModule( String id ) 57 throws SiteModuleNotFoundException; 58 }