io.grpc.internal.InsightBuilder Maven / Gradle / Ivy
/*
* Copyright 2019 The gRPC Authors
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package io.grpc.internal;
import java.util.ArrayList;
import javax.annotation.Nullable;
/**
* Builds a concise and readable string that gives insight of the concerned part of the system. The
* resulted string is made up of a list of short strings, each of which gives out a piece of
* information.
*/
public final class InsightBuilder {
private final ArrayList buffer = new ArrayList<>();
/**
* Appends a piece of information which is a plain string. The given object is immediately
* converted to string and recorded.
*/
public InsightBuilder append(@Nullable Object insight) {
buffer.add(String.valueOf(insight));
return this;
}
/**
* Appends a piece of information which is a key-value , which will be formatted into {@code
* "key=value"}. Value's {@code toString()} or {@code null} is immediately recorded.
*/
public InsightBuilder appendKeyValue(String key, @Nullable Object value) {
buffer.add(key + "=" + value);
return this;
}
/**
* Get the resulting string.
*/
@Override
public String toString() {
return buffer.toString();
}
}