Abstract base class of all streams The methods of this class work for both Byte and Character streams. More...

Inheritance diagram for Stream:

[legend]

Collaboration diagram for Stream:

[legend]

Public Member Functions
_.Library.Boolean	Close (_.Library.Status pSC)
	Close the current stream.

_.Library.Integer	CopyFrom (_.IO.I.Stream pSource, _.Library.Numeric pTimeout, _.Library.Boolean pFlush, _.Library.Status pSC)
	Copy all available data from pSource to the current stream buffer. More...

_.Library.Integer	CopyReplace (_.IO.I.Stream pDest, _.Library.Integer pMaxReadLen, _.Library.Numeric pTimeout, _.Library.Numeric pIdleTimeout, _.Library.String pPrevBuf, _.Library.Boolean pFlush, _.Library.Boolean pInsensitive, _.Library.String pRewind, _.Library.Status pSC, pSearchReplace)
	Replace from the current stream the strings contained in a list of alternating search and replace target string arguments. More...

_.Library.Integer	CopyReplaceArray (_.IO.I.Stream pDest, _.Library.Integer pMaxReadLen, _.Library.Numeric pTimeout, _.Library.Numeric pIdleTimeout, _.Library.String pPrevBuf, _.Library.Boolean pFlush, _.Library.Boolean pInsensitive, _.Library.String pRewind, _.Library.Status pSC, pSearchReplace)
	Replace from the current stream the strings contained in an array of alternating search and replace target string values called pSearchReplace. More...

	Flush (_.Library.Status pSC)
	Ensure that any data already written to the stream buffer are actually sent to the stream.

_.Library.Integer	OutputToDevice (_.Library.Integer pLength, _.Library.Numeric pTimeout, _.Library.Status pSC)
	Copy all available data from the current stream to the current system device.

_.Library.String	Read (_.Library.Integer pMaxReadLen, _.Library.Numeric pTimeout, _.Library.Status pSC)
	Read until pMaxReadLen chars are gotten or pTimeout expires. More...

_.Library.String	ReadUntil (_.Library.Integer pMaxReadLen, _.Library.Numeric pTimeout, _.Library.Numeric pIdleTimeout, _.Library.String pPrevBuf, _.Library.Boolean pInsensitive, _.Library.Integer pWhich, _.Library.Status pSC, pTarget)
	Read until one of the Target strings is found or a timeout occurs. More...

_.Library.String	ReadUntilArray (_.Library.Integer pMaxReadLen, _.Library.Numeric pTimeout, _.Library.Numeric pIdleTimeout, _.Library.String pPrevBuf, _.Library.Boolean pInsensitive, _.Library.Integer pWhich, _.Library.Status pSC, pTargets)
	Read until one of the Target strings is found or a timeout occurs. More...

	Write (_.Library.String pData, _.Library.Boolean pFlush, _.Library.Status pSC)
	Write pData to the stream buffer. More...

Public Member Functions inherited from RegisteredObject
_.Library.Status	OnAddToSaveSet (_.Library.Integer depth, _.Library.Integer insert, _.Library.Integer callcount)
	This callback method is invoked when the current object is added to the SaveSet,. More...

_.Library.Status	OnClose ()
	This callback method is invoked by the <METHOD>Close</METHOD> method to. More...

_.Library.Status	OnConstructClone (_.Library.RegisteredObject object, _.Library.Boolean deep, _.Library.String cloned)
	This callback method is invoked by the <METHOD>ConstructClone</METHOD> method to. More...

_.Library.Status	OnNew ()
	This callback method is invoked by the <METHOD>New</METHOD> method to. More...

_.Library.Status	OnValidateObject ()
	This callback method is invoked by the <METHOD>ValidateObject</METHOD> method to. More...

Public Attributes
	AtEnd
	More...

	DefaultFlushOnWrite
	InputStream interface. More...

	IsCharacter
	More...

	IsOpen
	More...

	Name
	More...

Additional Inherited Members
Static Public Attributes inherited from RegisteredObject
	CAPTION = None
	Optional name used by the Form Wizard for a class when generating forms. More...

	JAVATYPE = None
	The Java type to be used when exported.

	PROPERTYVALIDATION = None
	This parameter controls the default validation behavior for the object. More...

Detailed Description

Abstract base class of all streams The methods of this class work for both Byte and Character streams.

Member Function Documentation

◆ CopyFrom()

_.Library.Integer CopyFrom	(	_.IO.I.Stream	pSource,
		_.Library.Numeric	pTimeout,
		_.Library.Boolean	pFlush,
		_.Library.Status	pSC
	)

Copy all available data from pSource to the current stream buffer.

If pFlush is True, ensure that all data are actually sent to the stream.

◆ CopyReplace()

_.Library.Integer CopyReplace	(	_.IO.I.Stream	pDest,
		_.Library.Integer	pMaxReadLen,
		_.Library.Numeric	pTimeout,
		_.Library.Numeric	pIdleTimeout,
		_.Library.String	pPrevBuf,
		_.Library.Boolean	pFlush,
		_.Library.Boolean	pInsensitive,
		_.Library.String	pRewind,
		_.Library.Status	pSC,
			pSearchReplace
	)

Replace from the current stream the strings contained in a list of alternating search and replace target string arguments.

Accepts a destination stream pDest into which the modified result will be written. If not supplied, pDest will be returned containing a newly created GlobalCharacter stream. Reads until a maximum number of characters pMaxReadLen has been read or until a timeout pTimeout has occurred, or until pIdleTimeout seconds have elapsed with no further data read.

Setting pInsensitive=1 means the search strings will match in a case-insensitive way.

If pPrevBuf is provided, it is prepended to any data read, and is included in the attempt to find matching search strings. Replaces from left to right and does not repeat and recurse. This means that once a substring is replaced the replacement result will not be searched or replaced again. Returns the total count of characters written to the destination stream If pRewind contains i the input stream will be rewound before copying If pRewind contains I the input stream will be rewound after copying If pRewind contains o the output stream will be rewound before copying If pRewind contains O the output stream will be rewound after copying If pRewind is 1 both streams will be rewound before and after copying. This is the default. If pRewind is empty or zero neither stream will be rewound before or after copying

◆ CopyReplaceArray()

_.Library.Integer CopyReplaceArray	(	_.IO.I.Stream	pDest,
		_.Library.Integer	pMaxReadLen,
		_.Library.Numeric	pTimeout,
		_.Library.Numeric	pIdleTimeout,
		_.Library.String	pPrevBuf,
		_.Library.Boolean	pFlush,
		_.Library.Boolean	pInsensitive,
		_.Library.String	pRewind,
		_.Library.Status	pSC,
			pSearchReplace
	)

Replace from the current stream the strings contained in an array of alternating search and replace target string values called pSearchReplace.

Accepts a destination stream pDest into which the modified result will be written. If not supplied, pDest will be returned containing a newly created GlobalCharacter stream. Reads until a maximum number of characters pMaxReadLen has been read or until a timeout pTimeout has occurred, or until pIdleTimeout seconds have elapsed with no further data read.

Setting pInsensitive=1 means the search strings will match in a case-insensitive way.

If pPrevBuf is provided, it is prepended to any data read, and is included in the attempt to find matching search strings. Replaces from left to right and does not repeat and recurse. This means that once a substring is replaced the replacement result will not be searched or replaced again. Returns the total count of characters written to the destination stream

◆ Read()

_.Library.String Read	(	_.Library.Integer	pMaxReadLen,
		_.Library.Numeric	pTimeout,
		_.Library.Status	pSC
	)

Read until pMaxReadLen chars are gotten or pTimeout expires.

On return, if pTimeout is unchanged it means the full timeout period expired. If the timeout period expired and the returned string is shorter than pMaxReadLen, then AtEnd will be 1.

Reimplemented in StringStream, NullStream, FileStream, and DeviceStream.

◆ ReadUntil()

_.Library.String ReadUntil	(	_.Library.Integer	pMaxReadLen,
		_.Library.Numeric	pTimeout,
		_.Library.Numeric	pIdleTimeout,
		_.Library.String	pPrevBuf,
		_.Library.Boolean	pInsensitive,
		_.Library.Integer	pWhich,
		_.Library.Status	pSC,
			pTarget
	)

Read until one of the Target strings is found or a timeout occurs.

Return any data read until pTimeout seconds have elapsed, or until pIdleTimeout seconds elapse with no further data read, or up until any of the optional pTarget strings is encountered.

If pTarget strings are provided the pWhich output argument will contain an integer indicating which of them was matched. A value of 0 in pWhich indicates that none was matched and therefore the timeout expired or an error occurred.

Setting pInsensitive=1 means the pTarget strings will match data received in a case-insensitive way against the pTargets strings.

If pPrevBuf is provided, it is prepended to any data read, and is included in the attempt to find a matching target string.

◆ ReadUntilArray()

_.Library.String ReadUntilArray	(	_.Library.Integer	pMaxReadLen,
		_.Library.Numeric	pTimeout,
		_.Library.Numeric	pIdleTimeout,
		_.Library.String	pPrevBuf,
		_.Library.Boolean	pInsensitive,
		_.Library.Integer	pWhich,
		_.Library.Status	pSC,
			pTargets
	)

Read until one of the Target strings is found or a timeout occurs.

Return any data read until pTimeout seconds have elapsed, or until pIdleTimeout seconds elapse with no further data read, or up until any of the optional pTargets strings is encountered.

If pTargets strings are provided the pWhich output argument will contain an integer indicating which of them was matched. A value of 0 in pWhich indicates that none was matched and therefore the timeout expired or an error occurred.

Setting pInsensitive=1 means the pTarget strings will match data received in a case-insensitive way against the pTargets strings.

If pPrevBuf is provided, it is prepended to any data read, and is included in the attempt to find a matching target string.

◆ Write()

Write	(	_.Library.String	pData,
		_.Library.Boolean	pFlush,
		_.Library.Status	pSC
	)

Write pData to the stream buffer.

If pFlush is True, ensure that the data are actually sent to the stream.

Reimplemented in StringStream, NullStream, FileStream, and DeviceStream.

Member Data Documentation

◆ AtEnd

AtEnd

◆ DefaultFlushOnWrite

DefaultFlushOnWrite

InputStream interface.

Does this class flush after writes by default?

◆ IsCharacter

IsCharacter

◆ IsOpen

IsOpen

◆ Name

Name

Public Member Functions

Public Attributes

Additional Inherited Members