AbstractMatsimWriter.java

Go to the documentation of this file.

/* *********************************************************************** *
 * project: org.matsim.*
 * MatsimWriter.java
 *                                                                         *
 * *********************************************************************** *
 *                                                                         *
 * copyright       : (C) 2007 by the members listed in the COPYING,        *
 *                   LICENSE and WARRANTY file.                            *
 * email           : info at matsim dot org                                *
 *                                                                         *
 * *********************************************************************** *
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *   See also COPYING, LICENSE and WARRANTY file                           *
 *                                                                         *
 * *********************************************************************** */

package org.matsim.core.utils.io;

import java.io.BufferedWriter;
import java.io.IOException;
import java.io.OutputStream;
import java.io.OutputStreamWriter;
import java.io.UncheckedIOException;
import java.nio.charset.StandardCharsets;
import java.util.zip.GZIPOutputStream;


public abstract class AbstractMatsimWriter {

    protected static final String NL = "\n";

    protected BufferedWriter writer = null;

    protected Boolean useCompression = null;

    public final void useCompression(final boolean useCompression) {
        this.useCompression = useCompression;
    }

    protected final void openFile(final String filename) throws UncheckedIOException {
        assertNotAlreadyOpen();
        if (this.useCompression == null) {
            this.writer = IOUtils.getBufferedWriter(filename);
        } else {
            this.writer = IOUtils.getBufferedWriter(filename + ".gz");
        }
    }

    protected final void openOutputStream(OutputStream outputStream) {
        assertNotAlreadyOpen();
        try {
            if (this.useCompression == null || this.useCompression) {
                this.writer = new BufferedWriter(new OutputStreamWriter(outputStream, StandardCharsets.UTF_8));
            } else {
                this.writer = new BufferedWriter(new OutputStreamWriter(new GZIPOutputStream(outputStream), StandardCharsets.UTF_8));
            }
        } catch (IOException e) {
            throw new UncheckedIOException(e);
        }
    }

    private void assertNotAlreadyOpen() {
        if (this.writer != null) {
            throw new RuntimeException("File already open.");
        }
    }

    protected final void close() throws UncheckedIOException {
        if (this.writer != null) {
            try {
                this.writer.flush();
                this.writer.close();
            } catch (IOException e) {
                throw new UncheckedIOException(e);
            } finally {
                this.writer = null;
            }
        }
    }

}