com.iizix.prop

Class PropErrorItemValue

java.lang.Object

com.iizix.prop.PropErrorItem

com.iizix.prop.PropErrorItemValue

All Implemented Interfaces:

IPropErrorItem, Cloneable

public class PropErrorItemValue
extends PropErrorItem

Class holding information about an error for the Property Editor in the Designer. Several errors can be set for a single property, e.g. when there are of multi-style.

Author:

Christopher Mindus

Field Summary

Fields inherited from interface com.iizix.prop.IPropErrorItem

CHILD_PROP_ERROR_PREFIX, ERROR, INFO, VERIFY_ERROR_CHILD_PREFIX, WARNING

Constructor Summary

Constructors

Constructor and Description
PropErrorItemValue() Constructs a new instance from an XML element.
PropErrorItemValue(String input, String message) Constructs a new instance without ID (empty string).
PropErrorItemValue(String id, String input, String message) Constructs a new instance.
PropErrorItemValue(String id, String input, String message, int level) Constructs a new instance.
PropErrorItemValue(String id, String input, String message, int level, String... quickFixes) Constructs a new instance.
PropErrorItemValue(String id, String input, String message, String location, int level, String... quickFixes) Constructs a new instance.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o) Checks if two items are equal.
String	getInput() Gets the user input.
void	load(Element element) Loads the error from XML.
protected String	paramString() Formats the error input to a string.
void	save(Element element) Called when the XML file for the error tree is serialized from properties.

Methods inherited from class com.iizix.prop.PropErrorItem

clone, getID, getIndex, getLocation, getLocationOrName, getMessage, getQuickFixes, getSeverity, getText, setIndex, toString

Methods inherited from class java.lang.Object

finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.iizix.prop.IPropErrorItem

getChildPropName, isChildPropError

Constructor Detail

PropErrorItemValue

public PropErrorItemValue()

Constructs a new instance from an XML element.

PropErrorItemValue

public PropErrorItemValue(String input,
                          String message)

Constructs a new instance without ID (empty string).

Parameters:

input - The user input string, never null.

message - The error message string, never null.

Throws:

NullPointerException - If input or message is null.

PropErrorItemValue

public PropErrorItemValue(String id,
                          String input,
                          String message)

Constructs a new instance.

Parameters:

id - The ID of the message, never null.

input - The user input string, never null.

message - The error message string, never null.

Throws:

NullPointerException - If id, input or message is null.

PropErrorItemValue

public PropErrorItemValue(String id,
                          String input,
                          String message,
                          int level)

Constructs a new instance.

Parameters:

id - The ID of the message, never null.

input - The user input string, never null.

message - The error message string, never null.

level - The severity level: INFO, WARNING or ERROR.

Throws:

IllegalArgumentException - If level is not INFO, WARNING or ERROR.

NullPointerException - If id, input or message is null.

PropErrorItemValue

public PropErrorItemValue(String id,
                          String input,
                          String message,
                          int level,
                          String... quickFixes)

Constructs a new instance.

Parameters:

id - The ID of the message, never null.

input - The user input string, never null.

message - The error message string, never null.

level - The severity level: INFO, WARNING or ERROR.

quickFixes - The quick-fix ID's.

Throws:

IllegalArgumentException - If level is not INFO, WARNING or ERROR.

NullPointerException - If id, input or message is null.

PropErrorItemValue

public PropErrorItemValue(String id,
                          String input,
                          String message,
                          String location,
                          int level,
                          String... quickFixes)

Constructs a new instance.

Parameters:

id - The ID of the message, never null.

input - The user input string, never null.

message - The error message string, never null.

location - The location, null for none.

level - The severity level: INFO, WARNING or ERROR.

quickFixes - The quick-fix ID's.

Throws:

IllegalArgumentException - If level is not INFO, WARNING or ERROR.

NullPointerException - If id, input or message is null.

Method Detail

load

public void load(Element element)
          throws Exception

Loads the error from XML.

Specified by:

load in interface IPropErrorItem

Overrides:

load in class PropErrorItem

Parameters:

element - The errorItem element.

Throws:

Exception - For errors in XML.

getInput

public String getInput()

Gets the user input.

equals

public boolean equals(Object o)

Checks if two items are equal.

Specified by:

equals in interface IPropErrorItem

Overrides:

equals in class PropErrorItem

paramString

protected String paramString()

Formats the error input to a string.

Overrides:

paramString in class PropErrorItem

save

public void save(Element element)

Called when the XML file for the error tree is serialized from properties.

Specified by:

save in interface IPropErrorItem

Overrides:

save in class PropErrorItem

Parameters:

element - The Element to initialize.