net.adamcin.oakpal.api

Interface Violation

All Superinterfaces:

JsonObjectConvertible

All Known Implementing Classes:

SimpleViolation

@ProviderType
public interface Violation
extends JsonObjectConvertible

Report type for validations.

Method Summary

Modifier and Type	Method and Description
String	getDescription() Describes the nature of the violation.
Collection<org.apache.jackrabbit.vault.packaging.PackageId>	getPackages() Provides a list of one or more Packages responsible for the violation.
Severity	getSeverity() Describe the severity of the violation.
default javax.json.JsonObject	toJson() Serializes the Violation to a JsonObject.

Method Detail

getSeverity

Severity getSeverity()

Describe the severity of the violation.

Returns:

the severity of the violation

getPackages

Collection<org.apache.jackrabbit.vault.packaging.PackageId> getPackages()

Provides a list of one or more Packages responsible for the violation.

Returns:

a list of package IDs responsible for the violation.

getDescription

String getDescription()

Describes the nature of the violation.

Returns:

the description

toJson

default javax.json.JsonObject toJson()

Serializes the Violation to a JsonObject.

Specified by:

toJson in interface JsonObjectConvertible

Returns:

the json representation of the violation