Package io.tus.java.client
Class TusUpload
- java.lang.Object
-
- io.tus.java.client.TusUpload
-
public class TusUpload extends java.lang.Object
This class contains information about a file which will be uploaded later. Uploading is not done using this class but usingTusUploader
whose instances are returned byTusClient.createUpload(TusUpload)
,TusClient.createUpload(TusUpload)
andTusClient.resumeOrCreateUpload(TusUpload)
.
-
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.String
getEncodedMetadata()
Encode the metadata into a string according to the specification, so it can be used as the value for the Upload-Metadata header.java.lang.String
getFingerprint()
java.io.InputStream
getInputStream()
java.util.Map<java.lang.String,java.lang.String>
getMetadata()
long
getSize()
void
setFingerprint(java.lang.String fingerprint)
void
setInputStream(java.io.InputStream inputStream)
Set the source from which will be read if the file will be later uploaded.void
setMetadata(java.util.Map<java.lang.String,java.lang.String> metadata)
void
setSize(long size)
Set the file's size in bytes.
-
-
-
Constructor Detail
-
TusUpload
public TusUpload()
Create a new TusUpload object.
-
TusUpload
public TusUpload(@NotNull java.io.File file) throws java.io.FileNotFoundException
Create a new TusUpload object using the supplied File object. The correspondingInputStream
, size and fingerprint will be automatically set.- Parameters:
file
- The file whose content should be later uploaded.- Throws:
java.io.FileNotFoundException
- Thrown if the file cannot be found.
-
-
Method Detail
-
getSize
public long getSize()
-
setSize
public void setSize(long size)
Set the file's size in bytes.- Parameters:
size
- File's size in bytes.
-
getFingerprint
public java.lang.String getFingerprint()
-
setFingerprint
public void setFingerprint(java.lang.String fingerprint)
-
getInputStream
public java.io.InputStream getInputStream()
-
setInputStream
public void setInputStream(java.io.InputStream inputStream)
Set the source from which will be read if the file will be later uploaded.- Parameters:
inputStream
- The stream which will be read.
-
setMetadata
public void setMetadata(java.util.Map<java.lang.String,java.lang.String> metadata)
-
getMetadata
public java.util.Map<java.lang.String,java.lang.String> getMetadata()
-
getEncodedMetadata
public java.lang.String getEncodedMetadata()
Encode the metadata into a string according to the specification, so it can be used as the value for the Upload-Metadata header.- Returns:
- Encoded metadata
-
-