-
Notifications
You must be signed in to change notification settings - Fork 215
/
LogEntryBuilder.java
80 lines (66 loc) · 2.26 KB
/
LogEntryBuilder.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
/*
* Copyright (c) 2019 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.connectivity.model;
import java.time.Instant;
import javax.annotation.Nullable;
import org.eclipse.ditto.base.model.entity.id.EntityId;
/**
* A mutable builder for a {@link LogEntry} with a fluent API.
*/
public interface LogEntryBuilder {
/**
* @param correlationId correlation ID that is associated with the log entry.
* @return this builder to allow method chaining.
*/
LogEntryBuilder correlationId(String correlationId);
/**
* @param timestamp timestamp of the log entry.
* @return this builder to allow method chaining.
*/
LogEntryBuilder timestamp(Instant timestamp);
/**
* @param logCategory category of the log entry.
* @return this builder to allow method chaining.
*/
LogEntryBuilder logCategory(LogCategory logCategory);
/**
* @param logType type of the log entry.
* @return this builder to allow method chaining.
*/
LogEntryBuilder logType(LogType logType);
/**
* @param logLevel the log level.
* @return this builder to allow method chaining.
*/
LogEntryBuilder logLevel(LogLevel logLevel);
/**
* @param message the log message.
* @return this builder to allow method chaining.
*/
LogEntryBuilder message(String message);
/**
* @param address if the log can be correlated to a known source or target, empty otherwise.
* @return this builder to allow method chaining.
*/
LogEntryBuilder address(@Nullable String address);
/**
* @param entityId entity ID if the log can be correlated to a known entity (e.g. a Thing), empty otherwise.
* @return this builder to allow method chaining.
*/
LogEntryBuilder entityId(@Nullable EntityId entityId);
/**
* Builds a new {@link LogEntry}.
* @return the new {@link LogEntry}.
*/
LogEntry build();
}