com.ibm.carma.ui.job
Class GetContentsJob

java.lang.Object
  extended by org.eclipse.core.runtime.PlatformObject
      extended by org.eclipse.core.internal.jobs.InternalJob
          extended by org.eclipse.core.runtime.jobs.Job
              extended by com.ibm.carma.ui.job.AbstractCarmaJob
                  extended by com.ibm.carma.ui.job.GetContentsJob
All Implemented Interfaces:
java.lang.Comparable, org.eclipse.core.runtime.IAdaptable

public class GetContentsJob
extends AbstractCarmaJob

This User job downloads remote member contents into a temporary location on the client. The temporary download is accessible with the getStream() method.

This Class may be instantiated, but is not intended to be sub-classed.

Since:
7.1

Field Summary
 
Fields inherited from class com.ibm.carma.ui.job.AbstractCarmaJob
COPYRIGHT
 
Fields inherited from class org.eclipse.core.runtime.jobs.Job
ASYNC_FINISH, BUILD, DECORATE, INTERACTIVE, LONG, NONE, RUNNING, SHORT, SLEEPING, WAITING
 
Constructor Summary
GetContentsJob(java.lang.String name, CARMAMember member)
           
 
Method Summary
 java.io.InputStream getStream()
          Accesses the content stream for the downloaded CARMA member.
 org.eclipse.core.runtime.IStatus run(org.eclipse.core.runtime.IProgressMonitor monitor)
           
 
Methods inherited from class com.ibm.carma.ui.job.AbstractCarmaJob
displayCustomReturns, displayCustomReturns, displayCustomReturns, displayCustomReturns, getActionFromReturns, getActionName
 
Methods inherited from class org.eclipse.core.runtime.jobs.Job
addJobChangeListener, belongsTo, cancel, done, getJobManager, getName, getPriority, getProperty, getResult, getRule, getState, getThread, isBlocking, isSystem, isUser, join, removeJobChangeListener, schedule, schedule, setName, setPriority, setProgressGroup, setProperty, setRule, setSystem, setThread, setUser, shouldRun, shouldSchedule, sleep, wakeUp, wakeUp
 
Methods inherited from class org.eclipse.core.internal.jobs.InternalJob
compareTo, toString
 
Methods inherited from class org.eclipse.core.runtime.PlatformObject
getAdapter
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface org.eclipse.core.runtime.IAdaptable
getAdapter
 

Constructor Detail

GetContentsJob

public GetContentsJob(java.lang.String name,
                      CARMAMember member)
Parameters:
name - Name of the job
member - the CARMA member to download
Method Detail

run

public org.eclipse.core.runtime.IStatus run(org.eclipse.core.runtime.IProgressMonitor monitor)
Specified by:
run in class org.eclipse.core.runtime.jobs.Job

getStream

public java.io.InputStream getStream()
Accesses the content stream for the downloaded CARMA member. Currently, this method will return null until the file is completely downloaded when the job completes sucessfully.

Returns:
contents stream for the