diff --git a/README.md b/README.md index 2f6c5f4725843e54fd7037159795a446375a7218..67a685698bfc2923b05876a900dc63af888b733c 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ _This is an assignment to the class [Programmieren 3](https://hsro-inf-prg3.gith # Assignment 11: Futures - CLI variant -This assignment covers the more advanced multithreading topic _futures_ and _future chaining_. +This assignment covers the more advanced multithreading topics _futures_ and _future chaining_. Futures are a feature of Java 8 and can be compared to the concept of _promises_ in JavaScript. The internet contains lots of good articles about `Future<>` and `CompletableFuture<>` in Java. @@ -46,9 +46,9 @@ The following flow chart shows how to proceed : ### Retrieve the first page of canteens Use the method `getCanteens()` of the OpenMensaAPI to retrieve the fist page of canteens (without index). -The method returns an object of `Response<List<Canteen>>`. +The method returns an instance of `Response<List<Canteen>>`. That might be a little bit confusing but the OpenMensaAPI does not expose a dedicated pagination endpoint to retrieve the total count of items or the total count of pages but exposes this information in the response headers (`X-Total-Pages`, `X-Total-Count`, ...). -To be able extract this information you need the `Response<>` wrapper because the wrapper includes a reference to the headers. +To be able to extract this information you need the `Response<>` wrapper because the wrapper includes a reference to the headers. ### Extract the pagination information