SAP ABAP Class CL_ABAP_GZIP_TEXT_STREAM (Class for Text Compression (GZIP, 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_GZIP_TEXT_STREAM
Short Description	Class for Text Compression (GZIP, 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	20030425	SAP
Last change	00000000	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_GZIP_TEXT_STREAM has no interface implemented.

Friends

Class CL_ABAP_GZIP_TEXT_STREAM has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	CONVERSION	Instance attribute	Private	☐	Type reference (TYPE)	ABAP_ENCOD	'DEFAULT'	Conversion to UTF8 (UC)	20030425
2	CS	Instance attribute	Private	☐	Type reference (TYPE)	%_C_POINTER		Compress Handle	20030502
3	FIRST	Constant	Public	☐	Type reference (TYPE)	I	0	First Part of Stream	20030425
4	LAST	Constant	Public	☐	Type reference (TYPE)	I	2	Last Part of Stream	20030425
5	NEXT	Constant	Public	☐	Type reference (TYPE)	I	1	Next Part of Stream	20030425
6	OUTPUT_HANDLER	Instance attribute	Private	☐	Object reference (TYPE REF TO)	IF_ABAP_GZIP_TEXT_HANDLER		Ouput Handler Method	20030425
7	OUT_BUF	Instance attribute	Private	☐	Object reference (TYPE REF TO)	DATA		Reference to Output Buffer	20030425
8	OUT_BUF_FILL	Instance attribute	Private	☐	Type reference (TYPE)	I		Fill Level of Output Buffer	20030505
9	OUT_BUF_LEN	Instance attribute	Private	☐	Type reference (TYPE)	I		Length of Output Buffer	20030425
10	PART	Instance attribute	Private	☐	Type reference (TYPE)	I	0	Segment	20030425

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	COMPRESS_TEXT_STREAM	Instance method	Public	Method	Compress Input	20030502
2	COMPRESS_TEXT_STREAM_END	Instance method	Public	Method	End of Compression	20030502
3	CONSTRUCTOR	Instance method	Public	Constructor	Constructor	20030425
4	SET_OUT_BUF	Instance method	Public	Method	Retrieve Output Buffer	20030425
5	_CLOSE_CS_HANDLER	Instance method	Private	Method	Kernel Method: Close Compress Handle	20030505
6	_COMPRESS_TEXT_STREAM	Instance method	Private	Method	Kernel Method for Compression	20030502
7	_SET_CS_HANDLER	Instance method	Private	Method	Kernel Method: Create Compress Handle	20030502

Events

Class CL_ABAP_GZIP_TEXT_STREAM has no event.

Types

Class CL_ABAP_GZIP_TEXT_STREAM has no local type.

Method Signatures

Method COMPRESS_TEXT_STREAM Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	TEXT_IN	Call by reference	☐	Type reference (TYPE)	CSEQUENCE		Eingabe	20030502
2	Importing	TEXT_IN_LEN	Call by reference	☐	Type reference (TYPE)	I	-1	Länge der Eingabe	20030502

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

Method COMPRESS_TEXT_STREAM_END Signature

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

#	Exception	Resumable	Description	Created on
1	CX_SY_COMPRESSION_ERROR	☐	System-Exception bei GZIP	20030515

Method CONSTRUCTOR Signature

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

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

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)	XSEQUENCE		Ausgabepuffer	20030425
2	Exporting	OUT_BUF_LEN	Call by reference	☐	Type reference (TYPE)	I		Länge des Ausgabepuffers	20030425

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

Method _CLOSE_CS_HANDLER Signature

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

#	Exception	Resumable	Description	Created on
1	CX_SY_COMPRESSION_ERROR	☐	System-Exception: Puffer zu kurz	20030515

Method _COMPRESS_TEXT_STREAM 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 (UC)	20030502
2	Importing	CS_IN	Call by reference	☐	Type reference (TYPE)	%_C_POINTER		Compress Handle	20030502
3	Exporting	GZIP_OUT	Call by reference	☐	Type reference (TYPE)	XSEQUENCE		komprimierte Ausgabe	20030502
4	Importing	GZIP_OUT_FILL	Call by reference	☐	Type reference (TYPE)	I		Füllstand der Ausgabe	20030507
5	Exporting	GZIP_OUT_LEN	Call by reference	☐	Type reference (TYPE)	I		Länge der Ausgabe	20030502
6	Importing	STREAM_END	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	' '	Ende der Eingabe	20030528
7	Importing	TEXT_IN	Call by reference	☐	Type reference (TYPE)	CSEQUENCE		Eingabetext	20030502
8	Importing	TEXT_IN_LEN	Call by reference	☐	Type reference (TYPE)	I	-1	Länge der Eingabe	20030502

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

Method _SET_CS_HANDLER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	COMPRESS_LEVEL	Call by reference	☐	Type reference (TYPE)	I	6		20030502
2	Exporting	CS_OUT	Call by reference	☐	Type reference (TYPE)	%_C_POINTER			20030502

Method _SET_CS_HANDLER on class CL_ABAP_GZIP_TEXT_STREAM has no exception.

History

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