org.springframework.boot.actuate.info.Info Maven / Gradle / Ivy
/*
* Copyright 2012-2018 the original author or 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
*
* https://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 org.springframework.boot.actuate.info;
import java.util.Collections;
import java.util.LinkedHashMap;
import java.util.Map;
import com.fasterxml.jackson.annotation.JsonAnyGetter;
import com.fasterxml.jackson.annotation.JsonInclude;
import com.fasterxml.jackson.annotation.JsonInclude.Include;
/**
* Carries information of the application.
*
* Each detail element can be singular or a hierarchical object such as a POJO or a nested
* Map.
*
* @author Meang Akira Tanaka
* @author Stephane Nicoll
* @since 1.4.0
*/
@JsonInclude(Include.NON_EMPTY)
public final class Info {
private final Map details;
private Info(Builder builder) {
Map content = new LinkedHashMap<>();
content.putAll(builder.content);
this.details = Collections.unmodifiableMap(content);
}
/**
* Return the content.
* @return the details of the info or an empty map.
*/
@JsonAnyGetter
public Map getDetails() {
return this.details;
}
public Object get(String id) {
return this.details.get(id);
}
@SuppressWarnings("unchecked")
public T get(String id, Class type) {
Object value = get(id);
if (value != null && type != null && !type.isInstance(value)) {
throw new IllegalStateException("Info entry is not of required type ["
+ type.getName() + "]: " + value);
}
return (T) value;
}
@Override
public boolean equals(Object obj) {
if (obj == this) {
return true;
}
if (obj != null && obj instanceof Info) {
Info other = (Info) obj;
return this.details.equals(other.details);
}
return false;
}
@Override
public int hashCode() {
return this.details.hashCode();
}
@Override
public String toString() {
return getDetails().toString();
}
/**
* Builder for creating immutable {@link Info} instances.
*/
public static class Builder {
private final Map content;
public Builder() {
this.content = new LinkedHashMap<>();
}
/**
* Record detail using given {@code key} and {@code value}.
* @param key the detail key
* @param value the detail value
* @return this {@link Builder} instance
*/
public Builder withDetail(String key, Object value) {
this.content.put(key, value);
return this;
}
/**
* Record several details.
* @param details the details
* @return this {@link Builder} instance
* @see #withDetail(String, Object)
*/
public Builder withDetails(Map details) {
this.content.putAll(details);
return this;
}
/**
* Create a new {@link Info} instance based on the state of this builder.
* @return a new {@link Info} instance
*/
public Info build() {
return new Info(this);
}
}
}