TimeStep (ISIS-Fish 4.4.0.0-SNAPSHOT API)

java.lang.Object
- fr.ifremer.isisfish.types.TimeStep

All Implemented Interfaces:

Serializable, Cloneable, Comparable<TimeStep>
```
public class TimeStep
extends Object
implements Cloneable, Serializable, Comparable<TimeStep>
```
This object can't be modified. If this behavior is modified pay attention if you used TimeStep as key in Map, in this case you will have error

Author:

poussin

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type Field and Description

protected int step

Fields
Modifier and Type	Field and Description
`protected int`	`step`

Constructor Summary

Constructors
Constructor and Description

TimeStep()

TimeStep(int step)

Constructors
Constructor and Description
`TimeStep()`
`TimeStep(int step)`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`TimeStep`	`add(int number)` Return new TimeStep equals to this.step + number
`boolean`	`after(TimeStep t)` compare 2 dates.
`boolean`	`afterOrEquals(TimeStep d)`
`boolean`	`before(TimeStep t)` compare 2 dates.
`boolean`	`beforeOrEquals(TimeStep t)`
`int`	`compareTo(TimeStep t)`
`boolean`	`equals(Object o)`
`int`	`gap(TimeStep other)` Return number of step between current TimeStep and other TimeStep in argument (this - other)
`int`	`getDate()` Deprecated. since 4.0.0.0, use `getStep()` instead
`Month`	`getMonth()`
`Month[]`	`getMonthBetweenDate(TimeStep timeStep2)`
`int`	`getStep()`
`int`	`getYear()`
`int`	`hashCode()`
`TimeStep`	`minus(int number)` Return new TimeStep equals to this.step - number
`TimeStep`	`next()` Method next retourne une nouvelle date qui est la date suivante de la date courante. la date courante n'est pas modifier.
`TimeStep`	`nextYear()` Method next retourne une nouvelle date qui est le meme mois de l'annee suivante de la date courante. la date courante n'est pas modifier.
`TimeStep`	`previous()` Method preview retourne une nouvelle date qui est la date precedente de la date courante la date courante n'est pas modifier.
`TimeStep`	`previousYear()` Method preview retourne une nouvelle date qui est le meme mois de l'annee precedente de la date courante la date courante n'est pas modifier.
`String`	`toString()`

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

- Field Detail
  - step
```
protected int step
```
- Constructor Detail
  - TimeStep
```
public TimeStep()
```
  - TimeStep
```
public TimeStep(int step)
```
- Method Detail
  - compareTo
```
public int compareTo(TimeStep t)
```
    Specified by:
    
    compareTo in interface Comparable<TimeStep>
  - getYear
```
public int getYear()
```
  - getMonth
```
public Month getMonth()
```
  - getDate
```
@Deprecated
public int getDate()
```
    Deprecated. since 4.0.0.0, use getStep() instead
    
    Returns:
    
    date
  - getStep
```
public int getStep()
```
  - add
```
public TimeStep add(int number)
```
    Return new TimeStep equals to this.step + number
    
    Parameters:
    
    number - number of step to add
    
    Returns:
    
    new TimeStep
  - minus
```
public TimeStep minus(int number)
```
    Return new TimeStep equals to this.step - number
    
    Parameters:
    
    number - number of step to remove
    
    Returns:
    
    new TimeStep
  - gap
```
public int gap(TimeStep other)
```
    Return number of step between current TimeStep and other TimeStep in argument (this - other)
    
    Parameters:
    
    other -
    
    Returns:
  - next
```
public TimeStep next()
```
    Method next retourne une nouvelle date qui est la date suivante de la date courante. la date courante n'est pas modifier.
    
    Returns:
    
    Date
  - previous
```
public TimeStep previous()
```
    Method preview retourne une nouvelle date qui est la date precedente de la date courante la date courante n'est pas modifier.
    
    Returns:
    
    Date
  - nextYear
```
public TimeStep nextYear()
```
    Method next retourne une nouvelle date qui est le meme mois de l'annee suivante de la date courante. la date courante n'est pas modifier.
    
    Returns:
    
    Date
  - previousYear
```
public TimeStep previousYear()
```
    Method preview retourne une nouvelle date qui est le meme mois de l'annee precedente de la date courante la date courante n'est pas modifier.
    
    Returns:
    
    Date
  - before
```
public boolean before(TimeStep t)
```
    compare 2 dates.
    
    Returns:
    
    retourne vrai si t est strictement superieur
  - beforeOrEquals
```
public boolean beforeOrEquals(TimeStep t)
```
  - after
```
public boolean after(TimeStep t)
```
    compare 2 dates.
    
    Returns:
    
    retourne vrai si t est strictement inferieur
  - afterOrEquals
```
public boolean afterOrEquals(TimeStep d)
```
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - getMonthBetweenDate
```
public Month[] getMonthBetweenDate(TimeStep timeStep2)
```
    Parameters:
    
    timeStep2 -
    
    Returns:
    
    month array
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class TimeStep

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

step

Constructor Detail

TimeStep

TimeStep

Method Detail

compareTo

getYear

getMonth

getDate

getStep

add

minus

gap

next

previous

nextYear

previousYear

before

beforeOrEquals

after

afterOrEquals

equals

hashCode

getMonthBetweenDate

toString