Package okio
Class Okio
- java.lang.Object
-
- okio.Okio
-
public final class Okio extends Object
Essential APIs for working with Okio.
-
-
Method Summary
All Methods Static Methods Concrete Methods Modifier and Type Method Description static Sink
appendingSink(File file)
Returns a sink that appends tofile
.static Sink
blackhole()
Returns a sink that writes nowhere.static BufferedSink
buffer(Sink sink)
Returns a new sink that buffers writes tosink
.static BufferedSource
buffer(Source source)
Returns a new source that buffers reads fromsource
.static Sink
sink(File file)
Returns a sink that writes tofile
.static Sink
sink(OutputStream out)
Returns a sink that writes toout
.static Sink
sink(Socket socket)
Returns a sink that writes tosocket
.static Sink
sink(Path path, OpenOption... options)
Returns a sink that writes topath
.static Source
source(File file)
Returns a source that reads fromfile
.static Source
source(InputStream in)
Returns a source that reads fromin
.static Source
source(Socket socket)
Returns a source that reads fromsocket
.static Source
source(Path path, OpenOption... options)
Returns a source that reads frompath
.
-
-
-
Method Detail
-
buffer
public static BufferedSource buffer(Source source)
Returns a new source that buffers reads fromsource
. The returned source will perform bulk reads into its in-memory buffer. Use this wherever you read a source to get an ergonomic and efficient access to data.
-
buffer
public static BufferedSink buffer(Sink sink)
Returns a new sink that buffers writes tosink
. The returned sink will batch writes tosink
. Use this wherever you write to a sink to get an ergonomic and efficient access to data.
-
sink
public static Sink sink(OutputStream out)
Returns a sink that writes toout
.
-
sink
public static Sink sink(Socket socket) throws IOException
Returns a sink that writes tosocket
. Prefer this oversink(OutputStream)
because this method honors timeouts. When the socket write times out, the socket is asynchronously closed by a watchdog thread.- Throws:
IOException
-
source
public static Source source(InputStream in)
Returns a source that reads fromin
.
-
source
public static Source source(File file) throws FileNotFoundException
Returns a source that reads fromfile
.- Throws:
FileNotFoundException
-
source
@IgnoreJRERequirement public static Source source(Path path, OpenOption... options) throws IOException
Returns a source that reads frompath
.- Throws:
IOException
-
sink
public static Sink sink(File file) throws FileNotFoundException
Returns a sink that writes tofile
.- Throws:
FileNotFoundException
-
appendingSink
public static Sink appendingSink(File file) throws FileNotFoundException
Returns a sink that appends tofile
.- Throws:
FileNotFoundException
-
sink
@IgnoreJRERequirement public static Sink sink(Path path, OpenOption... options) throws IOException
Returns a sink that writes topath
.- Throws:
IOException
-
blackhole
public static Sink blackhole()
Returns a sink that writes nowhere.
-
source
public static Source source(Socket socket) throws IOException
Returns a source that reads fromsocket
. Prefer this oversource(InputStream)
because this method honors timeouts. When the socket read times out, the socket is asynchronously closed by a watchdog thread.- Throws:
IOException
-
-