FileGeometryOutput.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.BufferedOutputStream;
  19. import java.io.OutputStream;
  20. import java.nio.charset.Charset;
  21. import java.nio.file.Files;
  22. import java.nio.file.Path;

  23. import org.apache.commons.geometry.io.core.AbstractGeometryIOMetadata;
  24. import org.apache.commons.geometry.io.core.internal.GeometryIOUtils;

  25. /** {@link GeometryOutput} implementation for writing content to a file.
  26.  */
  27. public class FileGeometryOutput extends AbstractGeometryIOMetadata
  28.     implements GeometryOutput {

  29.     /** File to write to. */
  30.     private final Path file;

  31.     /** Construct a new instance with the given file and no charset.
  32.      * @param file output file
  33.      */
  34.     public FileGeometryOutput(final Path file) {
  35.         this(file, null);
  36.     }

  37.     /** Construct a new instance with the given file and charset.
  38.      * @param file output file
  39.      * @param charset file charset
  40.      */
  41.     public FileGeometryOutput(final Path file, final Charset charset) {
  42.         super(GeometryIOUtils.getFileName(file), charset);

  43.         this.file = file;
  44.     }

  45.     /** Get the output file.
  46.      * @return output file
  47.      */
  48.     public Path getFile() {
  49.         return file;
  50.     }

  51.     /** {@inheritDoc}
  52.      *
  53.      * <p>The returned output stream is buffered.</p>
  54.      */
  55.     @Override
  56.     public OutputStream getOutputStream() {
  57.         return GeometryIOUtils.getUnchecked(() -> new BufferedOutputStream(Files.newOutputStream(file)));
  58.     }

  59.     /** {@inheritDoc} */
  60.     @Override
  61.     public String toString() {
  62.         final StringBuilder sb = new StringBuilder();
  63.         sb.append(getClass().getSimpleName())
  64.             .append("[file= ")
  65.             .append(getFile())
  66.             .append(']');

  67.         return sb.toString();
  68.     }
  69. }