View Javadoc
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.fmt;
42  
43  import java.io.ByteArrayOutputStream;
44  import java.io.IOException;
45  import java.io.OutputStream;
46  
47  import javax.annotation.Nonnull;
48  import javax.annotation.WillNotClose;
49  
50  /**
51   * Allows the application to use OutputStream to define data that will be stored
52   * into a file.
53   *
54   * @author Kohsuke Kawaguchi (kohsuke.kawaguchi@sun.com)
55   */
56  public class JBinaryFile extends AbstractJResourceFile
57  {
58    private final ByteArrayOutputStream m_aBAOS = new ByteArrayOutputStream ();
59  
60    public JBinaryFile (@Nonnull final String sName)
61    {
62      super (sName);
63    }
64  
65    /**
66     * @return Data written to the returned output stream will be written to the
67     *         file.
68     */
69    @Nonnull
70    public OutputStream getDataStore ()
71    {
72      return m_aBAOS;
73    }
74  
75    @Override
76    public void build (@Nonnull @WillNotClose final OutputStream aOS) throws IOException
77    {
78      m_aBAOS.writeTo (aOS);
79    }
80  }