1 /**
2 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
3 *
4 * Copyright (c) 1997-2010 Oracle and/or its affiliates. All rights reserved.
5 * Portions Copyright 2013-2018 Philip Helger + contributors
6 *
7 * The contents of this file are subject to the terms of either the GNU
8 * General Public License Version 2 only ("GPL") or the Common Development
9 * and Distribution License("CDDL") (collectively, the "License"). You
10 * may not use this file except in compliance with the License. You can
11 * obtain a copy of the License at
12 * https://glassfish.dev.java.net/public/CDDL+GPL_1_1.html
13 * or packager/legal/LICENSE.txt. See the License for the specific
14 * language governing permissions and limitations under the License.
15 *
16 * When distributing the software, include this License Header Notice in each
17 * file and include the License file at packager/legal/LICENSE.txt.
18 *
19 * GPL Classpath Exception:
20 * Oracle designates this particular file as subject to the "Classpath"
21 * exception as provided by Oracle in the GPL Version 2 section of the License
22 * file that accompanied this code.
23 *
24 * Modifications:
25 * If applicable, add the following below the License Header, with the fields
26 * enclosed by brackets [] replaced by your own identifying information:
27 * "Portions Copyright [year] [name of copyright owner]"
28 *
29 * Contributor(s):
30 * If you wish your version of this file to be governed by only the CDDL or
31 * only the GPL Version 2, indicate your decision by adding "[Contributor]
32 * elects to include this software in this distribution under the [CDDL or GPL
33 * Version 2] license." If you don't indicate a single choice of license, a
34 * recipient has the option to distribute your version of this file under
35 * either the CDDL, the GPL Version 2 or to extend the choice of license to
36 * its licensees as provided above. However, if you add GPL Version 2 code
37 * and therefore, elected the GPL Version 2 license, then the option applies
38 * only if the new code is made subject to such option by the copyright
39 * holder.
40 */
41 package com.helger.jcodemodel.writer;
42
43 import java.io.File;
44 import java.io.IOException;
45 import java.io.OutputStream;
46 import java.io.Serializable;
47
48 import javax.annotation.Nonnull;
49
50 import com.helger.jcodemodel.JPackage;
51 import com.helger.jcodemodel.SourcePrintWriter;
52 import com.helger.jcodemodel.util.JCValueEnforcer;
53
54 /**
55 * Filter CodeWriter that writes a progress message to the specified
56 * {@link IProgressTracker}.
57 *
58 * @author Kohsuke Kawaguchi (kohsuke.kawaguchi@sun.com)
59 */
60 public class ProgressCodeWriter extends FilterCodeWriter
61 {
62 @FunctionalInterface
63 public static interface IProgressTracker extends Serializable
64 {
65 void println (@Nonnull String sLine);
66 }
67
68 private final IProgressTracker m_aPT;
69
70 public ProgressCodeWriter (@Nonnull final AbstractCodeWriter output, @Nonnull final IProgressTracker progress)
71 {
72 super (output);
73 JCValueEnforcer.notNull (progress, "Progress");
74 m_aPT = progress;
75 }
76
77 protected void report (@Nonnull final JPackage aPackage, @Nonnull final String sFilename)
78 {
79 if (aPackage.isUnnamed ())
80 m_aPT.println (sFilename);
81 else
82 m_aPT.println (aPackage.name ().replace ('.', File.separatorChar) + File.separatorChar + sFilename);
83 }
84
85 @Override
86 public OutputStream openBinary (@Nonnull final JPackage aPackage, @Nonnull final String sFilename) throws IOException
87 {
88 report (aPackage, sFilename);
89 return super.openBinary (aPackage, sFilename);
90 }
91
92 @Override
93 public SourcePrintWriter openSource (@Nonnull final JPackage aPackage,
94 @Nonnull final String sFilename) throws IOException
95 {
96 report (aPackage, sFilename);
97 return super.openSource (aPackage, sFilename);
98 }
99 }