Functions: FnPeriod

1. Overview

FnPeriod is a function hub class containing a lot of static methods to convert from various input objects to Period. Those static methods return functions whose output is Period and whose input can be Calendar list, BaseDateTime list, Calendar list and Long list among others.

2. Functions

Function nameTypeParamsDescription
baseDateTimeFieldArrayToPeriodFunction<T[], Period>

It creates a Period represented by the given start and end instants

baseDateTimeFieldArrayToPeriodFunction<T[], Period>Chronology chronology

It creates a Period with the specified Chronology. The input received by the Function must have size 2 and represents the start and end instants of the Period

baseDateTimeFieldArrayToPeriodFunction<T[], Period>PeriodType periodType

It creates a Period with the specified PeriodType. The input received by the Function must have size 2 and represents the start and end instants of the Period

baseDateTimeFieldArrayToPeriodFunction<T[], Period>PeriodType periodType
Chronology chronology

It creates a Period with the specified PeriodType and Chronology. The input received by the Function must have size 2 and represents the start and end instants of the Period

baseDateTimeFieldCollectionToPeriodFunction<Collection<? extends BaseDateTime>, Period>

It creates a Period represented by the given start and end instants

baseDateTimeFieldCollectionToPeriodFunction<Collection<? extends BaseDateTime>, Period>Chronology chronology

It creates a Period with the specified Chronology. The input received by the Function must have size 2 and represents the start and end instants of the Period

baseDateTimeFieldCollectionToPeriodFunction<Collection<? extends BaseDateTime>, Period>PeriodType periodType

It creates a Period with the specified PeriodType. The input received by the Function must have size 2 and represents the start and end instants of the Period

baseDateTimeFieldCollectionToPeriodFunction<Collection<? extends BaseDateTime>, Period>PeriodType periodType
Chronology chronology

It creates a Period with the specified PeriodType and Chronology. The input received by the Function must have size 2 and represents the start and end instants of the Period

calendarFieldArrayToPeriodFunction<T[], Period>

It creates a Period represented by the given start and end instants

calendarFieldArrayToPeriodFunction<T[], Period>Chronology chronology

It creates a Period with the specified Chronology. The input received by the Function must have size 2 and represents the start and end instants of the Period

calendarFieldArrayToPeriodFunction<T[], Period>PeriodType periodType

It creates a Period with the specified PeriodType. The input received by the Function must have size 2 and represents the start and end instants of the Period

calendarFieldArrayToPeriodFunction<T[], Period>PeriodType periodType
Chronology chronology

It creates a Period with the specified PeriodType and Chronology. The input received by the Function must have size 2 and represents the start and end instants of the Period

calendarFieldCollectionToPeriodFunction<Collection<? extends Calendar>, Period>

It creates a Period represented by the given start and end instants. The input received by the Function must have size 2

calendarFieldCollectionToPeriodFunction<Collection<? extends Calendar>, Period>Chronology chronology

It creates a Period with the specified Chronology. The input received by the Function must have size 2 and represents the start and end instants of the Period

calendarFieldCollectionToPeriodFunction<Collection<? extends Calendar>, Period>PeriodType periodType

It creates a Period with the specified PeriodType. The input received by the Function must have size 2 and represents the start and end instants of the Period

calendarFieldCollectionToPeriodFunction<Collection<? extends Calendar>, Period>PeriodType periodType
Chronology chronology

It creates a Period with the specified PeriodType and Chronology. The input received by the Function must have size 2 and represents the start and end instants of the Period

dateFieldArrayToPeriodFunction<T[], Period>

The function receives an Array of two Date elements used as the start and end of the Period it creates

dateFieldArrayToPeriodFunction<T[], Period>Chronology chronology

The function receives an Array of two Date elements used as the start and end of the Period it creates. The Period will be created using the specified Chronology

dateFieldArrayToPeriodFunction<T[], Period>PeriodType periodType

The function receives an Array of two Date elements used as the start and end of the Period it creates. The Period will be created using the specified PeriodType

dateFieldArrayToPeriodFunction<T[], Period>PeriodType periodType
Chronology chronology

The function receives an Array of two Date elements used as the start and end of the Period it creates. The Period will be created using the specified PeriodType and Chronology

dateFieldCollectionToPeriodFunction<Collection<? extends Date>, Period>

The function receives a Collection of two Date elements used as the start and end of the Period it creates

dateFieldCollectionToPeriodFunction<Collection<? extends Date>, Period>Chronology chronology

The function receives a Collection of two Date elements used as the start and end of the Period it creates. The Period will be created using the specified Chronology

dateFieldCollectionToPeriodFunction<Collection<? extends Date>, Period>PeriodType periodType

The function receives a Collection of two Date elements used as the start and end of the Period it creates. The Period will be created using the specified PeriodType

dateFieldCollectionToPeriodFunction<Collection<? extends Date>, Period>PeriodType periodType
Chronology chronology

The function receives a Collection of two Date elements used as the start and end of the Period it creates. The Period will be created using the specified PeriodType and Chronology

integerFieldArrayToPeriodFunction<Integer[], Period>

It creates a Period either:

  • From an Integer[] representing the hours, minutes, seconds and milliseconds
  • From an Integer[] representing the years, months, weeks, days, hours, minutes, seconds and milliseconds
integerFieldArrayToPeriodFunction<Integer[], Period>PeriodType periodType

It creates a Period with the specified PeriodType either:

  • From an Integer[] representing the hours, minutes, seconds and milliseconds
  • From an Integer[] representing the years, months, weeks, days, hours, minutes, seconds and milliseconds
integerFieldCollectionToPeriodFunction<Collection<Integer>, Period>

It creates a Period either:

  • From a Collection of Integer representing the hours, minutes, seconds and milliseconds
  • From a Collection of Integer representing the years, months, weeks, days, hours, minutes, seconds and milliseconds
integerFieldCollectionToPeriodFunction<Collection<Integer>, Period>PeriodType periodType

It creates a Period with the specified PeriodType either:

  • From a Collection of Integer representing the hours, minutes, seconds and milliseconds
  • From a Collection of Integer representing the years, months, weeks, days, hours, minutes, seconds and milliseconds
longFieldArrayToPeriodFunction<Long[], Period>

The given Long targets representing the time in milliseconds will be used as the start and end instants of the Period returned

longFieldArrayToPeriodFunction<Long[], Period>Chronology chronology

The given Long targets representing the time in milliseconds will be used as the start and end instants of the Period returned

longFieldArrayToPeriodFunction<Long[], Period>PeriodType periodType

The given Long targets representing the time in milliseconds will be used as the start and end instants of the Period returned

longFieldArrayToPeriodFunction<Long[], Period>PeriodType periodType
Chronology chronology

The given Long targets representing the time in milliseconds will be used as the start and end instants of the Period returned

longFieldCollectionToPeriodFunction<Collection<Long>, Period>

The given Long targets representing the time in milliseconds will be used as the start and end instants of the Period returned

longFieldCollectionToPeriodFunction<Collection<Long>, Period>Chronology chronology

The given Long targets representing the time in milliseconds will be used as the start and end instants of the Period returned

longFieldCollectionToPeriodFunction<Collection<Long>, Period>PeriodType periodType

The given Long targets representing the time in milliseconds will be used as the start and end instants of the Period returned

longFieldCollectionToPeriodFunction<Collection<Long>, Period>PeriodType periodType
Chronology chronology

The given Long targets representing the time in milliseconds will be used as the start and end instants of the Period returned

longToPeriodFunction<Long, Period>

The function receives a Long representing the Period duration in milliseconds and creates a Period with such duration

longToPeriodFunction<Long, Period>Chronology chronology

Creates a Period with the specified Chronology and, as the duration, the input received by this function (in milliseconds)

longToPeriodFunction<Long, Period>PeriodType periodType

Creates a Period with the specified PeriodType and, as the duration, the input received by this function (in milliseconds)

longToPeriodFunction<Long, Period>PeriodType periodType
Chronology chronology

Creates a Period with the specified PeriodType and Chronology and, as the duration, the input received by this function (in milliseconds)

strFieldArrayToPeriodFunction<String[], Period>

A Period is created either:

  • From a String[] representing the hours, minutes, seconds and milliseconds
  • From a String[] representing the years, months, weeks, days, hours, minutes, seconds and milliseconds
strFieldArrayToPeriodFunction<String[], Period>PeriodType periodType

A Period is created with the specified PeriodType either:

  • From a String[] representing the hours, minutes, seconds and milliseconds
  • From a String[] representing the years, months, weeks, days, hours, minutes, seconds and milliseconds
strFieldCollectionToPeriodFunction<Collection<String>, Period>

A Period is created either:

  • From a Collection of String representing the hours, minutes, seconds and milliseconds
  • From a Collection of String representing the years, months, weeks, days, hours, minutes, seconds and milliseconds
strFieldCollectionToPeriodFunction<Collection<String>, Period>PeriodType periodType

A Period is created with the specified PeriodType either:

  • From a Collection of String representing the hours, minutes, seconds and milliseconds
  • From a Collection of String representing the years, months, weeks, days, hours, minutes, seconds and milliseconds
timestampFieldArrayToPeriodFunction<Timestamp[], Period>

The function receives an Array of two Timestamp elements used as the start and end of the Period it creates

timestampFieldArrayToPeriodFunction<Timestamp[], Period>Chronology chronology

The function receives an Array of two Timestamp elements used as the start and end of the Period it creates. The Period will be created using the specified Chronology

timestampFieldArrayToPeriodFunction<Timestamp[], Period>PeriodType periodType

The function receives an Array of two Timestamp elements used as the start and end of the Period it creates. The Period will be created using the specified PeriodType

timestampFieldArrayToPeriodFunction<Timestamp[], Period>PeriodType periodType
Chronology chronology

The function receives an Array of two Timestamp elements used as the start and end of the Period it creates. The Period will be created using the specified specified PeriodType and Chronology

timestampFieldCollectionToPeriodFunction<Collection<Timestamp>, Period>

The function receives a Collection of two Timestamp elements used as the start and end of the Period it creates

timestampFieldCollectionToPeriodFunction<Collection<Timestamp>, Period>Chronology chronology

The function receives a Collection of two Timestamp elements used as the start and end of the Period it creates. The Period will be created using the specified Chronology

timestampFieldCollectionToPeriodFunction<Collection<Timestamp>, Period>PeriodType periodType

The function receives a Collection of two Timestamp elements used as the start and end of the Period it creates. The Period will be created using the specified PeriodType

timestampFieldCollectionToPeriodFunction<Collection<Timestamp>, Period>PeriodType periodType
Chronology chronology

The function receives a Collection of two Timestamp elements used as the start and end of the Period it creates. The Period will be created using the specified specified PeriodType and Chronology