1 /* 2 * Licensed to the Apache Software Foundation (ASF) under one 3 * or more contributor license agreements. See the NOTICE file 4 * distributed with this work for additional information 5 * regarding copyright ownership. The ASF licenses this file 6 * to you under the Apache License, Version 2.0 (the 7 * "License"); you may not use this file except in compliance 8 * with the License. You may obtain a copy of the License at 9 * 10 * http://www.apache.org/licenses/LICENSE-2.0 11 * 12 * Unless required by applicable law or agreed to in writing, 13 * software distributed under the License is distributed on an 14 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 15 * KIND, either express or implied. See the License for the 16 * specific language governing permissions and limitations 17 * under the License. 18 */ 19 package org.apache.maven.doxia.siterenderer; 20 21 import java.nio.file.Path; 22 23 import org.apache.maven.doxia.parser.Parser; 24 25 /** 26 * Interface which allows to configure a particular {@link Parser} before it is being used. 27 */ 28 public interface ParserConfigurator { 29 30 /** 31 * Configures the given parser which is afterwards used to parse the source file with the given path. 32 * @param parserId the parser id 33 * @param filePath the absolute path of the file to parse 34 * @param parser the parser to configure 35 * @return {@code true} if the parser has been configured, otherwise {@code false} 36 */ 37 boolean configure(String parserId, Path filePath, Parser parser); 38 }