added some docs

This commit is contained in:
James Strachan
2012-03-09 11:43:23 +00:00
parent 049a755e89
commit 0a70ed6aee
+29 -1
View File
@@ -8,67 +8,88 @@ import java.net.URL
protected val defaultBufferSize: Int = 64 * 1024 protected val defaultBufferSize: Int = 64 * 1024
protected val defaultCharset: String = "UTF-8" protected val defaultCharset: String = "UTF-8"
/** Prints the given message to [[System.out]] */
inline fun print(message : Any?) { inline fun print(message : Any?) {
System.out?.print(message) System.out?.print(message)
} }
/** Prints the given message to [[System.out]] */
inline fun print(message : Int) { inline fun print(message : Int) {
System.out?.print(message) System.out?.print(message)
} }
/** Prints the given message to [[System.out]] */
inline fun print(message : Long) { inline fun print(message : Long) {
System.out?.print(message) System.out?.print(message)
} }
/** Prints the given message to [[System.out]] */
inline fun print(message : Byte) { inline fun print(message : Byte) {
System.out?.print(message) System.out?.print(message)
} }
/** Prints the given message to [[System.out]] */
inline fun print(message : Short) { inline fun print(message : Short) {
System.out?.print(message) System.out?.print(message)
} }
/** Prints the given message to [[System.out]] */
inline fun print(message : Char) { inline fun print(message : Char) {
System.out?.print(message) System.out?.print(message)
} }
/** Prints the given message to [[System.out]] */
inline fun print(message : Boolean) { inline fun print(message : Boolean) {
System.out?.print(message) System.out?.print(message)
} }
/** Prints the given message to [[System.out]] */
inline fun print(message : Float) { inline fun print(message : Float) {
System.out?.print(message) System.out?.print(message)
} }
/** Prints the given message to [[System.out]] */
inline fun print(message : Double) { inline fun print(message : Double) {
System.out?.print(message) System.out?.print(message)
} }
/** Prints the given message to [[System.out]] */
inline fun print(message : CharArray) { inline fun print(message : CharArray) {
System.out?.print(message) System.out?.print(message)
} }
/** Prints the given message and newline to [[System.out]] */
inline fun println(message : Any?) { inline fun println(message : Any?) {
System.out?.println(message) System.out?.println(message)
} }
/** Prints the given message and newline to [[System.out]] */
inline fun println(message : Int) { inline fun println(message : Int) {
System.out?.println(message) System.out?.println(message)
} }
/** Prints the given message and newline to [[System.out]] */
inline fun println(message : Long) { inline fun println(message : Long) {
System.out?.println(message) System.out?.println(message)
} }
/** Prints the given message and newline to [[System.out]] */
inline fun println(message : Byte) { inline fun println(message : Byte) {
System.out?.println(message) System.out?.println(message)
} }
/** Prints the given message and newline to [[System.out]] */
inline fun println(message : Short) { inline fun println(message : Short) {
System.out?.println(message) System.out?.println(message)
} }
/** Prints the given message and newline to [[System.out]] */
inline fun println(message : Char) { inline fun println(message : Char) {
System.out?.println(message) System.out?.println(message)
} }
/** Prints the given message and newline to [[System.out]] */
inline fun println(message : Boolean) { inline fun println(message : Boolean) {
System.out?.println(message) System.out?.println(message)
} }
/** Prints the given message and newline to [[System.out]] */
inline fun println(message : Float) { inline fun println(message : Float) {
System.out?.println(message) System.out?.println(message)
} }
/** Prints the given message and newline to [[System.out]] */
inline fun println(message : Double) { inline fun println(message : Double) {
System.out?.println(message) System.out?.println(message)
} }
/** Prints the given message and newline to [[System.out]] */
inline fun println(message : CharArray) { inline fun println(message : CharArray) {
System.out?.println(message) System.out?.println(message)
} }
/** Prints a newline t[[System.out]] */
inline fun println() { inline fun println() {
System.out?.println() System.out?.println()
} }
@@ -111,6 +132,7 @@ private val stdin : BufferedReader = BufferedReader(InputStreamReader(object : I
} }
})) }))
/** Reads a line of input from [[System.in]] */
inline fun readLine() : String? = stdin.readLine() inline fun readLine() : String? = stdin.readLine()
/** Uses the given resource then closes it down correctly whether an exception is thrown or not */ /** Uses the given resource then closes it down correctly whether an exception is thrown or not */
@@ -139,6 +161,7 @@ inline fun <T: Closeable, R> T.use(block: (T)-> R) : R {
} }
} }
/** Returns an [Iterator] of bytes over an input stream */
fun InputStream.iterator() : ByteIterator = fun InputStream.iterator() : ByteIterator =
object: ByteIterator() { object: ByteIterator() {
override val hasNext : Boolean override val hasNext : Boolean
@@ -147,7 +170,12 @@ object: ByteIterator() {
override fun nextByte() = read().toByte() override fun nextByte() = read().toByte()
} }
inline fun InputStream.buffered(bufferSize: Int) = BufferedInputStream(this, bufferSize) /** Creates a buffered input stream */
inline fun InputStream.buffered(bufferSize: Int)
= if (this is BufferedInputStream)
this
else
BufferedInputStream(this, bufferSize)
inline val InputStream.reader : InputStreamReader inline val InputStream.reader : InputStreamReader
get() = InputStreamReader(this) get() = InputStreamReader(this)