1 package org.apache.maven.plugins.assembly.io; 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 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 * 43 * @throws IOException in case of an error 44 */ 45 void open() throws IOException; 46 47 /** 48 * Close the location. 49 */ 50 void close(); 51 52 /** 53 * @param buffer The buffer 54 * @return number of read bytes 55 * @throws IOException in case of an error 56 */ 57 int read( ByteBuffer buffer ) throws IOException; 58 59 /** 60 * @param buffer the buffer 61 * @return number of read bytes 62 * @throws IOException in case of an error 63 */ 64 int read( byte[] buffer ) throws IOException; 65 66 /** 67 * @return the resulting input stream. 68 * @throws IOException in case of an error 69 */ 70 InputStream getInputStream() throws IOException; 71 72 /** 73 * @return spec 74 */ 75 String getSpecification(); 76 77 }