schemacrawler.tools.options.OutputWriter Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of schemacrawler Show documentation

SchemaCrawler is an open-source Java API that makes working with database metadata as easy as working with plain old Java objects. SchemaCrawler is also a database schema discovery and comprehension, and schema documentation tool. You can search for database schema objects using regular expressions, and output the schema and data in a readable text format. The output is designed to be diff-ed against other database schemas.

There is a newer version: 10.10.05

Show newest version

/*
 *
 * SchemaCrawler
 * http://sourceforge.net/projects/schemacrawler
 * Copyright (c) 2000-2014, Sualeh Fatehi.
 *
 * This library is free software; you can redistribute it and/or modify it under the terms
 * of the GNU Lesser General Public License as published by the Free Software Foundation;
 * either version 2.1 of the License, or (at your option) any later version.
 *
 * This library 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 Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License along with this
 * library; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330,
 * Boston, MA 02111-1307, USA.
 *
 */
package schemacrawler.tools.options;


import java.io.File;
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.OutputStreamWriter;
import java.io.Writer;
import java.util.logging.Level;
import java.util.logging.Logger;

import schemacrawler.schemacrawler.SchemaCrawlerException;

public final class OutputWriter
  extends Writer
{

  private static final Logger LOGGER = Logger.getLogger(OutputWriter.class
    .getName());

  private final Writer writer;
  private boolean isClosed;
  private boolean isFileOutput;
  private String description;

  public OutputWriter(final OutputOptions outputOptions)
    throws SchemaCrawlerException
  {
    this(outputOptions, false);
  }

  public OutputWriter(final OutputOptions outputOptions,
                      final boolean appendOutput)
    throws SchemaCrawlerException
  {
    writer = openOutputWriter(outputOptions, appendOutput);
  }

  @Override
  public Writer append(final char c)
    throws IOException
  {
    ensureOpen();
    return writer.append(c);
  }

  @Override
  public Writer append(final CharSequence csq)
    throws IOException
  {
    ensureOpen();
    return writer.append(csq);
  }

  @Override
  public Writer append(final CharSequence csq, final int start, final int end)
    throws IOException
  {
    ensureOpen();
    return writer.append(csq, start, end);
  }

  @Override
  public void close()
    throws IOException
  {
    ensureOpen();

    if (writer != null)
    {
      writer.flush();
    }

    if (isFileOutput)
    {
      if (writer != null)
      {
        writer.close();
        LOGGER.log(Level.INFO, "Closed output writer");
      }
    }
    else
    {
      LOGGER.log(Level.INFO,
                 "Not closing output writer, since output is not to a file");
    }

    isClosed = true;
  }

  @Override
  public void flush()
    throws IOException
  {
    ensureOpen();
    writer.flush();
  }

  @Override
  public String toString()
  {
    return description;
  }

  @Override
  public void write(final char[] cbuf)
    throws IOException
  {
    ensureOpen();
    writer.write(cbuf);
  }

  @Override
  public void write(final char[] cbuf, final int off, final int len)
    throws IOException
  {
    ensureOpen();
    writer.write(cbuf, off, len);
  }

  @Override
  public void write(final int c)
    throws IOException
  {
    ensureOpen();
    writer.write(c);
  }

  @Override
  public void write(final String str)
    throws IOException
  {
    ensureOpen();
    writer.write(str);
  }

  @Override
  public void write(final String str, final int off, final int len)
    throws IOException
  {
    ensureOpen();
    writer.write(str, off, len);
  }

  @Override
  protected void finalize()
    throws Throwable
  {
    super.finalize();
    if (!isClosed)
    {
      throw new IllegalStateException("Output writer was not closed");
    }
  }

  /**
   * Checks to make sure that the stream has not been closed.
   */
  private void ensureOpen()
    throws IOException
  {
    if (isClosed)
    {
      throw new IOException("Writer has already been closed");
    }
  }

  /**
   * Opens the output writer.
   *
   * @return Writer
   * @throws SchemaCrawlerException
   *         On an exception
   */
  private Writer openOutputWriter(final OutputOptions outputOptions,
                                  final boolean appendOutput)
    throws SchemaCrawlerException
  {
    try
    {
      final Writer writer;
      if (outputOptions == null || outputOptions.isConsoleOutput())
      {
        writer = new OutputStreamWriter(System.out);
        description = "";
        LOGGER.log(Level.INFO, "Opened output writer to console");
      }
      else if (outputOptions.isFileOutput())
      {
        isFileOutput = true;
        final File outputFile = outputOptions.getOutputFile();
        final FileOutputStream fileOutputStream = new FileOutputStream(outputFile,
                                                                       appendOutput);
        writer = new OutputStreamWriter(fileOutputStream,
                                        outputOptions.getOutputCharset());
        description = outputFile.getAbsolutePath();
        LOGGER.log(Level.INFO,
                   "Opened output writer to file, "
                       + outputFile.getAbsolutePath());
      }
      else
      {
        writer = outputOptions.getWriter();
        description = "";
        LOGGER.log(Level.INFO, "Output to provided writer");
      }
      return writer;
    }
    catch (final Exception e)
    {
      throw new SchemaCrawlerException("Could not obtain output writer", e);
    }
  }

}