-
Notifications
You must be signed in to change notification settings - Fork 215
/
SearchResultBuilder.java
executable file
·90 lines (78 loc) · 2.9 KB
/
SearchResultBuilder.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
/*
* Copyright (c) 2017 Contributors to the Eclipse Foundation
*
* See the NOTICE file(s) distributed with this work for additional
* information regarding copyright ownership.
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Public License 2.0 which is available at
* http://www.eclipse.org/legal/epl-2.0
*
* SPDX-License-Identifier: EPL-2.0
*/
package org.eclipse.ditto.thingsearch.model;
import java.time.Instant;
import javax.annotation.Nullable;
import javax.annotation.concurrent.NotThreadSafe;
import org.eclipse.ditto.json.JsonValue;
/**
* A mutable builder with a fluent API for a {@link SearchResult}.
*/
@NotThreadSafe
public interface SearchResultBuilder {
/**
* Set the offset of the next page if there are more matching results available or {@link
* SearchResult#NO_NEXT_PAGE}, if there is no next page.
*
* @param nextPageOffset the offset of the next page.
* @return this builder to allow method chaining.
*/
SearchResultBuilder nextPageOffset(@Nullable Long nextPageOffset);
/**
* Set the cursor of the next page if there are more matching results available or {@code * null}, if there is no
* next page.
*
* @param cursor the offset of the next page.
* @return this builder to allow method chaining.
*/
SearchResultBuilder cursor(@Nullable String cursor);
/**
* Set the timestamp of the last modification of the search result.
*
* @param lastModified the timestamp.
* @return this builder.
* @since 2.5.0
*/
SearchResultBuilder lastModified(@Nullable Instant lastModified);
/**
* Adds at least one {@link JsonValue} to the {@code SearchResult} to be built.
*
* @param item the item to add to the results.
* @param furtherItems additional items to be added to the array.
* @return this builder to allow method chaining.
* @throws NullPointerException if any argument is {@code null}.
*/
SearchResultBuilder add(JsonValue item, JsonValue... furtherItems);
/**
* Adds all given items to the {@code SearchResult} to be built.
*
* @param items the items to add to the results.
* @return this builder to allow method chaining.
* @throws NullPointerException if {@code items} is {@code null}.
*/
SearchResultBuilder addAll(Iterable<? extends JsonValue> items);
/**
* Removes the given item from the {@code SearchResult} to be built.
*
* @param item the item to be removed.
* @return this builder to allow method chaining.
* @throws NullPointerException if {@code item} is {@code null}.
*/
SearchResultBuilder remove(JsonValue item);
/**
* Creates a new {@link SearchResult} object containing all items which were set to this builder beforehand.
*
* @return the new {@code SearchResult} object.
*/
SearchResult build();
}