org.javaswift.joss.instructions

Class SegmentationPlan

java.lang.Object

org.javaswift.joss.instructions.SegmentationPlan

Direct Known Subclasses:

SegmentationPlanBoundedInputStream, SegmentationPlanByteArray, SegmentationPlanFile

public abstract class SegmentationPlan
extends java.lang.Object

The Segmentation plan provides a way to access the underlying data as separate InputStreams for the purpose of uploading in several segments.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.Long	currentSegment
protected java.lang.Long	segmentationSize

Constructor Summary

Constructors

Constructor and Description
SegmentationPlan(java.lang.Long segmentationSize)

Method Summary

Modifier and Type	Method and Description
abstract void	close() Closes the underlying File, if appropriate
protected abstract java.io.InputStream	createSegment() Creates an InputStream from the current segment
protected boolean	done() Checks whether all segments have been done
protected abstract java.lang.Long	getFileLength() Returns the file length of the object
java.io.InputStream	getNextSegment()
java.lang.Long	getSegmentNumber()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

segmentationSize

protected java.lang.Long segmentationSize

currentSegment

protected java.lang.Long currentSegment

Constructor Detail

SegmentationPlan

public SegmentationPlan(java.lang.Long segmentationSize)

Method Detail

getSegmentNumber

public java.lang.Long getSegmentNumber()

getNextSegment

public java.io.InputStream getNextSegment()
                                   throws java.io.IOException

Throws:

java.io.IOException

done

protected boolean done()

Checks whether all segments have been done

Returns:

true if the segment can be read

getFileLength

protected abstract java.lang.Long getFileLength()

Returns the file length of the object

Returns:

file length of the object

createSegment

protected abstract java.io.InputStream createSegment()
                                              throws java.io.IOException

Creates an InputStream from the current segment

Returns:

the inputstream

Throws:

java.io.IOException - thrown if error occurs

close

public abstract void close()
                    throws java.io.IOException

Closes the underlying File, if appropriate

Throws:

java.io.IOException - thrown if error occurs