All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.itextpdf.io.source.OutputStream Maven / Gradle / Ivy

There is a newer version: 9.0.0
Show newest version
/*

    This file is part of the iText (R) project.
    Copyright (c) 1998-2022 iText Group NV
    Authors: Bruno Lowagie, Paulo Soares, et al.

    This program is free software; you can redistribute it and/or modify
    it under the terms of the GNU Affero General Public License version 3
    as published by the Free Software Foundation with the addition of the
    following permission added to Section 15 as permitted in Section 7(a):
    FOR ANY PART OF THE COVERED WORK IN WHICH THE COPYRIGHT IS OWNED BY
    ITEXT GROUP. ITEXT GROUP DISCLAIMS THE WARRANTY OF NON INFRINGEMENT
    OF THIRD PARTY RIGHTS

    This program is distributed in the hope that it will be useful, but
    WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
    or FITNESS FOR A PARTICULAR PURPOSE.
    See the GNU Affero General Public License for more details.
    You should have received a copy of the GNU Affero General Public License
    along with this program; if not, see http://www.gnu.org/licenses or write to
    the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
    Boston, MA, 02110-1301 USA, or download the license from the following URL:
    http://itextpdf.com/terms-of-use/

    The interactive user interfaces in modified source and object code versions
    of this program must display Appropriate Legal Notices, as required under
    Section 5 of the GNU Affero General Public License.

    In accordance with Section 7(b) of the GNU Affero General Public License,
    a covered work must retain the producer line in every PDF that is created
    or manipulated using iText.

    You can be released from the requirements of the license by purchasing
    a commercial license. Buying such a license is mandatory as soon as you
    develop commercial activities involving the iText software without
    disclosing the source code of your own applications.
    These activities include: offering paid services to customers as an ASP,
    serving PDFs on the fly in a web application, shipping iText with a closed
    source product.

    For more information, please contact iText Software Corp. at this
    address: [email protected]
 */
package com.itextpdf.io.source;

import com.itextpdf.io.exceptions.IOException;


public class OutputStream extends java.io.OutputStream {


    //long=19 + max frac=6 => 26 => round to 32.
    private final ByteBuffer numBuffer = new ByteBuffer(32);
    private Boolean localHighPrecision;
    protected java.io.OutputStream outputStream = null;
    protected long currentPos = 0;
    protected boolean closeStream = true;

    /**
     * Gets global high precision setting.
     *
     * @return global high precision setting.
     */
    public static boolean getHighPrecision() {
        return ByteUtils.HighPrecision;
    }

    /**
     * Sets global high precision setting for all {@link OutputStream} instances.
     *
     * @param value if true, all floats and double will be written with high precision
     *              in all {@link OutputStream} instances.
     */
    public static void setHighPrecision(boolean value) {
        ByteUtils.HighPrecision = value;
    }

    /**
     * Gets local high precision setting.
     *
     * @return local high precision setting.
     */
    public boolean getLocalHighPrecision() {
        return this.localHighPrecision;
    }

    /**
     * Sets local high precision setting for the {@link OutputStream}.
     * Global {@link ByteUtils#HighPrecision} setting will be overridden by this one.
     *
     * @param value if true, all floats and double will be written with high precision
     *              in the underlying {@link OutputStream}.
     */
    public void setLocalHighPrecision(boolean value) {
        this.localHighPrecision = value;
    }

    /**
     * Creates a new {@link OutputStream} instance
     * based on {@link java.io.OutputStream} instance.
     *
     * @param outputStream the {@link OutputStream} instance.
     */
    public OutputStream(java.io.OutputStream outputStream) {
        super();
        this.outputStream = outputStream;
    }

    /**
     * Do not use this constructor. This is only for internal usage.
     */
    protected OutputStream() {
        super();
    }

    /**
     * Creates a new {@link OutputStream} instance
     * based on {@link java.io.OutputStream} instance and precision setting value.
     *
     * @param outputStream       the {@link java.io.OutputStream} instance.
     * @param localHighPrecision If true, all float and double values
     *                           will be written with high precision.
     *                           Global {@link ByteUtils#HighPrecision} setting
     *                           will be overridden by this one.
     */
    public OutputStream(java.io.OutputStream outputStream, boolean localHighPrecision) {
        super();
        this.outputStream = outputStream;
        this.localHighPrecision = localHighPrecision;
    }

    @Override
    public void write(int b) throws java.io.IOException {
        outputStream.write(b);
        currentPos++;
    }

    @Override
    public void write(byte[] b) throws java.io.IOException {
        outputStream.write(b);
        currentPos += b.length;
    }

    @Override
    public void write(byte[] b, int off, int len) throws java.io.IOException {
        outputStream.write(b, off, len);
        currentPos += len;
    }

    /**
     * See {@link java.io.OutputStream#write(int)}.
     *
     * @param value byte to write.
     *
     * @throws IOException if {@link java.io.IOException} occurs.
     */
    public void writeByte(byte value) {
        try {
            write(value);
        } catch (java.io.IOException e) {
            throw new IOException(IOException.CannotWriteByte, e);
        }
    }

    @Override
    public void flush() throws java.io.IOException {
        outputStream.flush();
    }

    @Override
    public void close() throws java.io.IOException {
        if (closeStream) {
            outputStream.close();
        }
    }

    /**
     * Writes long to internal {@link java.io.OutputStream} in ISO format.
     *
     * @param value value to write.
     *
     * @return this stream as passed generic stream.
     */
    public T writeLong(long value) {
        try {
            ByteUtils.getIsoBytes(value, numBuffer.reset());
            write(numBuffer.getInternalBuffer(), numBuffer.capacity() - numBuffer.size(), numBuffer.size());
            return (T) this;
        } catch (java.io.IOException e) {
            throw new IOException(IOException.CannotWriteIntNumber, e);
        }
    }

    /**
     * Writes int to internal {@link java.io.OutputStream} in ISO format.
     *
     * @param value value to write.
     *
     * @return this stream as passed generic stream.
     */
    public T writeInteger(int value) {
        try {
            ByteUtils.getIsoBytes(value, numBuffer.reset());
            write(numBuffer.getInternalBuffer(), numBuffer.capacity() - numBuffer.size(), numBuffer.size());
            return (T) this;
        } catch (java.io.IOException e) {
            throw new IOException(IOException.CannotWriteIntNumber, e);
        }
    }

    /**
     * Writes float to internal {@link java.io.OutputStream} in ISO format.
     *
     * @param value value to write.
     *
     * @return this stream as passed generic stream.
     */
    public T writeFloat(float value) {
        return writeFloat(value, localHighPrecision == null ? ByteUtils.HighPrecision : localHighPrecision);
    }

    /**
     * Writes float to internal {@link java.io.OutputStream} in ISO format.
     *
     * @param value         value to write.
     * @param highPrecision If true, float value will be written with high precision.
     *
     * @return this stream as passed generic stream.
     */
    public T writeFloat(float value, boolean highPrecision) {
        return writeDouble(value, highPrecision);
    }

    /**
     * Writes float array to internal {@link java.io.OutputStream} in ISO format.
     *
     * @param value float array to write.
     *
     * @return this stream as passed generic stream.
     */
    public T writeFloats(float[] value) {
        for (int i = 0; i < value.length; i++) {
            writeFloat(value[i]);
            if (i < value.length - 1) {
                writeSpace();
            }
        }
        return (T) this;
    }

    /**
     * Writes double to internal {@link java.io.OutputStream} in ISO format.
     *
     * @param value value to write.
     *
     * @return this stream as passed generic stream.
     */
    public T writeDouble(double value) {
        return writeDouble(value, localHighPrecision == null ? ByteUtils.HighPrecision : localHighPrecision);
    }

    /**
     * Writes double to internal {@link java.io.OutputStream} in ISO format.
     *
     * @param value         value to write.
     * @param highPrecision If true, double value will be written with high precision.
     *
     * @return this stream as passed generic stream.
     */
    public T writeDouble(double value, boolean highPrecision) {
        try {
            ByteUtils.getIsoBytes(value, numBuffer.reset(), highPrecision);
            write(numBuffer.getInternalBuffer(), numBuffer.capacity() - numBuffer.size(), numBuffer.size());
            return (T) this;
        } catch (java.io.IOException e) {
            throw new IOException(IOException.CannotWriteFloatNumber, e);
        }
    }

    /**
     * Writes byte to internal {@link java.io.OutputStream}.
     *
     * @param value value to write.
     *
     * @return this stream as passed generic stream.
     */
    public T writeByte(int value) {
        try {
            write(value);
            return (T) this;
        } catch (java.io.IOException e) {
            throw new IOException(IOException.CannotWriteByte, e);
        }
    }

    /**
     * Writes space to internal {@link java.io.OutputStream}.
     *
     * @return this stream as passed generic stream.
     */
    public T writeSpace() {
        return writeByte(' ');
    }

    /**
     * Writes new line to internal {@link java.io.OutputStream}.
     *
     * @return this stream as passed generic stream.
     */
    public T writeNewLine() {
        return writeByte('\n');
    }

    /**
     * Writes {@code String} to internal {@link java.io.OutputStream} in ISO format.
     *
     * @param value string to write.
     *
     * @return this stream as passed generic stream.
     */
    public T writeString(String value) {
        return writeBytes(ByteUtils.getIsoBytes(value));
    }

    /**
     * See {@link OutputStream#write(byte[])}.
     *
     * @param b byte array to write.
     *
     * @return this stream as passed generic stream.
     *
     * @throws com.itextpdf.io.exceptions.IOException if {@link java.io.IOException} is thrown.
     */
    public T writeBytes(byte[] b) {
        try {
            write(b);
            return (T) this;
        } catch (java.io.IOException e) {
            throw new IOException(IOException.CannotWriteBytes, e);
        }
    }

    /**
     * See {@link OutputStream#write(byte[], int, int)}.
     *
     * @param      b     the data to write.
     * @param      off   the start offset in the data.
     * @param      len   the number of bytes to write.
     *
     * @return this stream as passed generic stream.
     *
     * @throws com.itextpdf.io.exceptions.IOException if {@link java.io.IOException} is thrown.
     */
    public T writeBytes(byte[] b, int off, int len) {
        try {
            write(b, off, len);
            return (T) this;
        } catch (java.io.IOException e) {
            throw new IOException(IOException.CannotWriteBytes, e);
        }
    }

    /**
     * Gets current output stream position.
     *
     * @return current output stream position.
     */
    public long getCurrentPos() {
        return currentPos;
    }

    /**
     * Gets internal {@link java.io.OutputStream}.
     *
     * @return internal {@link java.io.OutputStream}.
     */
    public java.io.OutputStream getOutputStream() {
        return outputStream;
    }

    /**
     * Returns true, if internal {@link java.io.OutputStream} have to be closed after {@link #close()} call,
     * false otherwise.
     *
     * @return true if stream needs to be closed, false if it's done manually.
     */
    public boolean isCloseStream() {
        return closeStream;
    }

    /**
     * Sets internal {@link java.io.OutputStream} to be closed after {@link OutputStream#close()}.
     *
     * @param closeStream true if stream needs to be closed, false if it's done manually.
     */
    public void setCloseStream(boolean closeStream) {
        this.closeStream = closeStream;
    }

    /**
     * See {@link ByteArrayOutputStream#assignBytes(byte[], int)}.
     *
     * @param bytes bytes to assign.
     * @param count number of bytes to assign.
     */
    public void assignBytes(byte[] bytes, int count) {
        if (outputStream instanceof ByteArrayOutputStream) {
            ((ByteArrayOutputStream) outputStream).assignBytes(bytes, count);
            currentPos = count;
        } else {
            throw new IOException(IOException.BytesCanBeAssignedToByteArrayOutputStreamOnly);
        }
    }

    /**
     * See {@link ByteArrayOutputStream#reset()}.
     *
     * @throws com.itextpdf.io.exceptions.IOException if internal {@link OutputStream}.
     *                                     is not a {@link ByteArrayOutputStream} instance.
     */
    public void reset() {
        if (outputStream instanceof ByteArrayOutputStream) {
            ((ByteArrayOutputStream) outputStream).reset();
            currentPos = 0;
        } else {
            throw new IOException(IOException.BytesCanBeResetInByteArrayOutputStreamOnly);
        }
    }
}




© 2015 - 2024 Weber Informatics LLC | Privacy Policy