net.adamcin.oakpal.api

Class SimpleViolation

java.lang.Object

net.adamcin.oakpal.api.SimpleViolation

All Implemented Interfaces:

JsonObjectConvertible, Violation

public final class SimpleViolation
extends Object
implements Violation

Simple implementation of a Violation.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SimpleViolation.Builder

Constructor Summary

Constructors

Constructor and Description
SimpleViolation(Severity severity, String description, List<org.apache.jackrabbit.vault.packaging.PackageId> packages) Constructor.
SimpleViolation(Severity severity, String description, org.apache.jackrabbit.vault.packaging.PackageId... packages) Constructor.

Method Summary

Modifier and Type	Method and Description
static SimpleViolation.Builder	builder() Use this builder method to more easily construct a violation with MessageFormat arguments.
static SimpleViolation.Builder	builder(ResourceBundle resourceBundle) Use this builder method to more easily construct a violation with MessageFormat arguments.
boolean	equals(Object o)
static SimpleViolation	fromJson(javax.json.JsonObject jsonViolation)
static SimpleViolation	fromReported(Violation violation)
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.
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface net.adamcin.oakpal.api.Violation

toJson

Constructor Detail

SimpleViolation

public SimpleViolation(Severity severity,
                       String description,
                       org.apache.jackrabbit.vault.packaging.PackageId... packages)

Constructor.

Parameters:

severity - the severity

description - the description

packages - the package ids

SimpleViolation

public SimpleViolation(Severity severity,
                       String description,
                       List<org.apache.jackrabbit.vault.packaging.PackageId> packages)

Constructor.

Parameters:

severity - the severity

description - the description

packages - the package ids

Method Detail

builder

public static SimpleViolation.Builder builder()

Use this builder method to more easily construct a violation with MessageFormat arguments.

Returns:

a new SimpleViolation Builder

builder

public static SimpleViolation.Builder builder(ResourceBundle resourceBundle)

Use this builder method to more easily construct a violation with MessageFormat arguments.

Parameters:

resourceBundle - a ResourceBundle to lookup a localized message format string if available

Returns:

a new SimpleViolation Builder

getSeverity

public Severity getSeverity()

Description copied from interface: Violation

Describe the severity of the violation.

Specified by:

getSeverity in interface Violation

Returns:

the severity of the violation

getPackages

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

Description copied from interface: Violation

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

Specified by:

getPackages in interface Violation

Returns:

a list of package IDs responsible for the violation.

getDescription

public String getDescription()

Description copied from interface: Violation

Describes the nature of the violation.

Specified by:

getDescription in interface Violation

Returns:

the description

fromReported

public static SimpleViolation fromReported(Violation violation)

fromJson

public static SimpleViolation fromJson(javax.json.JsonObject jsonViolation)

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object