gnodet commented on code in PR #1197: URL: https://github.com/apache/maven/pull/1197#discussion_r1315406561
########## api/maven-api-spi/src/main/java/org/apache/maven/api/spi/ModelParser.java: ########## @@ -0,0 +1,71 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF 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.apache.maven.api.spi; + +import java.nio.file.Path; +import java.util.Map; +import java.util.Optional; + +import org.apache.maven.api.annotations.Experimental; +import org.apache.maven.api.annotations.Nonnull; +import org.apache.maven.api.annotations.Nullable; +import org.apache.maven.api.model.Model; +import org.apache.maven.api.services.Source; + +/** + * The {@code ModelParser} interface is used to locate and read {@link Model}s from the file system. + * This allows plugging in additional syntaxes for the main model read by Maven when building a project. + */ +@Experimental +public interface ModelParser { + + /** + * Locates the pom in the given directory. + * + * @param dir the directory to locate the pom for, never {@code null} + * @return the located pom or <code>null</code> if none was found by this parser + */ + @Nonnull + Optional<Source> locate(@Nonnull Path dir); + + /** + * Parse the model. + * + * @param source the source to parse, never {@code null} + * @param options possible parsing options, may be {@code null} + * @return the parsed {@link Model}, never {@code null} + * @throws ModelParserException if the model cannot be parsed + */ + @Nonnull + Model parse(@Nonnull Source source, @Nullable Map<String, ?> options) throws ModelParserException; Review Comment: I think so. I made that more clear in the javadoc. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: issues-unsubscr...@maven.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org
