org.conqat.engine.index.shared.PreCommit3Result Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of teamscale-commons Show documentation

Provides common DTOs for Teamscale

There is a newer version: 2025.1.0

/*
 * Copyright (c) CQSE GmbH
 *
 * 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 org.conqat.engine.index.shared;

import java.util.List;

import org.checkerframework.checker.nullness.qual.Nullable;

import com.fasterxml.jackson.annotation.JsonCreator;
import com.fasterxml.jackson.annotation.JsonProperty;

/**
 * Result from a pre-commit 3.0 analysis.
 */
public class PreCommit3Result {

	/**
	 * The token to poll for final results. If this is provided, you should poll for
	 * finished results later on. If this is null, the returned results are final
	 * and not further analysis will happen.
	 */
	@JsonProperty("token")
	@Nullable
	private final String token;

	/** Any error that occurred (may be null). */
	@JsonProperty("error")
	@Nullable
	private final String error;

	/**
	 * The findings. This may contain data even in case of errors. Additionally,
	 * this may be null to indicate that the findings information is not valid (i.e.
	 * during intermediate polling).
	 */
	@JsonProperty("findings")
	@Nullable
	private final List findings;

	@JsonCreator
	public PreCommit3Result(@JsonProperty("token") @Nullable String token,
			@JsonProperty("error") @Nullable String error,
			@JsonProperty("findings") @Nullable List findings) {
		this.token = token;
		this.error = error;
		this.findings = findings;
	}

	public String getToken() {
		return token;
	}

	public String getError() {
		return error;
	}

	public List getFindings() {
		return findings;
	}
}