Java Doc for Inflater.java in » 6.0-JDK-Modules » j2me » java » util » zip » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation

1.	6.0 JDK Core
2.	6.0 JDK Modules
3.	6.0 JDK Modules com.sun
4.	6.0 JDK Modules com.sun.java
5.	6.0 JDK Modules sun
6.	6.0 JDK Platform
7.	Ajax
8.	Apache Harmony Java SE
9.	Aspect oriented
10.	Authentication Authorization
11.	Blogger System
12.	Build
13.	Byte Code
14.	Cache
15.	Chart
16.	Chat
17.	Code Analyzer
18.	Collaboration
19.	Content Management System
20.	Database Client
21.	Database DBMS
22.	Database JDBC Connection Pool
23.	Database ORM
24.	Development
25.	EJB Server geronimo
26.	EJB Server GlassFish
27.	EJB Server JBoss 4.2.1
28.	EJB Server resin 3.1.5
29.	ERP CRM Financial
30.	ESB
31.	Forum
32.	GIS
33.	Graphic Library
34.	Groupware
35.	HTML Parser
36.	IDE
37.	IDE Eclipse
38.	IDE Netbeans
39.	Installer
40.	Internationalization Localization
41.	Inversion of Control
42.	Issue Tracking
43.	J2EE
44.	JBoss
45.	JMS
46.	JMX
47.	Library
48.	Mail Clients
49.	Net
50.	Parser
51.	PDF
52.	Portal
53.	Profiler
54.	Project Management
55.	Report
56.	RSS RDF
57.	Rule Engine
58.	Science
59.	Scripting
60.	Search Engine
61.	Security
62.	Sevlet Container
63.	Source Control
64.	Swing Library
65.	Template Engine
66.	Test Coverage
67.	Testing
68.	UML
69.	Web Crawler
70.	Web Framework
71.	Web Mail
72.	Web Server
73.	Web Services
74.	Web Services apache cxf 2.0.1
75.	Web Services AXIS2
76.	Wiki Engine
77.	Workflow Engines
78.	XML
79.	XML UI

Java

Java Tutorial

Illustrator Tutorials

GIMP Tutorials

C# / C Sharp

C# / CSharp Tutorial

C# / CSharp Open Source

SQL Server / T-SQL Tutorial

Oracle PL / SQL

Oracle PL/SQL Tutorial

Flash / Flex / ActionScript

VBA / Excel / Access / Word

XML

XML Tutorial

Microsoft Office PowerPoint 2007 Tutorial

Microsoft Office Excel 2007 Tutorial

Microsoft Office Word 2007 Tutorial

Java Source Code / Java Documentation » 6.0 JDK Modules » j2me » java.util.zip

Source Cross Reference Class Diagram Java Document (Java Doc)

java.lang .Object

java.util.zip .Inflater

Inflater

public class Inflater (Code)

This class provides support for general purpose decompression using popular ZLIB compression library. The ZLIB compression library was initially developed as part of the PNG graphics standard and is not protected by patents. It is fully described in the specifications at the java.util.zip package description.

The following code fragment demonstrates a trivial compression and decompression of a string using Deflater and Inflater. NOTE: java.util.zip.Defalter is found in J2ME CDC profiles such as J2ME Foundation Profile.

 // Encode a String into bytes
 String inputString = "blahblahblah\u20AC\u20AC";
 byte[] input = inputString.getBytes("UTF-8");
 // Compress the bytes
 byte[] output = new byte[100];
 Deflater compresser = new Deflater();
 compresser.setInput(input);
 compresser.finish();
 int compressedDataLength = compresser.deflate(output);
 NOTE: java.util.zip.Defalter is found in J2ME CDC profiles such as
 J2ME Foundation Profile.
 // Decompress the bytes
 Inflater decompresser = new Inflater();
 decompresser.setInput(output, 0, compressedDataLength);
 byte[] result = new byte[100];
 int resultLength = decompresser.inflate(result);
 decompresser.end();
 // Decode the bytes into a String
 String outputString = new String(result, 0, resultLength, "UTF-8");

See Also:   Deflater
version:
   1.36, 05/03/00
author:
   David Connelly

Constructor Summary
public	Inflater(boolean nowrap) Creates a new decompressor.
public	Inflater() Creates a new decompressor.

Method Summary
public synchronized void	end() Closes the decompressor and discards any unprocessed input. This method should be called when the decompressor is no longer being used, but will also be called automatically by the finalize() method.
protected void	finalize() Closes the decompressor when garbage is collected.
public synchronized boolean	finished() Return true if the end of the compressed data stream has been reached.
public synchronized int	getAdler() Returns the ADLER-32 value of the uncompressed data.
public synchronized int	getRemaining() Returns the total number of bytes remaining in the input buffer.
public synchronized int	getTotalIn() Returns the total number of bytes input so far.
public synchronized int	getTotalOut() Returns the total number of bytes output so far.
public synchronized int	inflate(byte[] b, int off, int len) Uncompresses bytes into specified buffer.
public int	inflate(byte[] b) Uncompresses bytes into specified buffer.
public synchronized boolean	needsDictionary() Returns true if a preset dictionary is needed for decompression.
public synchronized boolean	needsInput() Returns true if no data remains in the input buffer.
public synchronized void	reset() Resets inflater so that a new set of input data can be processed.
public synchronized void	setDictionary(byte[] b, int off, int len) Sets the preset dictionary to the given array of bytes.
public void	setDictionary(byte[] b) Sets the preset dictionary to the given array of bytes.
public synchronized void	setInput(byte[] b, int off, int len) Sets input data for decompression.
public void	setInput(byte[] b) Sets input data for decompression.

Constructor Detail

Inflater
public Inflater(boolean nowrap)(Code)
	Creates a new decompressor. If the parameter 'nowrap' is true then the ZLIB header and checksum fields will not be used. This provides compatibility with the compression format used by both GZIP and PKZIP. Note: When using the 'nowrap' option it is also necessary to provide an extra "dummy" byte as input. This is required by the ZLIB native library in order to support certain optimizations. Parameters: nowrap - if true then support GZIP compatible compression

Inflater
public Inflater()(Code)
	Creates a new decompressor.

Method Detail

end
public synchronized void end()(Code)
	Closes the decompressor and discards any unprocessed input. This method should be called when the decompressor is no longer being used, but will also be called automatically by the finalize() method. Once this method is called, the behavior of the Inflater object is undefined.

finalize
protected void finalize()(Code)
	Closes the decompressor when garbage is collected.

finished
public synchronized boolean finished()(Code)
	Return true if the end of the compressed data stream has been reached. true if the end of the compressed data stream has beenreached

getAdler
public synchronized int getAdler()(Code)
	Returns the ADLER-32 value of the uncompressed data. the ADLER-32 value of the uncompressed data

getRemaining
public synchronized int getRemaining()(Code)
	Returns the total number of bytes remaining in the input buffer. This can be used to find out what bytes still remain in the input buffer after decompression has finished. the total number of bytes remaining in the input buffer

getTotalIn
public synchronized int getTotalIn()(Code)
	Returns the total number of bytes input so far. the total number of bytes input so far

getTotalOut
public synchronized int getTotalOut()(Code)
	Returns the total number of bytes output so far. the total number of bytes output so far

inflate
public synchronized int inflate(byte[] b, int off, int len) throws DataFormatException(Code)
	Uncompresses bytes into specified buffer. Returns actual number of bytes uncompressed. A return value of 0 indicates that needsInput() or needsDictionary() should be called in order to determine if more input data or a preset dictionary is required. In the later case, getAdler() can be used to get the Adler-32 value of the dictionary required. Parameters: b - the buffer for the uncompressed data Parameters: off - the start offset of the data Parameters: len - the maximum number of uncompressed bytes the actual number of uncompressed bytes exception: DataFormatException - if the compressed data format is invalid See Also: Inflater.needsInput See Also: Inflater.needsDictionary

inflate
public int inflate(byte[] b) throws DataFormatException(Code)
	Uncompresses bytes into specified buffer. Returns actual number of bytes uncompressed. A return value of 0 indicates that needsInput() or needsDictionary() should be called in order to determine if more input data or a preset dictionary is required. In the later case, getAdler() can be used to get the Adler-32 value of the dictionary required. Parameters: b - the buffer for the uncompressed data the actual number of uncompressed bytes exception: DataFormatException - if the compressed data format is invalid See Also: Inflater.needsInput See Also: Inflater.needsDictionary

needsDictionary
public synchronized boolean needsDictionary()(Code)
	Returns true if a preset dictionary is needed for decompression. true if a preset dictionary is needed for decompression See Also: Inflater.setDictionary

needsInput
public synchronized boolean needsInput()(Code)
	Returns true if no data remains in the input buffer. This can be used to determine if #setInput should be called in order to provide more input. true if no data remains in the input buffer

reset
public synchronized void reset()(Code)
	Resets inflater so that a new set of input data can be processed.

setDictionary
public synchronized void setDictionary(byte[] b, int off, int len)(Code)
	Sets the preset dictionary to the given array of bytes. Should be called when inflate() returns 0 and needsDictionary() returns true indicating that a preset dictionary is required. The method getAdler() can be used to get the Adler-32 value of the dictionary needed. Parameters: b - the dictionary data bytes Parameters: off - the start offset of the data Parameters: len - the length of the data See Also: Inflater.needsDictionary See Also: Inflater.getAdler

setDictionary
public void setDictionary(byte[] b)(Code)
	Sets the preset dictionary to the given array of bytes. Should be called when inflate() returns 0 and needsDictionary() returns true indicating that a preset dictionary is required. The method getAdler() can be used to get the Adler-32 value of the dictionary needed. Parameters: b - the dictionary data bytes See Also: Inflater.needsDictionary See Also: Inflater.getAdler

setInput
public synchronized void setInput(byte[] b, int off, int len)(Code)
	Sets input data for decompression. Should be called whenever needsInput() returns true indicating that more input data is required. Parameters: b - the input data bytes Parameters: off - the start offset of the input data Parameters: len - the length of the input data See Also: Inflater.needsInput

setInput
public void setInput(byte[] b)(Code)
	Sets input data for decompression. Should be called whenever needsInput() returns true indicating that more input data is required. Parameters: b - the input data bytes See Also: Inflater.needsInput

Methods inherited from java.lang.Object

public boolean equals(Object obj)(Code)(Java Doc)
final native public Class getClass()(Code)(Java Doc)
native public int hashCode()(Code)(Java Doc)
final native public void notify()(Code)(Java Doc)
final native public void notifyAll()(Code)(Java Doc)
public String toString()(Code)(Java Doc)
final native public void wait(long timeout) throws InterruptedException(Code)(Java Doc)
final public void wait(long timeout, int nanos) throws InterruptedException(Code)(Java Doc)
final public void wait() throws InterruptedException(Code)(Java Doc)

www.java2java.com | Contact Us

All other trademarks are property of their respective owners.