net.ranides.assira.io
Class FileHelper

java.lang.Object
  net.ranides.assira.io.FileHelper

public final class FileHelper
extends Object

Klasa pomocnicza udostępniające metody do wykonania bardzo powszechnych czynności na plikach.

Author:

ranides

Method Summary

static boolean	close(Closeable object) Zamyka podany plik.
static void	copy(File output, File input) Kopiuje dane z pliku źródłowego do docelowego, w razie potrzeby tworząc plik docelowy.
static void	copy(OutputStream output, InputStream input) Kopiuje dane z jednego strumienia do drugiego, automatycznie określając optymalny rozmiar bufora.
static void	copy(OutputStream output, InputStream input, int bufsize) Kopiuje dane z jednego strumienia do drugiego, używając do transportu bufora o podanym rozmiarze.
static void	copy(String output, String input) Kopiuje dane z pliku źródłowego do docelowego, w razie potrzeby tworząc plik docelowy.
static File	createTempFile(String suffix, Class<?> clazz) Tworzy plik tymczasowy wygenerowany na podstawie przekazanych argumentów i zwraca jego lokalizację.
static File	createTempFile(String prefix, String suffix, Class<?> clazz) Tworzy plik tymczasowy wygenerowany na podstawie przekazanych argumentów i zwraca jego lokalizację.
static boolean	delete(File file) Usuwa wskazany plik.
static boolean	equals(InputStream left, InputStream right) Funkcja porównuje binarnie zawartość podanych strumieni.
static boolean	equals(InputStream left, InputStream right, int bufsize) Funkcja porównuje binarnie zawartość podanych strumieni.
static void	extractResource(Class<?> clazz, String resource, File path) Wypakowuje z pliku JAR zasób o podanej nazwie do pliku zewnętrznego o podanej lokalizacji.
static void	extractResource(String resource, File path) Wypakowuje z pliku JAR zasób o podanej nazwie do pliku zewnętrznego o podanej lokalizacji.
static byte[]	getContent(File file) Ładuje zawartość podanego pliku i zwraca w postaci danych binarnych.
static byte[]	getContent(String file) Ładuje zawartość podanego pliku i zwraca w postaci danych binarnych.

Methods inherited from class java.lang.Object

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

Method Detail

delete

public static boolean delete(File file)

Usuwa wskazany plik. Nie zwraca uwagi na to, czy plik jest katalogiem, pustym katalogiem, czy czymkolwiek innym... po prostu usuwa.

Parameters:

file -

Returns:

getContent

public static byte[] getContent(File file)
                         throws IOException

Ładuje zawartość podanego pliku i zwraca w postaci danych binarnych.

Parameters:

file -

Returns:

Throws:

IOException

getContent

public static byte[] getContent(String file)
                         throws IOException

Ładuje zawartość podanego pliku i zwraca w postaci danych binarnych.

Parameters:

file -

Returns:

Throws:

IOException

close

public static boolean close(Closeable object)

Zamyka podany plik. Funkcja odporna na null. Nie rzuca wyjątków.

null safe method

Parameters:

object -

Returns:

false - tylko, jeśli zamknięcie pliku nie powiodło się. Jeśli plik udało się zamknąć, albo przekazano do funkcji null, to zwraca true

copy

public static void copy(OutputStream output,
                        InputStream input,
                        int bufsize)
                 throws IOException

Kopiuje dane z jednego strumienia do drugiego, używając do transportu bufora o podanym rozmiarze. Oba strumienie są zamykane po zakończeniu operacji.

Parameters:

output -

input -

bufsize -

Throws:

IOException

copy

public static void copy(OutputStream output,
                        InputStream input)
                 throws IOException

Kopiuje dane z jednego strumienia do drugiego, automatycznie określając optymalny rozmiar bufora. Note: na ten moment rozmiar bufora wynosi po prostu 4096. Oba strumienie są zamykane po zakończeniu operacji.

Parameters:

output -

input -

Throws:

IOException

copy

public static void copy(File output,
                        File input)
                 throws IOException

Kopiuje dane z pliku źródłowego do docelowego, w razie potrzeby tworząc plik docelowy. Note: funkcja tworząc plik nie próbuje tworzyć całej koniecznej struktury katalogów.

Parameters:

output -

input -

Throws:

IOException

copy

public static void copy(String output,
                        String input)
                 throws IOException

Kopiuje dane z pliku źródłowego do docelowego, w razie potrzeby tworząc plik docelowy. Note: funkcja tworząc plik nie próbuje tworzyć całej koniecznej struktury katalogów.

Parameters:

output -

input -

Throws:

IOException

equals

public static boolean equals(InputStream left,
                             InputStream right,
                             int bufsize)
                      throws IOException

Funkcja porównuje binarnie zawartość podanych strumieni. Strumienie nie są zamykane po zakończeniu operacji. Strumienie nie są przewijane na początek przed rozpoczęciem operacji.

Parameters:

left -

right -

bufsize -

Returns:

Throws:

IOException

equals

public static boolean equals(InputStream left,
                             InputStream right)
                      throws IOException

Funkcja porównuje binarnie zawartość podanych strumieni. Strumienie nie są zamykane po zakończeniu operacji. Strumienie nie są przewijane na początek przed rozpoczęciem operacji. Note: na ten moment rozmiar bufora wynosi po prostu 4096.

Parameters:

left -

right -

Returns:

Throws:

IOException

extractResource

public static void extractResource(Class<?> clazz,
                                   String resource,
                                   File path)
                            throws IOException

Wypakowuje z pliku JAR zasób o podanej nazwie do pliku zewnętrznego o podanej lokalizacji.

Parameters:

clazz - zasób jest szukany w tym samym pliku JAR, z którego załadowana została podana klasa

resource - nazwa zasobu

path - lokalizacja pliku, do którego zostaną zapisane wypakowane dane.

Throws:

IOException

extractResource

public static void extractResource(String resource,
                                   File path)
                            throws IOException

Wypakowuje z pliku JAR zasób o podanej nazwie do pliku zewnętrznego o podanej lokalizacji. Zasób jest szukany w tym samym pliku JAR, z którego została załadowana klasa wywołująca metodę extractResource (mówiąc obrazowo: z bieżącego pliku JAR).

Parameters:

resource - nazwa zasobu

path - lokalizacja pliku, do którego zostaną zapisane wypakowane dane.

Throws:

IOException

createTempFile

public static File createTempFile(String prefix,
                                  String suffix,
                                  Class<?> clazz)
                           throws IOException

Tworzy plik tymczasowy wygenerowany na podstawie przekazanych argumentów i zwraca jego lokalizację. Wygenerowana lokalizacja ma postać:

 %temp%/{package...}/{classname}/{prefix}{random}{.suffix} 

Parameters:

prefix -

suffix -

clazz -

Returns:

Throws:

IOException

createTempFile

public static File createTempFile(String suffix,
                                  Class<?> clazz)
                           throws IOException

Tworzy plik tymczasowy wygenerowany na podstawie przekazanych argumentów i zwraca jego lokalizację. Plik nie zawiera żadnych losowych fragmentów - wygenerowana lokalizacja ma w pełni deterministyczną postać:

 %temp%/{package...}/{classname}{.suffix}

Jeśli suffix = null, to plik przyjmuje rozszerzenie ".tmp"

Parameters:

suffix -

clazz -

Returns:

Throws:

IOException