gololang

Class IO

java.lang.Object

gololang.IO

public final class IO
extends java.lang.Object

Module providing IO related utility functions.

Method Summary

Modifier and Type	Method and Description
static java.nio.charset.Charset	defaultCharset() Returns the default charset.
static boolean	fileExists(java.lang.Object file) Check if a file exists.
static java.lang.String	fileToText(java.lang.Object file, java.lang.Object encoding) Reads the content of a text file.
static java.io.PrintStream	printStreamFrom(java.lang.Object output) Create an PrintStream from the specified value.
static java.io.PrintStream	printStreamFrom(java.lang.Object output, java.lang.Object charset) Create an PrintStream from the specified value.
static java.lang.String	readln() Reads the next line of characters from the console.
static java.lang.String	readln(java.lang.String message) Reads the next line of characters from the console.
static java.lang.String	readPassword() Reads a password from the console with echoing disabled.
static java.lang.String	readPassword(java.lang.String message) Reads a password from the console with echoing disabled.
static char[]	secureReadPassword() Reads a password from the console with echoing disabled, returning an char[] array.
static char[]	secureReadPassword(java.lang.String message) Reads a password from the console with echoing disabled, returning an char[] array.
static void	textToFile(java.lang.Object text, java.lang.Object file) Writes some text to a file.
static void	textToFile(java.lang.Object text, java.lang.Object file, java.lang.Object charset) Writes some text to a file using the given Charset.
static java.nio.charset.Charset	toCharset(java.lang.Object encoding) Convert the given String or Charset object into a Charset.
static java.nio.file.Path	toPath(java.lang.Object file) Polymorphic Path creation.
static java.net.URL	toURL(java.lang.Object ref) Polymorphic URL creation.

Methods inherited from class java.lang.Object

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

Method Detail

defaultCharset

public static java.nio.charset.Charset defaultCharset()

Returns the default charset.

toCharset

public static java.nio.charset.Charset toCharset(java.lang.Object encoding)

Convert the given String or Charset object into a Charset.

fileToText

public static java.lang.String fileToText(java.lang.Object file,
                                          java.lang.Object encoding)
                                   throws java.lang.Throwable

Reads the content of a text file.

Parameters:

file - the file to read from as an instance of either String, File or Path.

encoding - the file encoding as a String or Charset.

Returns:

the content as a String.

Throws:

java.lang.Throwable

toPath

public static java.nio.file.Path toPath(java.lang.Object file)

Polymorphic Path creation.

Parameters:

file - the file descriptor as an instance of either String, File or Path.

Returns:

the corresponding Path object.

toURL

public static java.net.URL toURL(java.lang.Object ref)
                          throws java.net.MalformedURLException

Polymorphic URL creation.

Parameters:

ref - the url descriptor as a String, URL, URI, File or Path.

Returns:

the corresponding URL object.

Throws:

java.net.MalformedURLException

textToFile

public static void textToFile(java.lang.Object text,
                              java.lang.Object file)
                       throws java.lang.Throwable

Writes some text to a file. The file and parents directories are created if they does not exist. The file is overwritten if it already exists. If the file is "-", the content is written to standard output.

Parameters:

text - the text to write.

file - the file to write to as an instance of either String, File or Path.

Throws:

java.lang.Throwable

textToFile

public static void textToFile(java.lang.Object text,
                              java.lang.Object file,
                              java.lang.Object charset)
                       throws java.lang.Throwable

Writes some text to a file using the given Charset. The file and parents directories are created if they does not exist. The file is overwritten if it already exists. If the file is "-", the content is written to standard output.

Parameters:

text - the text to write.

file - the file to write to as an instance of either String, File or Path.

charset - the charset to encode the text in.

Throws:

java.lang.Throwable

fileExists

public static boolean fileExists(java.lang.Object file)

Check if a file exists.

Parameters:

file - the file to read from as an instance of either String, File or Path.

Returns:

true if the file exists, false if it doesn't

readln

public static java.lang.String readln()
                               throws java.io.IOException

Reads the next line of characters from the console.

Returns:

a String.

Throws:

java.io.IOException

readln

public static java.lang.String readln(java.lang.String message)
                               throws java.io.IOException

Reads the next line of characters from the console.

Parameters:

message - displays a prompt message.

Returns:

a String.

Throws:

java.io.IOException

readPassword

public static java.lang.String readPassword()
                                     throws java.io.IOException

Reads a password from the console with echoing disabled.

Returns:

a String.

Throws:

java.io.IOException

readPassword

public static java.lang.String readPassword(java.lang.String message)
                                     throws java.io.IOException

Reads a password from the console with echoing disabled.

Parameters:

message - displays a prompt message.

Returns:

a String.

Throws:

java.io.IOException

secureReadPassword

public static char[] secureReadPassword()
                                 throws java.io.IOException

Reads a password from the console with echoing disabled, returning an char[] array.

Returns:

a character array.

Throws:

java.io.IOException

secureReadPassword

public static char[] secureReadPassword(java.lang.String message)
                                 throws java.io.IOException

Reads a password from the console with echoing disabled, returning an char[] array.

Parameters:

message - displays a prompt message.

Returns:

a character array.

Throws:

java.io.IOException

printStreamFrom

public static java.io.PrintStream printStreamFrom(java.lang.Object output)
                                           throws java.io.IOException

Create an PrintStream from the specified value.

Same as printStreamFrom(output, defaultCharset())

Parameters:

output - the file to use; "-" means standard output

Returns:

a buffered PrintStream or java.lang.System.out

Throws:

java.io.IOException

See Also:

defaultCharset(), printStreamFrom(Object, Object)

printStreamFrom

public static java.io.PrintStream printStreamFrom(java.lang.Object output,
                                                  java.lang.Object charset)
                                           throws java.io.IOException

Create an PrintStream from the specified value.

If the given string is "-", java.lang.System.out is used. Otherwise, a java.nio.file.Path is created with toPath(Object). The returned PrintStream is buffered and uses the given charset. Parent directory is created. If the file exists, it is overwritten.

Parameters:

output - the file to use; "-" means standard output

charset - the charset to use, as a java.lang.String or a java.nio.charset.Charset

Returns:

a buffered PrintStream or java.lang.System.out

Throws:

java.io.IOException

See Also:

toPath(Object), toCharset(Object)