com.dnanexus

Class DXApplet.Builder

java.lang.Object

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

com.dnanexus.DXApplet.Builder

Enclosing class:

DXApplet

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

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

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
DXApplet	build() Creates the applet.
protected void	checkAndFixParameters() Ensures that the project was either explicitly set or that the environment specifies a workspace, and that the run specification is provided.
protected DXApplet.Builder	getThisInstance() Returns the builder object.
DXApplet.Builder	setDescription(String description) Sets the description of the applet to be created.
DXApplet.Builder	setInputSpecification(List<? extends InputParameter> inputSpec) Sets the input specification of the applet to be created.
DXApplet.Builder	setOutputSpecification(List<? extends OutputParameter> outputSpec) Sets the output specification of the applet to be created.
DXApplet.Builder	setRunSpecification(RunSpecification runSpec) Sets the run specification of the applet to be created.
DXApplet.Builder	setSummary(String summary) Sets the summary of the applet to be created.
DXApplet.Builder	setTitle(String title) Sets the title of the applet to be created.

Methods inherited from class com.dnanexus.DXDataObject.Builder

addTags, addTypes, 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 DXApplet build()

Creates the applet.

Specified by:

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

Returns:

a DXApplet object corresponding to the newly created object

checkAndFixParameters

protected void checkAndFixParameters()

Ensures that the project was either explicitly set or that the environment specifies a workspace, and that the run specification is provided.

Overrides:

checkAndFixParameters in class DXDataObject.Builder<DXApplet.Builder,DXApplet>

getThisInstance

protected DXApplet.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<DXApplet.Builder,DXApplet>

Returns:

the same object

setDescription

public DXApplet.Builder setDescription(String description)

Sets the description of the applet to be created.

Parameters:

description - applet description

Returns:

the same Builder object

setInputSpecification

public DXApplet.Builder setInputSpecification(List<? extends InputParameter> inputSpec)

Sets the input specification of the applet to be created.

Parameters:

inputSpec - input specification

Returns:

the same Builder object

setOutputSpecification

public DXApplet.Builder setOutputSpecification(List<? extends OutputParameter> outputSpec)

Sets the output specification of the applet to be created.

Parameters:

outputSpec - output specification

Returns:

the same Builder object

setRunSpecification

public DXApplet.Builder setRunSpecification(RunSpecification runSpec)

Sets the run specification of the applet to be created.

Parameters:

runSpec - applet run specification

Returns:

the same Builder object

setSummary

public DXApplet.Builder setSummary(String summary)

Sets the summary of the applet to be created.

Parameters:

summary - applet summary

Returns:

the same Builder object

setTitle

public DXApplet.Builder setTitle(String title)

Sets the title of the applet to be created.

Parameters:

title - applet title

Returns:

the same Builder object