1 /*
   2  * Copyright (c) 1997, 2016, Oracle and/or its affiliates. All rights reserved.
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * This code is free software; you can redistribute it and/or modify it
   6  * under the terms of the GNU General Public License version 2 only, as
   7  * published by the Free Software Foundation.  Oracle designates this
   8  * particular file as subject to the "Classpath" exception as provided
   9  * by Oracle in the LICENSE file that accompanied this code.
  10  *
  11  * This code is distributed in the hope that it will be useful, but WITHOUT
  12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  13  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  14  * version 2 for more details (a copy is included in the LICENSE file that
  15  * accompanied this code).
  16  *
  17  * You should have received a copy of the GNU General Public License version
  18  * 2 along with this work; if not, write to the Free Software Foundation,
  19  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  20  *
  21  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  22  * or visit www.oracle.com if you need additional information or have any
  23  * questions.
  24  */
  25 
  26 package com.sun.codemodel.internal.writer;
  27 
  28 import java.io.FilterOutputStream;
  29 import java.io.IOException;
  30 import java.io.OutputStream;
  31 import java.io.PrintStream;
  32 
  33 import com.sun.codemodel.internal.CodeWriter;
  34 import com.sun.codemodel.internal.JPackage;
  35 
  36 /**
  37  * Output all source files into a single stream with a little
  38  * formatting header in front of each file.
  39  *
  40  * This is primarily for human consumption of the generated source
  41  * code, such as to debug/test CodeModel or to quickly inspect the result.
  42  *
  43  * @author
  44  *      Kohsuke Kawaguchi (kohsuke.kawaguchi@sun.com)
  45  */
  46 public class SingleStreamCodeWriter extends CodeWriter {
  47 
  48     private final PrintStream out;
  49 
  50     /**
  51      * @param os
  52      *      This stream will be closed at the end of the code generation.
  53      */
  54     public SingleStreamCodeWriter( OutputStream os ) {
  55         out = new PrintStream(os);
  56     }
  57 
  58     @Override
  59     public OutputStream openBinary(JPackage pkg, String fileName) throws IOException {
  60         final String name = pkg != null && pkg.name().length() > 0
  61                 ? pkg.name() + '.' + fileName : fileName;
  62 
  63         out.println(
  64             "-----------------------------------" + name +
  65             "-----------------------------------");
  66 
  67         return new FilterOutputStream(out) {
  68             @Override
  69             public void close() {
  70                 // don't let this stream close
  71             }
  72         };
  73     }
  74 
  75     @Override
  76     public void close() throws IOException {
  77         out.close();
  78     }
  79 
  80 }