Argument (DAISY Pipeline 2 :: Java Client Library 4.3.0 API)

java.lang.Object
- org.daisy.pipeline.client.models.Argument

```
public class Argument
extends Object
```
An argument of type "string"

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Argument.Kind

static class Argument.Output

Nested Classes
Modifier and Type	Class and Description
`static class`	`Argument.Kind`
`static class`	`Argument.Output`

Constructor Summary

Constructors
Constructor and Description

Argument(Node argumentNode)
Create option instance from option node.

Constructors
Constructor and Description
`Argument(Node argumentNode)` Create option instance from option node.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`add(Boolean value)` Add to the list of values the provided Boolean value.
`void`	`add(Double value)` Add to the list of values the provided Double value.
`void`	`add(File file, JobStorage context)` Add to the list of values the provided File value.
`void`	`add(Integer value)` Add to the list of values the provided Integer value.
`void`	`add(Long value)` Add to the list of values the provided Long value.
`void`	`add(String value)` Add to the list of values the provided String value.
`void`	`addAll(Collection<String> values)` Add to the list of values all the provided String values.
`void`	`clear()` Clear the given option or input.
`String`	`get()` Get the value as a String.
`Boolean`	`getAsBoolean()` Get the value as a Boolean.
`Double`	`getAsDouble()` Get the value as a Double.
`File`	`getAsFile(JobStorage context)` Get the value as a File.
`List<File>`	`getAsFileList(JobStorage context)` Get all the values as a List of Files.
`Integer`	`getAsInteger()` Get the value as a Integer.
`List<String>`	`getAsList()` Get all the values as a List of Strings.
`Long`	`getAsLong()` Get the value as a Long.
`String`	`getDataType()`
`String`	`getDefaultValue()` Get the default value as a String.
`Boolean`	`getDefaultValueAsBoolean()` Get the default value as a Boolean.
`Double`	`getDefaultValueAsDouble()` Get the default value as a Double.
`File`	`getDefaultValueAsFile(JobStorage context)` Get the default value as a File.
`Integer`	`getDefaultValueAsInteger()` Get the default value as a Integer.
`Long`	`getDefaultValueAsLong()` Get the default value as a Long.
`String`	`getDesc()`
`Argument.Kind`	`getKind()`
`List<String>`	`getMediaTypes()`
`String`	`getName()`
`String`	`getNicename()`
`Boolean`	`getOrdered()`
`Argument.Output`	`getOutput()`
`Boolean`	`getRequired()`
`Boolean`	`getSequence()`
`String`	`getType()`
`boolean`	`isDefined()` Unset the given option or input.
`void`	`moveTo(int from, int to)` Move a value from one position in the value list to another.
`void`	`remove(Boolean value)` Remove all occurences of the provided Boolean value from the list of values.
`void`	`remove(Double value)` Remove all occurences of the provided Double value from the list of values.
`void`	`remove(File file, JobStorage context)` Remove all occurences of the provided File value from the list of values.
`void`	`remove(Integer value)` Remove all occurences of the provided Integer value from the list of values.
`void`	`remove(Long value)` Remove all occurences of the provided Long value from the list of values.
`void`	`remove(String value)` Remove all occurences of the provided String value from the list of values.
`void`	`removeAll(Collection<String> values)` Remove the first occurences of all the provided String values from the list of values.
`void`	`set(Boolean value)` Replace the value with the provided Boolean value.
`void`	`set(Double value)` Replace the value with the provided Double value.
`void`	`set(File file, JobStorage context)` Replace the value with the provided File value.
`void`	`set(int position, Boolean value)` Replace the value at the given position with the provided Boolean value.
`void`	`set(int position, Double value)` Replace the value at the given position with the provided Double value.
`void`	`set(Integer value)` Replace the value with the provided Integer value.
`void`	`set(int position, File file, JobStorage context)` Replace the value at the given position with the provided File value.
`void`	`set(int position, Integer value)` Replace the value at the given position with the provided Integer value.
`void`	`set(int position, Long value)` Replace the value at the given position with the provided Long value.
`void`	`set(int position, String value)` Replace the value at the given position with the provided String value.
`void`	`set(Long value)` Replace the value with the provided Long value.
`void`	`set(String value)` Replace the value with the provided String value.
`void`	`setAll(Collection<String> values)` Replace the values with all the provided String values.
`void`	`setDataType(String dataType)`
`void`	`setDesc(String desc)`
`void`	`setKind(Argument.Kind kind)`
`void`	`setMediaTypes(List<String> mediaTypes)`
`void`	`setName(String name)`
`void`	`setNicename(String nicename)`
`void`	`setOrdered(Boolean ordered)`
`void`	`setOutput(Argument.Output output)`
`void`	`setRequired(Boolean required)`
`void`	`setSequence(Boolean sequence)`
`void`	`setType(String type)`
`int`	`size()` Returns the number of values defined for the option or input.
`Document`	`toXml()`
`void`	`unset()` Unset the given option or input.

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

- Constructor Detail
  - Argument
```
public Argument(Node argumentNode)
         throws Pipeline2Exception
```
    Create option instance from option node.
    
    Throws:
    
    Pipeline2Exception
- Method Detail
  - size
```
public int size()
```
    Returns the number of values defined for the option or input.
    
    Parameters:
    
    name - the name of the option or input
    
    Returns:
    
    number of values
  - unset
```
public void unset()
```
    Unset the given option or input. This is different from clearing the option in that it will no longer be defined. An option that is cleared but not unset is submitted as an empty list of values to the Web API. An option that is unset are not submitted to the Web API, which leaves the Web API or the Pipeline 2 script free to use a default value.
  - isDefined
```
public boolean isDefined()
```
    Unset the given option or input. This is different from clearing the option in that it will no longer be defined. An option that is cleared but not unset is submitted as an empty list of values to the Web API. An option that is unset are not submitted to the Web API, which leaves the Web API or the Pipeline 2 script free to use a default value.
    
    Returns:
    
    True if the argument is defined/set. False otherwise.
  - clear
```
public void clear()
```
    Clear the given option or input. This is different from unsetting the option in that it will still be defined. An option that is cleared but not unset is submitted as an empty list of values to the Web API. An option that is unset are not submitted to the Web API, which leaves the Web API or the Pipeline 2 script free to use a default value.
  - set
```
public void set(int position,
                Integer value)
```
    Replace the value at the given position with the provided Integer value.
    
    Parameters:
    
    position -
    
    value - the value to use
  - set
```
public void set(int position,
                Long value)
```
    Replace the value at the given position with the provided Long value.
    
    Parameters:
    
    position -
    
    value - the value to use
  - set
```
public void set(int position,
                Double value)
```
    Replace the value at the given position with the provided Double value.
    
    Parameters:
    
    position -
    
    value - the value to use
  - set
```
public void set(int position,
                Boolean value)
```
    Replace the value at the given position with the provided Boolean value.
    
    Parameters:
    
    position -
    
    value - the value to use
  - set
```
public void set(int position,
                File file,
                JobStorage context)
```
    Replace the value at the given position with the provided File value.
    
    Parameters:
    
    position -
    
    file - the value to use
  - set
```
public void set(int position,
                String value)
```
    Replace the value at the given position with the provided String value.
    
    Parameters:
    
    position -
    
    value - the value to use
  - set
```
public void set(Integer value)
```
    Replace the value with the provided Integer value.
    
    Parameters:
    
    value - the value to use
  - set
```
public void set(Long value)
```
    Replace the value with the provided Long value.
    
    Parameters:
    
    value - the value to use
  - set
```
public void set(Double value)
```
    Replace the value with the provided Double value.
    
    Parameters:
    
    value - the value to use
  - set
```
public void set(Boolean value)
```
    Replace the value with the provided Boolean value.
    
    Parameters:
    
    value - the value to use
  - set
```
public void set(File file,
                JobStorage context)
```
    Replace the value with the provided File value.
    
    Parameters:
    
    file - the value to use
  - set
```
public void set(String value)
```
    Replace the value with the provided String value.
    
    Parameters:
    
    value - the value to use
  - setAll
```
public void setAll(Collection<String> values)
```
    Replace the values with all the provided String values.
    
    Parameters:
    
    values - the value to use
  - add
```
public void add(Integer value)
```
    Add to the list of values the provided Integer value.
    
    Parameters:
    
    value - the value to use
  - add
```
public void add(Long value)
```
    Add to the list of values the provided Long value.
    
    Parameters:
    
    value - the value to use
  - add
```
public void add(Double value)
```
    Add to the list of values the provided Double value.
    
    Parameters:
    
    value - the value to use
  - add
```
public void add(Boolean value)
```
    Add to the list of values the provided Boolean value.
    
    Parameters:
    
    value - the value to use
  - add
```
public void add(File file,
                JobStorage context)
```
    Add to the list of values the provided File value.
    
    Parameters:
    
    file - the value to use
  - add
```
public void add(String value)
```
    Add to the list of values the provided String value.
    
    Parameters:
    
    value - the value to use
  - addAll
```
public void addAll(Collection<String> values)
```
    Add to the list of values all the provided String values.
    
    Parameters:
    
    values - the value to use
  - remove
```
public void remove(Integer value)
```
    Remove all occurences of the provided Integer value from the list of values.
    
    Parameters:
    
    value - the value to use
  - remove
```
public void remove(Long value)
```
    Remove all occurences of the provided Long value from the list of values.
    
    Parameters:
    
    value - the value to use
  - remove
```
public void remove(Double value)
```
    Remove all occurences of the provided Double value from the list of values.
    
    Parameters:
    
    value - the value to use
  - remove
```
public void remove(Boolean value)
```
    Remove all occurences of the provided Boolean value from the list of values.
    
    Parameters:
    
    value - the value to use
  - remove
```
public void remove(File file,
                   JobStorage context)
```
    Remove all occurences of the provided File value from the list of values.
    
    Parameters:
    
    file - the value to use
  - remove
```
public void remove(String value)
```
    Remove all occurences of the provided String value from the list of values.
    
    Parameters:
    
    value - the value to use
  - removeAll
```
public void removeAll(Collection<String> values)
```
    Remove the first occurences of all the provided String values from the list of values.
    
    Parameters:
    
    values - the value to use
  - getAsInteger
```
public Integer getAsInteger()
```
    Get the value as a Integer. Returns the first value if there are more than one. Returns null if the value cannot be parsed as a Integer, or if the value is not set. If the option or input is a sequence, you should use getAsIntegerList to get all values instead.
    
    Returns:
    
    the value as a Integer
  - getAsLong
```
public Long getAsLong()
```
    Get the value as a Long. Returns the first value if there are more than one. Returns null if the value cannot be parsed as a Long, or if the value is not set.
    
    Returns:
    
    the value as a Long
  - getAsDouble
```
public Double getAsDouble()
```
    Get the value as a Double. Returns the first value if there are more than one. Returns null if the value cannot be parsed as a Double, or if the value is not set. If the option or input is a sequence, you should use getAsDoubleList to get all values instead.
    
    Returns:
    
    the value as a Double
  - getAsBoolean
```
public Boolean getAsBoolean()
```
    Get the value as a Boolean. Returns the first value if there are more than one. Returns null if the value cannot be parsed as a Boolean, or if the value is not set. If the option or input is a sequence, you should use getAsBooleanList to get all values instead.
    
    Returns:
    
    the value as a Boolean
  - getAsFile
```
public File getAsFile(JobStorage context)
```
    Get the value as a File. Returns the first value if there are more than one. Returns null if the value cannot be parsed as a File, or if the value is not set.
    
    Returns:
    
    the value as a File
  - get
```
public String get()
```
    Get the value as a String. Returns the first value if there are more than one. Returns null if the value is not set. If the option or input is a sequence, you should use getAsList to get all values instead.
    
    Returns:
    
    the value as a String
  - getAsList
```
public List<String> getAsList()
```
    Get all the values as a List of Strings.
    
    Returns:
    
    null if the value is not set.
  - getAsFileList
```
public List<File> getAsFileList(JobStorage context)
```
    Get all the values as a List of Files.
    
    Returns:
    
    null if any of the values cannot be parsed as a File, or if the value is not set.
  - moveTo
```
public void moveTo(int from,
                   int to)
```
    Move a value from one position in the value list to another.
    
    Parameters:
    
    from - which value to move
    
    to - which position to move the value
  - getDefaultValueAsInteger
```
public Integer getDefaultValueAsInteger()
```
    Get the default value as a Integer. Returns null if the value cannot be parsed as a Integer, or if the value is not set.
    
    Returns:
    
    the default value as a Integer
  - getDefaultValueAsLong
```
public Long getDefaultValueAsLong()
```
    Get the default value as a Long. Returns null if the value cannot be parsed as a Long, or if the value is not set.
    
    Returns:
    
    the default value as a Long
  - getDefaultValueAsDouble
```
public Double getDefaultValueAsDouble()
```
    Get the default value as a Double. Returns null if the value cannot be parsed as a Double, or if the value is not set.
    
    Returns:
    
    the default value as a Double
  - getDefaultValueAsBoolean
```
public Boolean getDefaultValueAsBoolean()
```
    Get the default value as a Boolean. Returns null if the value cannot be parsed as a Boolean, or if the value is not set.
    
    Returns:
    
    the default value as a Boolean
  - getDefaultValueAsFile
```
public File getDefaultValueAsFile(JobStorage context)
```
    Get the default value as a File. Returns null if the value cannot be parsed as a File, or if the value is not set.
    
    Returns:
    
    the default value as a File
  - getDefaultValue
```
public String getDefaultValue()
```
    Get the default value as a String. Returns null if the value is not set.
    
    Returns:
    
    the default value as a String
  - getName
```
public String getName()
```
  - getNicename
```
public String getNicename()
```
  - getDesc
```
public String getDesc()
```
  - getRequired
```
public Boolean getRequired()
```
  - getSequence
```
public Boolean getSequence()
```
  - getMediaTypes
```
public List<String> getMediaTypes()
```
  - getOutput
```
public Argument.Output getOutput()
```
  - getKind
```
public Argument.Kind getKind()
```
  - getOrdered
```
public Boolean getOrdered()
```
  - getType
```
public String getType()
```
  - getDataType
```
public String getDataType()
```
  - setName
```
public void setName(String name)
```
  - setNicename
```
public void setNicename(String nicename)
```
  - setDesc
```
public void setDesc(String desc)
```
  - setRequired
```
public void setRequired(Boolean required)
```
  - setSequence
```
public void setSequence(Boolean sequence)
```
  - setMediaTypes
```
public void setMediaTypes(List<String> mediaTypes)
```
  - setOutput
```
public void setOutput(Argument.Output output)
```
  - setKind
```
public void setKind(Argument.Kind kind)
```
  - setOrdered
```
public void setOrdered(Boolean ordered)
```
  - setType
```
public void setType(String type)
```
  - setDataType
```
public void setDataType(String dataType)
```
  - toXml
```
public Document toXml()
```

Class Argument

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Argument

Method Detail

size

unset

isDefined

clear

set

set

set

set

set

set

set

set

set

set

set

set

setAll

add

add

add

add

add

add

addAll

remove

remove

remove

remove

remove

remove

removeAll

getAsInteger

getAsLong

getAsDouble

getAsBoolean

getAsFile

get

getAsList

getAsFileList

moveTo

getDefaultValueAsInteger

getDefaultValueAsLong

getDefaultValueAsDouble

getDefaultValueAsBoolean

getDefaultValueAsFile

getDefaultValue

getName

getNicename

getDesc

getRequired

getSequence

getMediaTypes

getOutput

getKind

getOrdered

getType

getDataType

setName

setNicename

setDesc

setRequired

setSequence

setMediaTypes

setOutput

setKind

setOrdered

setType

setDataType

toXml