BasicProgressObserver.Task (EASy-Producer Documentation API)

java.lang.Object
- net.ssehub.easy.basics.progress.BasicProgressObserver.Task

All Implemented Interfaces:

ProgressObserver.ISubtask, ProgressObserver.ITask

Enclosing class:

BasicProgressObserver
```
private static class BasicProgressObserver.Task
extends java.lang.Object
implements ProgressObserver.ITask, ProgressObserver.ISubtask
```
Representation of a task, which will be observed by the BasicProgressObserver.IProgressMonitor.

Author:

Holger Eichelberger

Field Summary

Fields
Modifier and Type Field Description

private int current

private int max

private java.lang.String name

Constructor Summary

Constructors
Constructor Description

Task(java.lang.String name)
Sole constructor of this class.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`java.lang.String`	`getName()`	Getter for the name.
`int`	`getRemainder()`	Returns the progress of the current task.
`int`	`setCurrent(int current)`	Sets the current progress of the current task.
`void`	`setMax(int max)`	Setter for the maximum of the task.

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

- Field Detail
  - name
```
private java.lang.String name
```
  - max
```
private int max
```
  - current
```
private int current
```
- Constructor Detail
  - Task
```
public Task(java.lang.String name)
```
    Sole constructor of this class.
    
    Parameters:
    
    name - The name of the task which should be created.
- Method Detail
  - getName
```
public java.lang.String getName()
```
    Getter for the name.
    
    Returns:
    
    The name of this task.
  - setMax
```
public void setMax(int max)
```
    Setter for the maximum of the task.
    
    Parameters:
    
    max - An integer value greater than 0.
  - setCurrent
```
public int setCurrent(int current)
```
    Sets the current progress of the current task.
    
    Parameters:
    
    current - The number of already completed steps.
    
    Returns:
    
    How many steps are still open to fulfill the current task.
    
    See Also:
    
    getRemainder()
  - getRemainder
```
public int getRemainder()
```
    Returns the progress of the current task.
    
    Returns:
    
    How many steps are still open to fulfill the current task.