scala.io

Source

object Source extends AnyRef

This object provides convenience methods to create an iterable representation of a source file.

go to: companion
source: Source.scala
    version
  1. 1.0, 19/08/2004

    authors:
  1. Burak Emir, Paul Phillips

Inherited
  1. Hide All
  2. Show all
  1. AnyRef
  2. Any
Visibility
  1. Public
  2. All

Value Members

  1. def !=(arg0: AnyRef): Boolean

    attributes: final
    definition classes: AnyRef
  2. def !=(arg0: Any): Boolean

    o != arg0 is the same as !(o == (arg0)).

    o != arg0 is the same as !(o == (arg0)).

    arg0

    the object to compare against this object for dis-equality.

    returns

    false if the receiver object is equivalent to the argument; true otherwise.

    attributes: final
    definition classes: Any
  3. def ##(): Int

    attributes: final
    definition classes: AnyRef → Any
  4. def $asInstanceOf[T0](): T0

    attributes: final
    definition classes: AnyRef
  5. def $isInstanceOf[T0](): Boolean

    attributes: final
    definition classes: AnyRef
  6. def ==(arg0: AnyRef): Boolean

    o == arg0 is the same as if (o eq null) arg0 eq null else o.equals(arg0).

    o == arg0 is the same as if (o eq null) arg0 eq null else o.equals(arg0).

    arg0

    the object to compare against this object for equality.

    returns

    true if the receiver object is equivalent to the argument; false otherwise.

    attributes: final
    definition classes: AnyRef
  7. def ==(arg0: Any): Boolean

    o == arg0 is the same as o.equals(arg0).

    o == arg0 is the same as o.equals(arg0).

    arg0

    the object to compare against this object for equality.

    returns

    true if the receiver object is equivalent to the argument; false otherwise.

    attributes: final
    definition classes: Any
  8. val DefaultBufSize: Int

  9. def asInstanceOf[T0]: T0

    This method is used to cast the receiver object to be of type T0.

    This method is used to cast the receiver object to be of type T0.

    Note that the success of a cast at runtime is modulo Scala's erasure semantics. Therefore the expression1.asInstanceOf[String] will throw a ClassCastException at runtime, while the expressionList(1).asInstanceOf[List[String]] will not. In the latter example, because the type argument is erased as part of compilation it is not possible to check whether the contents of the list are of the requested typed.

    returns

    the receiver object.

    attributes: final
    definition classes: Any
  10. def clone(): AnyRef

    This method creates and returns a copy of the receiver object.

    This method creates and returns a copy of the receiver object.

    The default implementation of the clone method is platform dependent.

    returns

    a copy of the receiver object.

    attributes: protected
    definition classes: AnyRef
  11. def createBufferedSource(inputStream: InputStream, bufferSize: Int = Source.this.DefaultBufSize, reset: () ⇒ Source = null, close: () ⇒ Unit = null)(implicit codec: Codec): BufferedSource

    Reads data from inputStream with a buffered reader, using the encoding in implicit parameter codec.

    Reads data from inputStream with a buffered reader, using the encoding in implicit parameter codec.

    inputStream

    the input stream from which to read

    bufferSize

    buffer size (defaults to Source.DefaultBufSize)

    reset

    a () => Source which resets the stream (if unset, reset() will throw an Exception)

    close

    a () => Unit method which closes the stream (if unset, close() will do nothing)

    codec

    (implicit) a scala.io.Codec specifying behavior (defaults to Codec.default)

    returns

    the buffered source

  12. def eq(arg0: AnyRef): Boolean

    This method is used to test whether the argument (arg0) is a reference to the receiver object (this).

    This method is used to test whether the argument (arg0) is a reference to the receiver object (this).

    The eq method implements an [http://en.wikipedia.org/wiki/Equivalence_relation equivalence relation] on non-null instances of AnyRef: * It is reflexive: for any non-null instance x of type AnyRef, x.eq(x) returns true. * It is symmetric: for any non-null instances x and y of type AnyRef, x.eq(y) returns true if and only if y.eq(x) returns true. * It is transitive: for any non-null instances x, y, and z of type AnyRef if x.eq(y) returns true and y.eq(z) returns true, then x.eq(z) returns true.

    Additionally, the eq method has three other properties. * It is consistent: for any non-null instances x and y of type AnyRef, multiple invocations of x.eq(y) consistently returns true or consistently returns false. * For any non-null instance x of type AnyRef, x.eq(null) and null.eq(x) returns false. * null.eq(null) returns true.

    When overriding the equals or hashCode methods, it is important to ensure that their behavior is consistent with reference equality. Therefore, if two objects are references to each other (o1 eq o2), they should be equal to each other (o1 == o2) and they should hash to the same value (o1.hashCode == o2.hashCode).

    arg0

    the object to compare against this object for reference equality.

    returns

    true if the argument is a reference to the receiver object; false otherwise.

    attributes: final
    definition classes: AnyRef
  13. def equals(arg0: Any): Boolean

    This method is used to compare the receiver object (this) with the argument object (arg0) for equivalence.

    This method is used to compare the receiver object (this) with the argument object (arg0) for equivalence.

    The default implementations of this method is an [http://en.wikipedia.org/wiki/Equivalence_relation equivalence relation]: * It is reflexive: for any instance x of type Any, x.equals(x) should return true. * It is symmetric: for any instances x and y of type Any, x.equals(y) should return true if and only if y.equals(x) returns true. * It is transitive: for any instances x, y, and z of type AnyRef if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.

    If you override this method, you should verify that your implementation remains an equivalence relation. Additionally, when overriding this method it is often necessary to override hashCode to ensure that objects that are "equal" (o1.equals(o2) returns true) hash to the same scala.Int (o1.hashCode.equals(o2.hashCode)).

    arg0

    the object to compare against this object for equality.

    returns

    true if the receiver object is equivalent to the argument; false otherwise.

    definition classes: AnyRef → Any
  14. def finalize(): Unit

    This method is called by the garbage collector on the receiver object when garbage collection determines that there are no more references to the object.

    This method is called by the garbage collector on the receiver object when garbage collection determines that there are no more references to the object.

    The details of when and if the finalize method are invoked, as well as the interaction between finalizeand non-local returns and exceptions, are all platform dependent.

    attributes: protected
    definition classes: AnyRef
  15. def fromBytes(bytes: Array[Byte], enc: String): Source

  16. def fromBytes(bytes: Array[Byte])(implicit codec: Codec): Source

    Create a Source from array of bytes, decoding the bytes according to codec.

    Create a Source from array of bytes, decoding the bytes according to codec.

    bytes

    ...

    returns

    the created Source instance.

  17. def fromChar(c: Char): Source

    Creates a Source instance from a single character.

    Creates a Source instance from a single character.

  18. def fromChars(chars: Array[Char]): Source

    creates Source from array of characters, with empty description.

    creates Source from array of characters, with empty description.

  19. def fromFile(file: File, bufferSize: Int)(implicit codec: Codec): BufferedSource

    Creates Source from file, using given character encoding, setting its description to filename.

    Creates Source from file, using given character encoding, setting its description to filename. Input is buffered in a buffer of size bufferSize.

  20. def fromFile(file: File, enc: String, bufferSize: Int): BufferedSource

  21. def fromFile(file: File, enc: String): BufferedSource

    same as fromFile(file, enc, Source.

    same as fromFile(file, enc, Source.DefaultBufSize)

  22. def fromFile(file: File)(implicit codec: Codec): BufferedSource

    creates Source from file, using default character encoding, setting its description to filename.

    creates Source from file, using default character encoding, setting its description to filename.

  23. def fromFile(uri: URI, enc: String): BufferedSource

    creates Source from file with given file: URI

    creates Source from file with given file: URI

  24. def fromFile(uri: URI)(implicit codec: Codec): BufferedSource

    creates Source from file with given file: URI

    creates Source from file with given file: URI

  25. def fromFile(name: String, enc: String): BufferedSource

    creates Source from file with given name, using given encoding, setting its description to filename.

    creates Source from file with given name, using given encoding, setting its description to filename.

  26. def fromFile(name: String)(implicit codec: Codec): BufferedSource

    creates Source from file with given name, setting its description to filename.

    creates Source from file with given name, setting its description to filename.

  27. def fromInputStream(is: InputStream)(implicit codec: Codec): BufferedSource

  28. def fromInputStream(is: InputStream, enc: String): BufferedSource

  29. def fromIterable(iterable: Iterable[Char]): Source

    Creates a Source from an Iterable.

    Creates a Source from an Iterable.

    iterable

    the Iterable

    returns

    the Source

  30. def fromRawBytes(bytes: Array[Byte]): Source

    Create a Source from array of bytes, assuming one byte per character (ISO-8859-1 encoding.

    Create a Source from array of bytes, assuming one byte per character (ISO-8859-1 encoding.)

  31. def fromString(s: String): Source

    creates Source from a String, with no description.

    creates Source from a String, with no description.

  32. def fromURI(uri: URI)(implicit codec: Codec): BufferedSource

    creates Source from file with given file: URI

    creates Source from file with given file: URI

  33. def fromURL(url: URL)(implicit codec: Codec): BufferedSource

    same as fromInputStream(url.

    same as fromInputStream(url.openStream())(codec)

  34. def fromURL(url: URL, enc: String): BufferedSource

    same as fromInputStream(url.

    same as fromInputStream(url.openStream())(Codec(enc))

  35. def fromURL(s: String)(implicit codec: Codec): BufferedSource

    same as fromURL(new URL(s))

    same as fromURL(new URL(s))

  36. def fromURL(s: String, enc: String): BufferedSource

    same as fromURL(new URL(s))(Codec(enc))

    same as fromURL(new URL(s))(Codec(enc))

  37. def getClass(): java.lang.Class[_ <: java.lang.Object]

    Returns a representation that corresponds to the dynamic class of the receiver object.

    Returns a representation that corresponds to the dynamic class of the receiver object.

    The nature of the representation is platform dependent.

    returns

    a representation that corresponds to the dynamic class of the receiver object.

    attributes: final
    definition classes: AnyRef
  38. def hashCode(): Int

    Returns a hash code value for the object.

    Returns a hash code value for the object.

    The default hashing algorithm is platform dependent.

    Note that it is allowed for two objects to have identical hash codes (o1.hashCode.equals(o2.hashCode)) yet not be equal (o1.equals(o2) returns false). A degenerate implementation could always return 0. However, it is required that if two objects are equal (o1.equals(o2) returns true) that they have identical hash codes (o1.hashCode.equals(o2.hashCode)). Therefore, when overriding this method, be sure to verify that the behavior is consistent with the equals method.

    returns

    the hash code value for the object.

    definition classes: AnyRef → Any
  39. def isInstanceOf[T0]: Boolean

    This method is used to test whether the dynamic type of the receiver object is T0.

    This method is used to test whether the dynamic type of the receiver object is T0.

    Note that the test result of the test is modulo Scala's erasure semantics. Therefore the expression1.isInstanceOf[String] will return false, while the expression List(1).isInstanceOf[List[String]] will return true. In the latter example, because the type argument is erased as part of compilation it is not possible to check whether the contents of the list are of the requested typed.

    returns

    true if the receiver object is an instance of erasure of type T0; false otherwise.

    attributes: final
    definition classes: Any
  40. def ne(arg0: AnyRef): Boolean

    o.ne(arg0) is the same as !(o.eq(arg0)).

    o.ne(arg0) is the same as !(o.eq(arg0)).

    arg0

    the object to compare against this object for reference dis-equality.

    returns

    false if the argument is not a reference to the receiver object; true otherwise.

    attributes: final
    definition classes: AnyRef
  41. def notify(): Unit

    Wakes up a single thread that is waiting on the receiver object's monitor.

    Wakes up a single thread that is waiting on the receiver object's monitor.

    attributes: final
    definition classes: AnyRef
  42. def notifyAll(): Unit

    Wakes up all threads that are waiting on the receiver object's monitor.

    Wakes up all threads that are waiting on the receiver object's monitor.

    attributes: final
    definition classes: AnyRef
  43. def stdin: BufferedSource

    Creates a Source from System.

    Creates a Source from System.in.

  44. def synchronized[T0](arg0: T0): T0

    attributes: final
    definition classes: AnyRef
  45. def toString(): String

    Returns a string representation of the object.

    Returns a string representation of the object.

    The default representation is platform dependent.

    returns

    a string representation of the object.

    definition classes: AnyRef → Any
  46. def wait(): Unit

    attributes: final
    definition classes: AnyRef
  47. def wait(arg0: Long, arg1: Int): Unit

    attributes: final
    definition classes: AnyRef
  48. def wait(arg0: Long): Unit

    attributes: final
    definition classes: AnyRef