com.ibm.carma.model
Class FileReturn

java.lang.Object
  extended by java.io.InputStream
      extended by java.io.FilterInputStream
          extended by com.ibm.carma.model.FileReturn
All Implemented Interfaces:
CARMAReturn, java.io.Closeable

public class FileReturn
extends java.io.FilterInputStream
implements CARMAReturn

File contents stream returned from CARMA including the custom return values for the extract method as specified in the host configuration.

Since:
7.0

Constructor Summary
FileReturn(java.io.InputStream inputStream, CARMAReturn carmaReturn)
          Wraps an input stream to the data returned from CARMA during an extract as well as the extract custom return values.
FileReturn(java.io.InputStream inputStream, org.eclipse.emf.common.util.EMap returnValues)
          Wraps an input stream to the data returned from CARMA during an extract as well as the extract custom return values.
 
Method Summary
 org.eclipse.emf.common.util.EMap getReturnValues()
          Returns the value of the 'Return Values' map.
 
Methods inherited from class java.io.FilterInputStream
available, close, mark, markSupported, read, read, read, reset, skip
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

FileReturn

public FileReturn(java.io.InputStream inputStream,
                  org.eclipse.emf.common.util.EMap returnValues)
Wraps an input stream to the data returned from CARMA during an extract as well as the extract custom return values.

Parameters:
inputStream - stream of member data retrieved from CARMA extract
returnValues - the custom return values which are returned from the RAM during extract. The key is of type ReturnValue, and the value is of type Object.

FileReturn

public FileReturn(java.io.InputStream inputStream,
                  CARMAReturn carmaReturn)
Wraps an input stream to the data returned from CARMA during an extract as well as the extract custom return values.

Parameters:
inputStream - stream of member data retrieved from CARMA extract
carmaReturn - the return response from the CARMA file operation
Method Detail

getReturnValues

public org.eclipse.emf.common.util.EMap getReturnValues()
Returns the value of the 'Return Values' map. The key is of type ReturnValue, and the value is of type Object. Key-value pairs returned from an executed customized CARMA extract

Specified by:
getReturnValues in interface CARMAReturn
Returns:
the value of the 'Return Values' map.
See Also:
ModelPackage.getCARMAReturn_ReturnValues()