com.dnanexus

Class DXFile.Builder

java.lang.Object

com.dnanexus.DXDataObject.Builder<DXFile.Builder,DXFile>

com.dnanexus.DXFile.Builder

Enclosing class:

DXFile

public static class DXFile.Builder
extends DXDataObject.Builder<DXFile.Builder,DXFile>

Builder class for creating a new DXFile object. To obtain an instance, call DXFile.newFile().

Field Summary

Fields inherited from class com.dnanexus.DXDataObject.Builder

createParents, details, env, folder, hidden, name, project, properties, tags, types

Method Summary

Modifier and Type	Method and Description
DXFile	build() Creates the file.
protected DXFile.Builder	getThisInstance() Returns the builder object.
DXFile.Builder	setMediaType(String mediaType) Sets the Internet Media Type of the file to be created.
DXFile.Builder	upload(byte[] data) Uploads the data in the specified byte array to the file to be created.
DXFile.Builder	upload(InputStream data) Uploads the data in the specified stream to the file to be created.

Methods inherited from class com.dnanexus.DXDataObject.Builder

addTags, addTypes, checkAndFixParameters, getNewObjectId, putAllProperties, putProperty, setDetails, setFolder, setFolder, setName, setProject, setVisibility

Methods inherited from class java.lang.Object

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

Method Detail

build

public DXFile build()

Creates the file.

Specified by:

build in class DXDataObject.Builder<DXFile.Builder,DXFile>

Returns:

a DXFile object corresponding to the newly created object

getThisInstance

protected DXFile.Builder getThisInstance()

Description copied from class: DXDataObject.Builder

Returns the builder object.

This abstract method is implemented by the Builder methods so that common methods can get an instance of the subclass for chaining purposes.

Specified by:

getThisInstance in class DXDataObject.Builder<DXFile.Builder,DXFile>

Returns:

the same object

setMediaType

public DXFile.Builder setMediaType(String mediaType)

Sets the Internet Media Type of the file to be created.

Parameters:

mediaType - Internet Media Type

Returns:

the same Builder object

upload

public DXFile.Builder upload(byte[] data)

Uploads the data in the specified byte array to the file to be created.

Parameters:

data - data to be uploaded

Returns:

the same Builder object

upload

public DXFile.Builder upload(InputStream data)

Uploads the data in the specified stream to the file to be created.

Parameters:

data - stream containing data to be uploaded

Returns:

the same Builder object