org.osgl.util

Class IO

java.lang.Object

org.osgl.util.IO

public class IO
extends Object

IO utilities

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	IO.F

Constructor Summary

Constructors

Constructor and Description
IO()

Method Summary

Modifier and Type	Method and Description
static int	append(InputStream is, OutputStream os) Copy content from input stream to output stream without closing the output stream
static BufferedInputStream	buffered(InputStream is)
static BufferedOutputStream	buffered(OutputStream os)
static BufferedReader	buffered(Reader r)
static BufferedWriter	buffered(Writer w)
static File	child(File file, String fn)
static List<File>	children(File file)
static void	close(Closeable closeable)
static int	copy(InputStream is, OutputStream os)
static int	copy(InputStream is, OutputStream os, boolean closeOs) Copy an stream to another one.
static void	copyDirectory(File source, File target)
static void	delete(File file)
static void	delete(File f, boolean deleteChildren)
static InputStream	is() Returns an empty input stream
static InputStream	is(byte[] ba)
static InputStream	is(File file) Returns a file input stream
static InputStream	is(String content) Returns an input stream from a string which will be encoded with CharSet.defaultCharset()
static InputStream	is(URL url)
static Properties	loadProperties(File file) Load properties from a file
static Properties	loadProperties(InputStream inputStream) Load properties from an inputStream
static Properties	loadProperties(Reader reader) Load properties from an inputStream
static Properties	loadProperties(String content) Load properties from a string content
static OutputStream	os() Returns a byte array output stream
static OutputStream	os(File file) Returns a file output stream
static File	parent(File file)
static byte[]	readContent(File file) Read binary content of a file (warning does not use on large file !)
static byte[]	readContent(InputStream is)
static String	readContentAsString(File file) Read file content to a String (always use utf-8)
static String	readContentAsString(File file, String encoding) Read file content to a String
static String	readContentAsString(InputStream is)
static String	readContentAsString(InputStream is, String encoding)
static String	readContentAsString(URL url) Read file content to a String (always use utf-8)
static String	readContentAsString(URL url, String encoding) Read file content to a String
static Reader	reader() Returns an empty reader
static Reader	reader(byte[] ba)
static Reader	reader(File file) Returns a file reader
static Reader	reader(InputStream is)
static Reader	reader(String content) Returns a string reader from a content specified
static Reader	reader(URL url)
static List<String>	readLines(File file)
static List<String>	readLines(File file, int limit)
static List<String>	readLines(File file, String encoding)
static List<String>	readLines(File file, String encoding, int limit)
static List<String>	readLines(InputStream inputStream)
static List<String>	readLines(InputStream inputStream, int limit)
static List<String>	readLines(InputStream is, String encoding)
static List<String>	readLines(InputStream is, String encoding, int limit)
static List<String>	readLines(Reader input)
static List<String>	readLines(Reader input, int limit)
static List<String>	readLines(URL url)
static List<String>	readLines(URL url, int limit)
static List<String>	readLines(URL url, String encode)
static List<String>	readLines(URL url, String encode, int limit)
static File	tmpFile()
static File	tmpFile(String prefix, String suffix)
static File	tmpFile(String prefix, String suffix, File dir)
static void	write(byte[] data, File file) Write binary data to a file
static void	write(byte[] data, OutputStream os) Write binary data to an output steam
static int	write(InputStream is, File f)
static int	write(InputStream is, OutputStream os) Alias of copy(java.io.InputStream, java.io.OutputStream)
static void	writeContent(CharSequence content, File file) Write String content to a file (always use utf-8)
static void	writeContent(CharSequence content, File file, String encoding) Write String content to a file (always use utf-8)
static void	writeContent(CharSequence content, Writer writer)
static Writer	writer() Returns a string writer
static Writer	writer(File file) Returns a file writer
static File	zip(File... files)
static org.osgl.storage.ISObject	zip(org.osgl.storage.ISObject... objects)
static void	zipInto(File target, File... files)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

IO

public IO()

Method Detail

close

public static void close(Closeable closeable)

child

public static File child(File file,
                         String fn)

children

public static List<File> children(File file)

parent

public static File parent(File file)

tmpFile

public static File tmpFile()

tmpFile

public static File tmpFile(String prefix,
                           String suffix)

tmpFile

public static File tmpFile(String prefix,
                           String suffix,
                           File dir)

os

public static OutputStream os()

Returns a byte array output stream

Returns:

an output stream

os

public static OutputStream os(File file)

Returns a file output stream

Parameters:

file - the file to which the returned output stream can be used to write to

Returns:

an output stream that can be used to write to file specified

writer

public static Writer writer()

Returns a string writer

Returns:

an writer that write to string

writer

public static Writer writer(File file)

Returns a file writer

Parameters:

file - the file to be written

Returns:

a writer

is

public static InputStream is()

Returns an empty input stream

Returns:

an empty input stream

is

public static InputStream is(File file)

Returns a file input stream

Parameters:

file - the file to be read

Returns:

inputstream that read the file

is

public static InputStream is(byte[] ba)

is

public static InputStream is(String content)

Returns an input stream from a string which will be encoded with CharSet.defaultCharset()

Parameters:

content - the content to be read

Returns:

input stream instance that read the content

is

public static InputStream is(URL url)

reader

public static Reader reader()

Returns an empty reader

Returns:

a reader that reads empty string ""

reader

public static Reader reader(File file)

Returns a file reader

Parameters:

file - the file to be read

Returns:

a reader that reads the file specified

reader

public static Reader reader(byte[] ba)

reader

public static Reader reader(InputStream is)

reader

public static Reader reader(URL url)

reader

public static Reader reader(String content)

Returns a string reader from a content specified

Parameters:

content - the content to be read

Returns:

a string reader instance

buffered

public static BufferedOutputStream buffered(OutputStream os)

buffered

public static BufferedInputStream buffered(InputStream is)

buffered

public static BufferedWriter buffered(Writer w)

buffered

public static BufferedReader buffered(Reader r)

delete

public static void delete(File file)

delete

public static void delete(File f,
                          boolean deleteChildren)

loadProperties

public static Properties loadProperties(File file)

Load properties from a file

Parameters:

file - the properties file

Returns:

the properties loaded from the file specified

loadProperties

public static Properties loadProperties(InputStream inputStream)

Load properties from an inputStream

Parameters:

inputStream - the input stream to property source

Returns:

the properties loaded from the input stream specified

loadProperties

public static Properties loadProperties(Reader reader)

Load properties from an inputStream

Parameters:

reader - the reader to property source

Returns:

the properties loaded from the reader specified

loadProperties

public static Properties loadProperties(String content)

Load properties from a string content

Parameters:

content - the content of a properties file

Returns:

the properties loaded

readContent

public static byte[] readContent(File file)

Read binary content of a file (warning does not use on large file !)

Parameters:

file - The file te read

Returns:

The binary data

readContent

public static byte[] readContent(InputStream is)

readContentAsString

public static String readContentAsString(File file)

Read file content to a String (always use utf-8)

Parameters:

file - The file to read

Returns:

The String content

readContentAsString

public static String readContentAsString(URL url,
                                         String encoding)

Read file content to a String

Parameters:

url - The url resource to read

encoding - encoding used to read the file into string content

Returns:

The String content

readContentAsString

public static String readContentAsString(URL url)

Read file content to a String (always use utf-8)

Parameters:

url - the url resource to read

Returns:

The String content

readContentAsString

public static String readContentAsString(File file,
                                         String encoding)

Read file content to a String

Parameters:

file - The file to read

encoding - encoding used to read the file into string content

Returns:

The String content

readContentAsString

public static String readContentAsString(InputStream is)

readContentAsString

public static String readContentAsString(InputStream is,
                                         String encoding)

readLines

public static List<String> readLines(File file)

readLines

public static List<String> readLines(File file,
                                     int limit)

readLines

public static List<String> readLines(File file,
                                     String encoding)

readLines

public static List<String> readLines(File file,
                                     String encoding,
                                     int limit)

readLines

public static List<String> readLines(InputStream is,
                                     String encoding)

readLines

public static List<String> readLines(InputStream is,
                                     String encoding,
                                     int limit)

readLines

public static List<String> readLines(InputStream inputStream)

readLines

public static List<String> readLines(InputStream inputStream,
                                     int limit)

readLines

public static List<String> readLines(Reader input)

readLines

public static List<String> readLines(Reader input,
                                     int limit)

readLines

public static List<String> readLines(URL url)

readLines

public static List<String> readLines(URL url,
                                     int limit)

readLines

public static List<String> readLines(URL url,
                                     String encode)

readLines

public static List<String> readLines(URL url,
                                     String encode,
                                     int limit)

writeContent

public static void writeContent(CharSequence content,
                                File file)

Write String content to a file (always use utf-8)

Parameters:

content - The content to write

file - The file to write

writeContent

public static void writeContent(CharSequence content,
                                File file,
                                String encoding)

Write String content to a file (always use utf-8)

Parameters:

content - The content to write

file - The file to write

encoding - encoding used to write the content to file

writeContent

public static void writeContent(CharSequence content,
                                Writer writer)

append

public static int append(InputStream is,
                         OutputStream os)

Copy content from input stream to output stream without closing the output stream

Parameters:

is - input stream

os - output stream

Returns:

number of bytes appended

copy

public static int copy(InputStream is,
                       OutputStream os)

copy

public static int copy(InputStream is,
                       OutputStream os,
                       boolean closeOs)

Copy an stream to another one. It close the input stream anyway. If the param closeOs is true then close the output stream

Parameters:

is - input stream

os - output stream

closeOs - specify whether it shall close output stream after operation

Returns:

number of bytes copied

write

public static int write(InputStream is,
                        OutputStream os)

Alias of copy(java.io.InputStream, java.io.OutputStream)

Parameters:

is - input stream

os - output stream

write

public static int write(InputStream is,
                        File f)

write

public static void write(byte[] data,
                         File file)

Write binary data to a file

Parameters:

data - The binary data to write

file - The file to write

write

public static void write(byte[] data,
                         OutputStream os)

Write binary data to an output steam

Parameters:

data - the binary data to write

os - the output stream

copyDirectory

public static void copyDirectory(File source,
                                 File target)

zip

public static org.osgl.storage.ISObject zip(org.osgl.storage.ISObject... objects)

zip

public static File zip(File... files)

zipInto

public static void zipInto(File target,
                           File... files)