StreamGeometryOutput.java

  1. /*
  2.  * Licensed to the Apache Software Foundation (ASF) under one or more
  3.  * contributor license agreements.  See the NOTICE file distributed with
  4.  * this work for additional information regarding copyright ownership.
  5.  * The ASF licenses this file to You under the Apache License, Version 2.0
  6.  * (the "License"); you may not use this file except in compliance with
  7.  * the License.  You may obtain a copy of the License at
  8.  *
  9.  *      http://www.apache.org/licenses/LICENSE-2.0
  10.  *
  11.  * Unless required by applicable law or agreed to in writing, software
  12.  * distributed under the License is distributed on an "AS IS" BASIS,
  13.  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14.  * See the License for the specific language governing permissions and
  15.  * limitations under the License.
  16.  */
  17. package org.apache.commons.geometry.io.core.output;

  18. import java.io.OutputStream;
  19. import java.nio.charset.Charset;

  20. import org.apache.commons.geometry.io.core.AbstractGeometryIOMetadata;

  21. /** {@link GeometryOutput} implementation that wraps an {@link OutputStream}.
  22.  */
  23. public class StreamGeometryOutput extends AbstractGeometryIOMetadata
  24.     implements GeometryOutput {

  25.     /** Output stream. */
  26.     private final OutputStream out;

  27.     /** Construct a new instance that writes to the given output stream with
  28.      * no configured file name or charset.
  29.      * @param out output stream
  30.      */
  31.     public StreamGeometryOutput(final OutputStream out) {
  32.         this(out, null, null);
  33.     }

  34.     /** Construct a new instance that writes to the given output stream with the
  35.      * configured file name but no charset.
  36.      * @param out output stream
  37.      * @param fileName output file name; may be null
  38.      */
  39.     public StreamGeometryOutput(final OutputStream out, final String fileName) {
  40.         this(out, fileName, null);
  41.     }

  42.     /** Construct a new instance that writes to the given output stream with the configured
  43.      * file name and charset.
  44.      * @param out output stream
  45.      * @param fileName output file name; may be null
  46.      * @param charset output charset; may be null
  47.      */
  48.     public StreamGeometryOutput(final OutputStream out, final String fileName, final Charset charset) {
  49.         super(fileName, charset);

  50.         this.out = out;
  51.     }

  52.     /** {@inheritDoc} */
  53.     @Override
  54.     public OutputStream getOutputStream() {
  55.         return out;
  56.     }
  57. }