doc / ch.tutteli.atrium.api.fluent.en_GB / year

year

val Expect<LocalDate>.year: Expect<Int> (source)

Creates an Expect for the property LocalDate.year of the subject of this expectation, so that further fluent calls are assertions about it.

expect(LocalDate.of(2021, Month.OCTOBER, 9))
    .year // subject is now of type Int (actually 2021)
    .toEqual(2021)

fails {
    expect(LocalDate.of(2021, Month.OCTOBER, 9))
        .year // subject is now of type Int (actually 2021)
        .toBeGreaterThan(2030)  // fails
        .toBeLessThan(2000)     // not evaluated/reported because toBeLessThan already fails
    //                             use `.year { ... }` if you want that all expectations are evaluated
}

Return
The newly created Expect for the extracted feature.

Since
0.9.0

val Expect<LocalDateTime>.year: Expect<Int> (source)

Creates an Expect for the property LocalDateTime.year[LocalDateTime.getYear of the subject of this expectation, so that further fluent calls are assertions about it.

expect(LocalDateTime.of(2021, Month.OCTOBER, 9, 11, 56))
    .year // subject is now of type Int (actually 2021)
    .toEqual(2021)

fails {
    expect(LocalDateTime.of(2021, Month.OCTOBER, 9, 11, 56))
        .year // subject is now of type Int (actually 2021)
        .notToEqual(1980)    // fails
        .toBeLessThan(2000)  // not evaluated/reported because notToEqual already fails
    //                          use `.year { ... }` if you want that all expectations are evaluated
}

Return
The newly created Expect for the extracted feature.

Since
0.9.0

val Expect<ZonedDateTime>.year: Expect<Int> (source)

Creates an Expect for the property ZonedDateTime.year of the subject of this expectation, so that further fluent calls are assertions about it.

val zonedDateTime = ZonedDateTime.of(LocalDateTime.of(2021, 10, 9, 11, 56), ZoneId.systemDefault())

expect(zonedDateTime)
    .year // subject is now of type Int (actually 2021)
    .toEqual(2021)

fails {
    expect(zonedDateTime)
        .year // subject is now of type Int (actually 2021)
        .toBeGreaterThan(2030)  // fails
        .toBeLessThan(2000)     // not evaluated/reported because toBeLessThan already fails
    //                             use `.year { ... }` if you want that all expectations are evaluated
}

Return
The newly created Expect for the extracted feature.

Since
0.9.0

fun Expect<LocalDate>.year(assertionCreator: Expect<Int>.() -> Unit): Expect<LocalDate> (source)

Expects that the property LocalDate.yearof the subject of this expectation holds all assertions the given assertionCreator creates for it and returns an Expect for the current subject of this expectation.

expect(LocalDate.of(2021, Month.OCTOBER, 9))
    .year { // subject inside this block is of type Int (actually 2021)
        toEqual(2021)
        toBeGreaterThan(2020)
    } // subject here is back to type LocalDate

fails {
    expect(LocalDate.of(2021, Month.OCTOBER, 9))
        .year { // subject inside this block is of type Int (actually 2021)
            notToEqual(1980)    // fails
            toBeLessThan(2000)  // not evaluated/reported because notToEqual already fails
            //                     use `.year.` if you want a fail fast behaviour
        }
}

Return
an Expect for the subject of this expectation.

Since
0.9.0

fun Expect<LocalDateTime>.year(assertionCreator: Expect<Int>.() -> Unit): Expect<LocalDateTime> (source)

Expects that the property LocalDateTime.year of the subject of this expectation holds all assertions the given assertionCreator creates for it and returns an Expect for the current subject of this expectation.

expect(LocalDateTime.of(2021, Month.OCTOBER, 9, 11, 56))
    .year { // subject inside this block is of type Int (actually 2021)
        toEqual(2021)
        toBeGreaterThan(2020)
    } // subject here is back to type LocalDateTime

fails {
    expect(LocalDateTime.of(2021, Month.OCTOBER, 9, 11, 56))
        .year { // subject inside this block is of type Int (actually 2021)
            notToEqual(1980)    // fails
            toBeLessThan(2000)  // not evaluated/reported because notToEqual already fails
            //                     use `.year.` if you want a fail fast behaviour
        }
}

Return
an Expect for the subject of this expectation.

Since
0.9.0

fun Expect<ZonedDateTime>.year(assertionCreator: Expect<Int>.() -> Unit): Expect<ZonedDateTime> (source)

Expects that the property ZonedDateTime.year of the subject of this expectation holds all assertions the given assertionCreator creates for it and returns an Expect for the current subject of this expectation.

val zonedDateTime = ZonedDateTime.of(LocalDateTime.of(2021, 10, 9, 11, 56), ZoneId.systemDefault())

expect(zonedDateTime)
    .year { // subject inside this block is of type Int (actually 2021)
        toEqual(2021)
        toBeGreaterThan(2020)
    } // subject here is back to type ZonedDateTime

fails {
    expect(zonedDateTime)
        .year { // subject inside this block is of type Int (actually 2021)
            notToEqual(1980)    // fails
            toBeLessThan(2000)  // not evaluated/reported because notToEqual already fails
            //                     use `.year.` if you want a fail fast behaviour
        }
}

Return
an Expect for the subject of this expectation.

Since
0.9.0