Aller au contenu principal
Version: Next

DateHelper

parse

LocalDate DateHelper.parse(Object value)

Description

Permet de convertir un objet vers une date.

Type objetRetour date
LocalDateLe même objet date
Variable de type Date.value de la variable Date
autrenull

Paramètres

  • value l'objet que l'on souhaite convertir en date

Retour

Une valeur date correspondante à la valeur de l'objet en entrée value ou null.

Exemples
// VARIABLE_DATE = 2023-08-28
DateHelper.parse(VARIABLE_DATE.value) // = 2023-08-28
DateHelper.parse(VARIABLE_DATE) // = 2023-08-28
DateHelper.parse("2023-08-28") // = 2023-08-28
DateHelper.parse(123) // = null

today

LocalDate DateHelper.today()

Description

Retourne la date du jour.

Paramètres

Ne prend aucun paramètre en entrée.

Retour

Retourne une valeur date correspondante à la date du jour.

Exemples
DateHelper.today() // = 2024-05-31

of

LocalDate DateHelper.of(int year, int month, int day)

Description

Permet de construire une date à partir d'un jour, d'un mois et d'une année.

Paramètres

  • year un entier représentant l'année
  • month un entier entre 1 et 12 représentant le mois
  • day un entier entre 1 et 31 représentant le jour

Retour

Retourne une valeur date correspondante aux paramètres d'entrée.

Exemples
DateHelper.of(1989, 11, 4) // = 1989-11-04

extract

Integer DateHelper.extract(LocalDate date, String unit)

Description

Permet d'extraire un élement de la date (l'année, le mois ou le jour).

Paramètres

  • date une date
  • unit un caractère parmi (y, m, d) correspondants à (année, mois, jour) respectivement.

Retour

Retourne l'entier correspondant à l'élément demandé. Si le paramètre date est null ou bien le paramètre unit inconnu, alors la valeur 0 est retournée.

Exemples
DateHelper.extract(DateHelper.of(1989, 11, 4), "y") // = 1989
DateHelper.extract(DateHelper.of(1989, 11, 4), "d") // = 4
DateHelper.extract(VARIABLE_DATE.value, "x") // = null

shift

LocalDate DateHelper.shift(LocalDate date, int increment, String unit)

Description

Permet d'incrémenter ou décrémenter un élément de la date.

Paramètres

  • date une date
  • increment nombre d'unités. Valeur positive pour incrémenter, négative pour décrémenter.
  • unit un caractère parmi (y, m, d) correspondants à (année, mois, jour) respectivement.

Retour

Retourne une date correspondant au paramètre date auquel l'incrément (négatif ou positif) a été appliqué. Si le paramètre date est null ou bien le paramètre unit inconnu, alors le retour est null.

Exemples
DateHelper.shift(DateHelper.of(1989, 11, 4), 1, "y") // = 1990-11-04
DateHelper.shift(DateHelper.of(1989, 11, 4), -3, "d") // = 1989-11-01
DateHelper.shift(DateHelper.of(1989, 11, 4), 12, "x") // = null

min

LocalDate DateHelper.min(List<VariableDate> list)
LocalDate DateHelper.min(Object... list)

Description

Permet de retourner la date minimum (la plus ancienne) parmi une liste de dates.

Deux signatures possibles :

  • appliquer min sur les instances d'une variable multiple de type Date.
  • appliquer min sur une liste d'objets convertibles vers une date (grâce à la fonction parse)

Paramètres

  • list une variable multiple de type Date ou bien une liste d'objets convertibles vers une date séparés par des virgules.

Retour

La date minimum parmi les instances de la variable multiple de type Date ou bien la liste des objets convertibles vers une date.

Exemples
// VARIABLES_DATES_NAISSANCE = [1989-11-04, 1992-07-11]
DateHelper.min(VARIABLE_DATES_NAISSANCE) // = 1989-11-04
DateHelper.min(DateHelper.today(), DateHelper.of(2023, 7, 6)) // = 2023-07-06

max

LocalDate DateHelper.max(List<VariableDate> list)
LocalDate DateHelper.max(Object... list)

Description

Permet de retourner la date maximum (la plus récente) parmi une liste de dates.

Deux signatures possibles :

  • appliquer max sur les instances d'une variable multiple de type Date.
  • appliquer max sur une liste d'objets convertibles vers une date (grâce à la fonction parse)

Paramètres

  • list une variable multiple de type Date ou bien une liste d'objets convertibles vers une date séparés par des virgules.

Retour

La date maximum parmi les instances de la variable multiple de type Date ou bien la liste des objets convertibles vers une date.

Exemples
// VARIABLES_DATES_NAISSANCE = [1989-11-04, 1992-07-11]
DateHelper.max(VARIABLE_DATES_NAISSANCE) // = 1992-07-11
DateHelper.max(DateHelper.today(), DateHelper.of(9999, 3, 14)) // = 9999-03-14, on a de la marge encore :)

period

Long DateHelper.period(LocalDate date, String unit)
Long DateHelper.period(LocalDate date, LocalDate referenceDate, String unit)

Description

Permet de calculer la période, exprimée en jours, mois ou années, qui sépare deux dates.

Deux signatures possibles :

  • Calculer la période qui sépare la date passée en paramètre à la date du jour
  • Calculer la période qui sépare les deux dates passées en paramètre

Paramètres

  • date la première date pour calcul de la période
  • referenceDate optionnel, la deuxième date pour calcul de la période. Si non renseigné, la date du jour est utilisée
  • unit un caractère parmi (y, m, d) correspondants à (année, mois, jour) respectivement.

Retour

Un entier représentant la période (en jours, mois ou années en fonction du paramètre unit) qui sépare les deux dates.

Exemples
DateHelper.period(DateHelper.of(2023, 7, 6), "d") // = 330
DateHelper.period(DateHelper.of(1989, 11, 4), DateHelper.of(1992, 7, 11), "m") // = 32