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.api.services.model;
20
21 import java.io.IOException;
22 import java.nio.file.Path;
23
24 import org.apache.maven.api.annotations.Nonnull;
25 import org.apache.maven.api.annotations.Nullable;
26 import org.apache.maven.api.model.Model;
27 import org.apache.maven.api.services.xml.XmlReaderException;
28 import org.apache.maven.api.services.xml.XmlReaderRequest;
29
30 /**
31 * ModelProcessor
32 */
33 public interface ModelProcessor {
34
35 /**
36 * Returns the file containing the pom to be parsed or null if a pom can not be found
37 * at the given file or in the given directory.
38 */
39 @Nullable
40 Path locateExistingPom(@Nonnull Path project);
41
42 /**
43 * Reads the model from the specified byte stream. The stream will be automatically closed before the method
44 * returns.
45 *
46 * @param request The reader request to deserialize the model, must not be {@code null}.
47 * @return The deserialized model, never {@code null}.
48 * @throws IOException If the model could not be deserialized.
49 * @throws XmlReaderException If the input format could not be parsed.
50 */
51 Model read(XmlReaderRequest request) throws IOException, XmlReaderException;
52 }