vanitasvitae/Smack
1
0
Fork 0
mirror of https://github.com/vanitasvitae/Smack.git synced 2024-12-22 18:48:00 +01:00
Code Issues Releases Wiki Activity

Improve javadoc of Java7ZlibInputOutputStream

Browse source
This commit is contained in:
Florian Schmaus 2014-04-27 11:04:15 +02:00
parent 86ad192bea
commit 9b235d0d8f
1 changed files with 14 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

21
core/src/main/java/org/jivesoftware/smack/compression/Java7ZlibInputOutputStream.java
View file

@ -1,6 +1,6 @@
/**
*
* Copyright 2013 Florian Schmaus
* Copyright 2013-2014 Florian Schmaus
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@ -27,14 +27,21 @@ import java.util.zip.Inflater;
import java.util.zip.InflaterInputStream;
/**
* This class provides XMPP "zlib" compression with the help of the Deflater class of the Java API. Note that the method
* needed is available since Java7, so it will only work with Java7 or higher (hence it's name).
* This class provides XMPP "zlib" compression with the help of the Deflater class of the Java API.
* Note that the method needed for compression with synchronous flush support is available since
* Java7, so it will only work with Java7 or higher (hence it's name). On Android, the required
* <code>deflate()</code> method is available on API 19 or higher.
* <p>
* See also:
* <ul>
* <li><a href=
* "http://docs.oracle.com/javase/7/docs/api/java/util/zip/Deflater.html#deflate(byte[], int, int, int)"
* >The required deflate() method (Java7)</a>
* <li><a href=
* "http://developer.android.com/reference/java/util/zip/Deflater.html#deflate(byte[], int, int, int)"
* >The required deflate() method (Android)</a>
*
* @author Florian Schmaus
* @see <a
* href="http://docs.oracle.com/javase/7/docs/api/java/util/zip/Deflater.html#deflate(byte[], int, int, int)">The
* required deflate() method</a>
*
*/
public class Java7ZlibInputOutputStream extends XMPPInputOutputStream {
private final static Method method;