org.apache.pdfbox.io.RandomAccessWrite Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of pdfbox Show documentation
Show all versions of pdfbox Show documentation
The Apache PDFBox library is an open source Java tool for working with PDF documents.
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.apache.pdfbox.io;
import java.io.Closeable;
import java.io.IOException;
/**
* An interface allowing random access write operations.
*/
public interface RandomAccessWrite extends Closeable
{
/**
* Write a byte to the stream.
*
* @param b The byte to write.
* @throws IOException If there is an IO error while writing.
*/
void write(int b) throws IOException;
/**
* Write a buffer of data to the stream.
*
* @param b The buffer to get the data from.
* @throws IOException If there is an error while writing the data.
*/
void write(byte[] b) throws IOException;
/**
* Write a buffer of data to the stream.
*
* @param b The buffer to get the data from.
* @param offset An offset into the buffer to get the data from.
* @param length The length of data to write.
* @throws IOException If there is an error while writing the data.
*/
void write(byte[] b, int offset, int length) throws IOException;
/**
* Clears all data of the buffer.
*/
void clear() throws IOException;
}