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