Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance. Project price only 1 $
You can buy this project and download/modify it how often you want.
/**
* Copyright (C) 2006-2015 phloc systems
* http://www.phloc.com
* office[at]phloc[dot]com
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.phloc.commons.io.file;
import java.io.File;
import java.io.OutputStream;
import java.nio.charset.Charset;
import java.util.List;
import javax.annotation.Nonnegative;
import javax.annotation.Nonnull;
import javax.annotation.Nullable;
import javax.annotation.concurrent.Immutable;
import com.phloc.commons.CGlobal;
import com.phloc.commons.annotations.PresentForCodeCoverage;
import com.phloc.commons.io.streams.StreamUtils;
import com.phloc.commons.state.ESuccess;
import com.phloc.commons.string.StringHelper;
/**
* All kind of file handling stuff. For other operations, please see
* {@link FileOperations} class or the instance based
* {@link FileOperationManager} class.
*
* @author Philip Helger
*/
@Immutable
public final class SimpleFileIO
{
@PresentForCodeCoverage
@SuppressWarnings ("unused")
private static final SimpleFileIO s_aInstance = new SimpleFileIO ();
private SimpleFileIO ()
{}
/**
* Get the content of the file as a byte array.
*
* @param aFile
* The file to read. May be null.
* @return null if the passed file is null or if the
* passed file does not exist.
*/
@Nullable
public static byte [] readFileBytes (@Nullable final File aFile)
{
return aFile == null ? null : StreamUtils.getAllBytes (FileUtils.getInputStream (aFile));
}
/**
* Get the content of the passed file as a string using the system line
* separator. Note: the last line does not end with the passed line separator.
*
* @param aFile
* The file to read. May be null.
* @param sCharset
* The character set to use. May not be null.
* @return null if the file does not exist, the content
* otherwise.
*/
@Nullable
@Deprecated
public static String readFileAsString (@Nullable final File aFile, @Nonnull final String sCharset)
{
return aFile == null ? null : StreamUtils.getAllBytesAsString (FileUtils.getInputStream (aFile), sCharset);
}
/**
* Get the content of the passed file as a string using the system line
* separator. Note: the last line does not end with the passed line separator.
*
* @param aFile
* The file to read. May be null.
* @param aCharset
* The character set to use. May not be null.
* @return null if the file does not exist, the content
* otherwise.
*/
@Nullable
public static String readFileAsString (@Nullable final File aFile, @Nonnull final Charset aCharset)
{
return aFile == null ? null : StreamUtils.getAllBytesAsString (FileUtils.getInputStream (aFile), aCharset);
}
/**
* Get the content of the passed file as a list of lines, whereas each line
* does not contain a separator.
*
* @param aFile
* The file to read. May be null.
* @param sCharset
* The character set to use. May not be null.
* @return null if the file does not exist, the content
* otherwise.
*/
@Nullable
@Deprecated
public static List readFileLines (@Nullable final File aFile, @Nonnull final String sCharset)
{
return aFile == null ? null : StreamUtils.readStreamLines (FileUtils.getInputStream (aFile), sCharset);
}
/**
* Get the content of the passed file as a list of lines, whereas each line
* does not contain a separator.
*
* @param aFile
* The file to read. May be null.
* @param aCharset
* The character set to use. May not be null.
* @return null if the file does not exist, the content
* otherwise.
*/
@Nullable
public static List readFileLines (@Nullable final File aFile, @Nonnull final Charset aCharset)
{
return aFile == null ? null : StreamUtils.readStreamLines (FileUtils.getInputStream (aFile), aCharset);
}
/**
* Get the content of the passed file as a list of lines, whereas each line
* does not contain a separator.
*
* @param aFile
* The file to read. May be null.
* @param sCharset
* The character set to use. May not be null.
* @param aTargetList
* The target list to be filled. May not be null.
*/
@Deprecated
public static void readFileLines (@Nullable final File aFile,
@Nonnull final String sCharset,
@Nonnull final List aTargetList)
{
if (aFile != null)
StreamUtils.readStreamLines (FileUtils.getInputStream (aFile), sCharset, aTargetList);
}
/**
* Get the content of the passed file as a list of lines, whereas each line
* does not contain a separator.
*
* @param aFile
* The file to read. May be null.
* @param aCharset
* The character set to use. May not be null.
* @param aTargetList
* The target list to be filled. May not be null.
*/
public static void readFileLines (@Nullable final File aFile,
@Nonnull final Charset aCharset,
@Nonnull final List aTargetList)
{
if (aFile != null)
StreamUtils.readStreamLines (FileUtils.getInputStream (aFile), aCharset, aTargetList);
}
@Nonnull
public static ESuccess writeFile (@Nonnull final File aFile, @Nonnull final byte [] aContent)
{
final OutputStream aFOS = FileUtils.getOutputStream (aFile);
return aFOS == null ? ESuccess.FAILURE : StreamUtils.writeStream (aFOS, aContent);
}
@Nonnull
public static ESuccess writeFile (@Nonnull final File aFile,
@Nonnull final byte [] aContent,
@Nonnegative final int nOffset,
@Nonnegative final int nLength)
{
final OutputStream aFOS = FileUtils.getOutputStream (aFile);
return aFOS == null ? ESuccess.FAILURE : StreamUtils.writeStream (aFOS, aContent, nOffset, nLength);
}
@Nonnull
@Deprecated
public static ESuccess writeFile (@Nonnull final File aFile,
@Nonnull final String sContent,
@Nonnull final String sCharset)
{
final OutputStream aFOS = FileUtils.getOutputStream (aFile);
return aFOS == null ? ESuccess.FAILURE : StreamUtils.writeStream (aFOS, sContent, sCharset);
}
@Nonnull
public static ESuccess writeFile (@Nonnull final File aFile,
@Nonnull final String sContent,
@Nonnull final Charset aCharset)
{
final OutputStream aFOS = FileUtils.getOutputStream (aFile);
return aFOS == null ? ESuccess.FAILURE : StreamUtils.writeStream (aFOS, sContent, aCharset);
}
@Nonnull
@Deprecated
public static ESuccess writeFile (@Nonnull final File aFile,
@Nonnull final List aContent,
@Nonnull final String sCharset)
{
return writeFile (aFile, StringHelper.getImploded (CGlobal.LINE_SEPARATOR, aContent), sCharset);
}
@Nonnull
public static ESuccess writeFile (@Nonnull final File aFile,
@Nonnull final List aContent,
@Nonnull final Charset aCharset)
{
return writeFile (aFile, StringHelper.getImploded (CGlobal.LINE_SEPARATOR, aContent), aCharset);
}
}
