com.btkelly.gnag.models

Class Violation

java.lang.Object

com.btkelly.gnag.models.Violation

public final class Violation
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
static @NotNull java.util.Comparator<Violation>	COMPARATOR

Constructor Summary

Constructors

Constructor and Description
Violation(@NotNull java.lang.String type, @NotNull java.lang.String reporterName, @Nullable java.lang.String comment, @Nullable java.lang.String relativeFilePath, @Nullable java.lang.Integer fileLineNumber)
Violation(@NotNull java.lang.String type, @NotNull java.lang.String reporterName, @Nullable java.lang.String comment, @Nullable java.lang.String relativeFilePath, @Nullable java.lang.Integer fileLineNumber, @Nullable java.lang.String typeUrl)
Violation(@NotNull java.lang.String type, @NotNull java.lang.String reporterName, @Nullable java.lang.String comment, @Nullable java.lang.String relativeFilePath, @Nullable java.lang.Integer fileLineNumber, @Nullable java.lang.String typeUrl, @NotNull java.util.List<java.lang.String> secondaryUrls)

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o)
@Nullable java.lang.String	getComment()
@Nullable java.lang.Integer	getFileLineNumber()
@Nullable java.lang.String	getRelativeFilePath()
@NotNull java.lang.String	getReporterName()
@NotNull java.util.List<java.lang.String>	getSecondaryUrls()
@NotNull java.lang.String	getType()
@Nullable java.lang.String	getTypeUrl()
boolean	hasAllLocationInfo()
int	hashCode()
boolean	hasRelativeFilePath()

Methods inherited from class java.lang.Object

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

Field Detail

COMPARATOR

@NotNull
public static final @NotNull java.util.Comparator<Violation> COMPARATOR

Constructor Detail

Violation

public Violation(@NotNull
                 @NotNull java.lang.String type,
                 @NotNull
                 @NotNull java.lang.String reporterName,
                 @Nullable
                 @Nullable java.lang.String comment,
                 @Nullable
                 @Nullable java.lang.String relativeFilePath,
                 @Nullable
                 @Nullable java.lang.Integer fileLineNumber)

Violation

public Violation(@NotNull
                 @NotNull java.lang.String type,
                 @NotNull
                 @NotNull java.lang.String reporterName,
                 @Nullable
                 @Nullable java.lang.String comment,
                 @Nullable
                 @Nullable java.lang.String relativeFilePath,
                 @Nullable
                 @Nullable java.lang.Integer fileLineNumber,
                 @Nullable
                 @Nullable java.lang.String typeUrl)

Parameters:

typeUrl - a URL identifying a resource that provides more information on this violation's type; null if no such resource is known

Violation

public Violation(@NotNull
                 @NotNull java.lang.String type,
                 @NotNull
                 @NotNull java.lang.String reporterName,
                 @Nullable
                 @Nullable java.lang.String comment,
                 @Nullable
                 @Nullable java.lang.String relativeFilePath,
                 @Nullable
                 @Nullable java.lang.Integer fileLineNumber,
                 @Nullable
                 @Nullable java.lang.String typeUrl,
                 @NotNull
                 @NotNull java.util.List<java.lang.String> secondaryUrls)

Parameters:

typeUrl - a URL identifying a resource that provides more information on this violation's type; null if no such resource is known

Method Detail

getType

@NotNull
public @NotNull java.lang.String getType()

getReporterName

@NotNull
public @NotNull java.lang.String getReporterName()

getComment

@Nullable
public @Nullable java.lang.String getComment()

getRelativeFilePath

@Nullable
public @Nullable java.lang.String getRelativeFilePath()

getFileLineNumber

@Nullable
public @Nullable java.lang.Integer getFileLineNumber()

getTypeUrl

@Nullable
public @Nullable java.lang.String getTypeUrl()

getSecondaryUrls

@NotNull
public @NotNull java.util.List<java.lang.String> getSecondaryUrls()

hasRelativeFilePath

public boolean hasRelativeFilePath()

hasAllLocationInfo

public boolean hasAllLocationInfo()

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object