SAP ABAP Class CL_ABAP_UNGZIP_TEXT_STREAM (Class for Text Decompression (UnGzip Text Streaming))

Hierarchy

☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-ABA-LA (Application Component) Syntax, Compiler, Runtime
     ⤷ ABAP_EXPIMP (Package) Package for EXPORT IMPORT

Properties

Class	CL_ABAP_UNGZIP_TEXT_STREAM
Short Description	Class for Text Decompression (UnGzip Text Streaming)
Super Class
Instantiability of a Class	2	Public
Final	☑

General Data

Message Class
Program status
Category	0
Package	ABAP_EXPIMP	Package for EXPORT IMPORT
Created	20030506	SAP
Last change	20030604	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

#	Type group / Object type	Type	Type Description
1	ABAP	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)

Interfaces

Class CL_ABAP_UNGZIP_TEXT_STREAM has no interface implemented.

Friends

Class CL_ABAP_UNGZIP_TEXT_STREAM has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	CHAR_BUF	Instance attribute	Private	☐	Type reference (TYPE)	STRING		Char. Buffer	20030520
2	CHAR_BUF_FILL	Instance attribute	Private	☐	Type reference (TYPE)	I		Fill Level of Char. Buffer	20030520
3	CHAR_BUF_REF	Instance attribute	Private	☐	Object reference (TYPE REF TO)	DATA		Reference to Char. Buffer	20030520
4	CONVERSION	Instance attribute	Private	☐	Type reference (TYPE)	ABAP_ENCOD	'DEFAULT'	Konversion nach UTF8	20030506
5	DS	Instance attribute	Private	☐	Type reference (TYPE)	%_C_POINTER		Decompress Handle	20030506
6	FIRST	Constant	Public	☐	Type reference (TYPE)	I	0	First Part of Stream	20030506
7	LAST	Constant	Public	☐	Type reference (TYPE)	I	2	Last Part of Stream	20030506
8	MOJIBAKE	Instance attribute	Private	☐	Type reference (TYPE)	XSTRING			20030520
9	MOJIBAKE_FILL	Instance attribute	Private	☐	Type reference (TYPE)	I		Fill Level of Mojibake Buffer	20030520
10	MOJIBAKE_REF	Instance attribute	Private	☐	Object reference (TYPE REF TO)	DATA		Reference to Mojibake Buffer	20030520
11	NEXT	Constant	Public	☐	Type reference (TYPE)	I	1	Next Part of Stream	20030506
12	OUTPUT_HANDLER	Instance attribute	Private	☐	Object reference (TYPE REF TO)	IF_ABAP_UNGZIP_TEXT_HANDLER		Ouput Handler Method	20030506
13	OUT_BUF	Instance attribute	Private	☐	Object reference (TYPE REF TO)	DATA		Reference to Output Buffer	20030506
14	OUT_BUF_FILL	Instance attribute	Private	☐	Type reference (TYPE)	I		Fill Level of Output Buffer	20030506
15	OUT_BUF_LEN	Instance attribute	Private	☐	Type reference (TYPE)	I		Length of Output Buffer	20030506
16	PART	Instance attribute	Private	☐	Type reference (TYPE)	I	0	Segment	20030506

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	CONSTRUCTOR	Instance method	Public	Constructor	Constructor	20030506
2	DECOMPRESS_TEXT_STREAM	Instance method	Public	Method	Decompress Input	20030506
3	DECOMPRESS_TEXT_STREAM_END	Instance method	Public	Method	End of Decompresson	20030506
4	SET_OUT_BUF	Instance method	Public	Method	Retrieve Output Buffer	20030506
5	_CLOSE_DS_HANDLER	Instance method	Private	Method	Kernel Method: Close Decompress Handle	20030506
6	_DECOMPRESS_TEXT_STREAM	Instance method	Private	Method	Kernel Method for Decompression	20030506
7	_SET_DS_HANDLER	Instance method	Private	Method	Kernel Method: Create Decompress Handle	20030506

Events

Class CL_ABAP_UNGZIP_TEXT_STREAM has no event.

Types

Class CL_ABAP_UNGZIP_TEXT_STREAM has no local type.

Method Signatures

Method CONSTRUCTOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	CONVERSION	Call by reference	☐	Type reference (TYPE)	ABAP_ENCOD	'DEFAULT'	Konvertierung nach UTF8	20030506
2	Importing	OUTPUT_HANDLER	Call by reference	☐	Object reference (TYPE REF TO)	IF_ABAP_UNGZIP_TEXT_HANDLER		Callback-Methode zur Beh. des Ausgabe-Puffers	20030506

#	Exception	Resumable	Description	Created on
1	CX_PARAMETER_INVALID_RANGE	☐	Parameter mit ungültigem Wertebereich	20030506

Method DECOMPRESS_TEXT_STREAM Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	GZIP_IN	Call by reference	☐	Type reference (TYPE)	XSEQUENCE		kompr. Eingabe	20030506
2	Importing	GZIP_IN_LEN	Call by reference	☐	Type reference (TYPE)	I	-1	Länge der kompr. Eingabe	20030506

#	Exception	Resumable	Description	Created on
1	CX_PARAMETER_INVALID_RANGE	☐	Parameter mit ungültigem Wertebereich	20030506
2	CX_SY_COMPRESSION_ERROR	☐	System-Exception: compression error	20030612
3	CX_SY_CONVERSION_CODEPAGE	☐	System-Exception bei Zeichensatzkonvertierung	20030506

Method DECOMPRESS_TEXT_STREAM_END Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	GZIP_IN	Call by reference	☐	Type reference (TYPE)	XSEQUENCE		kompr. Eingabe	20030528
2	Importing	GZIP_IN_LEN	Call by reference	☐	Type reference (TYPE)	I	-1	Länge der kompr. Eingabe	20030528

#	Exception	Resumable	Description	Created on
1	CX_SY_COMPRESSION_ERROR	☐	System-Exception: compression error	20030612

Method SET_OUT_BUF Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	OUT_BUF	Call by reference	☐	Type reference (TYPE)	CSEQUENCE		Ausgabepuffer	20030506
2	Exporting	OUT_BUF_LEN	Call by reference	☐	Type reference (TYPE)	I		Länge des Ausgabepuffers	20030506

#	Exception	Resumable	Description	Created on
1	CX_PARAMETER_INVALID_RANGE	☐	Parameter mit ungültigem Wertebereich	20030620

Method _CLOSE_DS_HANDLER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	DS_IN	Call by reference	☐	Type reference (TYPE)	%_C_POINTER		Decompress Handle	20030506

Method _CLOSE_DS_HANDLER on class CL_ABAP_UNGZIP_TEXT_STREAM has no exception.

Method _DECOMPRESS_TEXT_STREAM Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	CHAR_BUF	Call by reference	☐	Type reference (TYPE)	CSEQUENCE		Character-Puffer	20030520
2	Exporting	CHAR_BUF_FILL	Call by reference	☐	Type reference (TYPE)	I		Füllstand des Character-Puffers	20030520
3	Importing	CONVERSION	Call by reference	☐	Type reference (TYPE)	ABAP_ENCOD	'DEFAULT'	Konvertierung nach UTF8 (UC)	20030506
4	Importing	DS_IN	Call by reference	☐	Type reference (TYPE)	%_C_POINTER		Decompress Handle	20030506
5	Importing	GZIP_IN	Call by reference	☐	Type reference (TYPE)	XSEQUENCE		Eingabe (kompr. Text)	20030506
6	Importing	GZIP_IN_LEN	Call by reference	☐	Type reference (TYPE)	I	-1	Länge der Eingabe	20030506
7	Exporting	MOJIBAKE	Call by reference	☐	Type reference (TYPE)	XSEQUENCE		Mojibake-Puffer	20030520
8	Exporting	MOJIBAKE_FILL	Call by reference	☐	Type reference (TYPE)	I		Füllstand des Mojibake-Puffers	20030520
9	Importing	STREAM_END	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	' '	Ende der Eingabe	20030528
10	Exporting	TEXT_OUT	Call by reference	☐	Type reference (TYPE)	CSEQUENCE		dekomprimierte Ausgabe	20030506
11	Importing	TEXT_OUT_FILL	Call by reference	☐	Type reference (TYPE)	I		Füllstand der Ausgabe	20030512
12	Exporting	TEXT_OUT_LEN	Call by reference	☐	Type reference (TYPE)	I		Länge der Ausgabe	20030506

#	Exception	Resumable	Description	Created on
1	CX_PARAMETER_INVALID_RANGE	☐	Parameter mit ungültigem Wertebereich	20030506
2	CX_SY_BUFFER_OVERFLOW	☐	System-Exception: Puffer zu kurz	20030506
3	CX_SY_CONVERSION_CODEPAGE	☐	System-Exception bei Zeichensatzkonvertierung	20030506

Method _SET_DS_HANDLER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	DS_OUT	Call by reference	☐	Type reference (TYPE)	%_C_POINTER			20030506

Method _SET_DS_HANDLER on class CL_ABAP_UNGZIP_TEXT_STREAM has no exception.

History

Last changed by/on	SAP	20030604
SAP Release Created in	640