View Javadoc

1   package org.apache.maven.model.building;
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 java.io.IOException;
23  import java.io.InputStream;
24  
25  /**
26   * Provides access to the contents of a POM independently of the backing store (e.g. file system, database, memory).
27   * <p>
28   * This interface does not support loading of parent POM(s) from the same backing store, integrators are strongly
29   * encouraged to implement {@link ModelSource2} instead of implementing this interface directly.
30   * 
31   * @author Benjamin Bentmann
32   * @see ModelSource2
33   */
34  public interface ModelSource
35  {
36  
37      /**
38       * Gets a byte stream to the POM contents. Closing the returned stream is the responsibility of the caller.
39       * 
40       * @return A byte stream to the POM contents, never {@code null}.
41       */
42      InputStream getInputStream()
43          throws IOException;
44  
45      /**
46       * Provides a user-friendly hint about the location of the POM. This could be a local file path, a URI or just an
47       * empty string. The intention is to assist users during error reporting.
48       * 
49       * @return A user-friendly hint about the location of the POM, never {@code null}.
50       */
51      String getLocation();
52  
53  }