Package net.sf.basedb.util.overview

Class Fix

java.lang.Object

net.sf.basedb.util.overview.Fix

public class Fix
extends Object

Holds information about a suggested fix to a failure.

Version:

2.2

Author:

Nicklas

See Also:

• Failure.getFixes()

Last modified

$Date: 2015-08-21 14:32:11 +0200 (fr, 21 aug 2015) $

Field Summary

Fields

Modifier and Type	Field	Description
private Annotation	annotation
private AnnotationType	annotationType
private DataFileType	fileType
private boolean	fromInherited
private BasicItem	item
private FileSetMember	member
private String	message

Constructor Summary

Constructors

Constructor	Description
Fix(String message, BasicItem item)	Create a new suggested fix for an item.
Fix(String message, BasicItem item, Annotation annotation)	Create a new suggested fix for the annotation of an item.
Fix(String message, BasicItem item, AnnotationType annotationType, boolean fromInherited)	Create a new suggested fix for the annotation of an item.
Fix(String message, BasicItem item, DataFileType fileType)
Fix(String message, BasicItem item, FileSetMember member)

Method Summary

Modifier and Type	Method	Description
Annotation	getAnnotation()	Get the annotation that needs to be edited for this fix.
AnnotationType	getAnnotationType()	Get the annotation type of the annotation that needs to be edited for this fix.
DataFileType	getDataFileType()
FileSetMember	getFileSetMember()
BasicItem	getItem()	Get the item that needs to be edited for this fix.
String	getMessage()	Get a message explaining what needs to be fixed.
boolean	isAnnotationFix()	If this fix involves editing an annotation or not.
boolean	isDataFileFix()
boolean	isFromInherited()	If this fix involves editing an inherited annotation or a primary annotation.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

message

private String message

item

private BasicItem item

annotationType

private AnnotationType annotationType

annotation

private Annotation annotation

fromInherited

private boolean fromInherited

member

private FileSetMember member

fileType

private DataFileType fileType

Constructor Details

Fix

public Fix(String message,
 BasicItem item)

Create a new suggested fix for an item.

Parameters:

message - A message explaining what needs to be fixed

item - The item that needs to be edited by this fix

Fix

public Fix(String message,
 BasicItem item,
 AnnotationType annotationType,
 boolean fromInherited)

Create a new suggested fix for the annotation of an item.

Parameters:

message - A message explaining what needs to be fixed

item - The item that needs to be edited by this fix

annotationType - The annotation that needs to be edited by this fix or null if the fix doesn't include annotations

fromInherited - TRUE if the annotation is an inherited annotation or FALSE if it is a primary annotation

Fix

public Fix(String message,
 BasicItem item,
 Annotation annotation)

Create a new suggested fix for the annotation of an item.

Parameters:

message - A message explaining what needs to be fixed

item - The item that needs to be edited by this fix

annotation - The annotation that needs to be edited by this fix

Since:

3.6

Fix

public Fix(String message,
 BasicItem item,
 FileSetMember member)

Fix

public Fix(String message,
 BasicItem item,
 DataFileType fileType)

Method Details

getMessage

public String getMessage()

Get a message explaining what needs to be fixed.

getItem

public BasicItem getItem()

Get the item that needs to be edited for this fix.

getAnnotationType

public AnnotationType getAnnotationType()

Get the annotation type of the annotation that needs to be edited for this fix.

Returns:

An annotation type or null if this is not a fix for annotations

getAnnotation

public Annotation getAnnotation()

Get the annotation that needs to be edited for this fix.

Returns:

An annotation or null if this is not a fix for annotations

Since:

3.6

isAnnotationFix

public boolean isAnnotationFix()

If this fix involves editing an annotation or not.

See Also:

• isFromInherited()

isFromInherited

public boolean isFromInherited()

If this fix involves editing an inherited annotation or a primary annotation.

See Also:

• isAnnotationFix()

getFileSetMember

public FileSetMember getFileSetMember()

getDataFileType

public DataFileType getDataFileType()

isDataFileFix

public boolean isDataFileFix()

toString

public String toString()

Overrides:

toString in class Object