1 package org.apache.maven.shared.io.location;
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.File;
23 import java.io.IOException;
24 import java.io.InputStream;
25 import java.nio.ByteBuffer;
26
27 /**
28 * The location interface.
29 *
30 */
31 public interface Location
32 {
33
34 /**
35 * @return {@link File}.
36 * @throws IOException in case of an error.
37 */
38 File getFile() throws IOException;
39
40 /**
41 * open the location.
42 * @throws IOException in case of an error.
43 */
44 void open() throws IOException;
45
46 /**
47 * Close the location.
48 */
49 void close();
50
51 /**
52 * @param buffer The buffer.
53 * @return number of read bytes.
54 * @throws IOException in case of an error.
55 */
56 int read( ByteBuffer buffer ) throws IOException;
57
58 /**
59 * @param buffer The buffer.
60 * @return number of read bytes.
61 * @throws IOException in case of an error.
62 */
63 int read( byte[] buffer ) throws IOException;
64
65 /**
66 * @return the resulting input stream.
67 * @throws IOException in case of an error.
68 */
69 InputStream getInputStream() throws IOException;
70
71 /**
72 * @return spec.
73 */
74 String getSpecification();
75
76 }