/*
 * Copyright 2012-2022 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.health;

import com.fasterxml.jackson.annotation.JsonUnwrapped;

import org.springframework.boot.actuate.endpoint.OperationResponseBody;

/**
 * A component that contributes data to results returned from the {@link HealthEndpoint}.
 *
 * @author Phillip Webb
 * @since 2.2.0
 * @see Health
 * @see CompositeHealth
 */
public abstract class HealthComponent implements OperationResponseBody {

	HealthComponent() {
	}

	/**
	 * Return the status of the component.
	 * @return the component status
	 */
	@JsonUnwrapped
	public abstract Status getStatus();

}
