OutputParameter (dnanexus-api 0.1.0-SNAPSHOT API)

java.lang.Object
- com.dnanexus.OutputParameter

public class OutputParameter
extends Object

An output parameter for an executable.

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class OutputParameter.Builder
Builder class for creating new output parameters.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`IOClass`	`getIOClass()`	Returns the class of the parameter.
`String`	`getName()`	Returns the name of the parameter.
`boolean`	`isOptional()`	Returns whether the parameter is optional.
`static OutputParameter.Builder`	`newOutputParameter(String name, IOClass parameterClass)`	Returns a new output parameter builder initialized with the specified output name and class.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - newOutputParameter
```
public static OutputParameter.Builder newOutputParameter(String name,
                                                         IOClass parameterClass)
```
    Returns a new output parameter builder initialized with the specified output name and class.
    
    Parameters:
    
    name - name of the output to be created
    
    parameterClass - class of the output to be created
    
    Returns:
    
    an output parameter builder
  - getIOClass
```
public IOClass getIOClass()
```
    Returns the class of the parameter.
    
    Returns:
    
    class name
  - getName
```
public String getName()
```
    Returns the name of the parameter.
    
    Returns:
    
    parameter name
  - isOptional
```
public boolean isOptional()
```
    Returns whether the parameter is optional.
    
    Returns:
    
    true if optional