org.gerweck.scala.util.FileUtil.scala Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of gerweck-utils-java6_2.11 Show documentation

General utilies for Scala applications

There is a newer version: 3.2.0

Show newest version

package org.gerweck.scala.util

import java.nio.charset._

import org.apache.commons
import org.apache.commons.vfs2.VFS
import org.log4s._

/** Simple utility methods for dealing with files.
  *
  * @author Sarah Gerweck 
  */
@deprecated("Use the non-blocking methods from `org.gerweck.scala.util.stream.FileStreams`", "2.5")
object FileUtil {
  private val logger = getLogger
  private val manager = VFS.getManager

  /** The default character set for most methods */
  @deprecated("Use java.nio.charset.StandardCharsets.UTF_8`", "2.5")
  val utf8: Charset = StandardCharsets.UTF_8

  /** Read a file from an arbitrary URI. */
  def read(uri: String, charset: Charset = StandardCharsets.UTF_8): String = {
    val fo = manager.resolveFile(uri)
    try {
      val data = commons.io.IOUtils.toString(fo.getContent.getInputStream, charset)
      logger.debug(s"Read ${data.length} bytes from $fo")
      data
    } finally {
      fo.close
    }
  }

  /** Write a file to an arbitrary URI. */
  def write(uri: String, charset: Charset = StandardCharsets.UTF_8)(content: String): Unit = {
    val fo = manager.resolveFile(uri)
    try {
      logger.debug(s"Writing ${content.length} bytes to $fo using $charset")
      commons.io.IOUtils.write(content, fo.getContent.getOutputStream, charset)
      logger.trace("Finished writing successfully")
    } finally {
      fo.close
    }
  }
}