Package com.iizix.prop

Class GError

java.lang.Object
com.iizix.prop.GError
All Implemented Interfaces:
Cloneable, Comparable<GError>
public class GError extends Object implements Cloneable, Comparable<GError>
This is a data holder class for property errors.
Author:
Christopher Mindus

  • Field Details Link icon

  • Constructor Details Link icon

    • GError Link icon

      public GError(GError.Type type, GError.Source source, String propertyName, String propertyItem, String description)
      Creates a new error object without quick fixes.
      Parameters:
      type - The error type.
      source - The error source.
      propertyName - The property name.
      propertyItem - The property item, null for none.
      description - The description of the error.
      Throws:
      NullPointerException - If type, source, propertyName, description or a quickFix array item is null.

    • GError Link icon

      public GError(GError.Type type, GError.Source source, String propertyName, String propertyItem, String description, QuickFix[] quickFixes)
      Creates a new error object.
      Parameters:
      type - The error type.
      source - The error source.
      propertyName - The property name.
      propertyItem - The property item, null for none.
      description - The description of the error.
      quickFixes - Array of quick fixes, null for none.
      Throws:
      NullPointerException - If type, source, propertyName, description or a quickFix array item is null.

    • GError Link icon

      public GError(Element element) throws Exception
      Creates a new error object from an XML element.
      Parameters:
      element - The element.
      Throws:
      Exception - For errors in XML or quick-fix classes.

  • Method Details Link icon

    • getType Link icon

      public GError.Type getType()
      Gets the type.

    • getPropertyName Link icon

      public String getPropertyName()
      Gets the property name that is the cause of the error.

    • getPropertyItem Link icon

      public String getPropertyItem()
      Gets the property item of the source property that is the cause of the error.
      Returns:
      The item name, or null for none.

    • getDescription Link icon

      public String getDescription()
      Gets the description of the error.

    • getQuickFixes Link icon

      public QuickFix[] getQuickFixes()
      Gets a copy of the quick fixes.
      Returns:
      a cloned array of quick-fixes, or null if none are present.

    • saveTo Link icon

      public void saveTo(Element element)
      Saves the error to XML.

    • equals Link icon

      public boolean equals(Object o)
      Checks if two errors are equal, that is that they represent the same error cause. Comparison is done by type, source, property name, property item (if present), and description. Quick fixes are not checked.
      Overrides:
      equals in class Object

    • compareTo Link icon

      public int compareTo(GError e)
      Used for sorting errors.
      Specified by:
      compareTo in interface Comparable<GError>