laeubi commented on code in PR #1197: URL: https://github.com/apache/maven/pull/1197#discussion_r1308320584
########## 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: Will the source be the same as returned from locate (what would be good? the javadoc is unclear in this regards. ########## api/maven-api-core/src/main/java/org/apache/maven/api/services/Source.java: ########## @@ -20,17 +20,54 @@ import java.io.IOException; import java.io.InputStream; +import java.nio.file.Path; +import org.apache.maven.api.Session; import org.apache.maven.api.annotations.Experimental; +import org.apache.maven.api.annotations.Nonnull; +import org.apache.maven.api.annotations.Nullable; /** - * The source for a project's XML model. + * Provides access to the contents of a source independently of the + * backing store (e.g. file system, database, memory). + * <p> + * This is mainly used to parse files into objects such as + * {@link org.apache.maven.api.Project}, + * {@link org.apache.maven.api.model.Model}, + * {@link org.apache.maven.api.settings.Settings}, or + * {@link org.apache.maven.api.toolchain.PersistedToolchains}. * * @since 4.0.0 + * @see org.apache.maven.api.services.ProjectBuilder#build(Session, Source) + * @see org.apache.maven.api.services.SettingsBuilder#build(Session, Source, Source, Source) + * @see org.apache.maven.api.services.ToolchainsBuilder#build(Session, Source, Source) */ @Experimental public interface Source { + + /** + * Provides access the file to be parsed, if this source is backed by a file. + * + * @return The underlying {@code Path}, or {@code null} if this source is not backed by a file. + */ + @Nullable + Path getPath(); + + /** + * Gets a byte stream to the source contents. Closing the returned stream is the responsibility of the caller. + * + * @return A byte stream to the source contents, never {@code null}. + * @throws IOException in case of IO issue + */ + @Nonnull Review Comment: i would call this method `openStream()` to make it more clear that this always creates a new stream and is not a simple getter. ########## 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; + + /** + * Locate and parse the model in the specified directory. + * This is equivalent to {@code locate(dir).map(s -> parse(s, options))}. + * + * @param dir the directory to locate the pom for, never {@code null} + * @param options possible parsing options, may be {@code null} + * @return an optional parsed {@link Model} or {@code null} if none could be found + * @throws ModelParserException if the located model cannot be parsd + */ + default Optional<Model> locateAndParse(@Nonnull Path dir, @Nullable Map<String, ?> options) Review Comment: maybe simply `getModel( ... )` ? -- 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: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
