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.building;
20
21 import java.io.IOException;
22 import java.io.InputStream;
23
24 /**
25 * Provides access to the contents of a source independently of the backing store (e.g. file system, database, memory).
26 *
27 */
28 public interface Source {
29
30 /**
31 * Gets a byte stream to the source contents. Closing the returned stream is the responsibility of the caller.
32 *
33 * @return A byte stream to the source contents, never {@code null}.
34 * @throws IOException in case of IO issue
35 */
36 InputStream getInputStream() throws IOException;
37
38 /**
39 * Provides a user-friendly hint about the location of the source. This could be a local file path, a URI or just an
40 * empty string. The intention is to assist users during error reporting.
41 *
42 * @return A user-friendly hint about the location of the source, never {@code null}.
43 */
44 String getLocation();
45 }