Class GError

  • All Implemented Interfaces:
    java.lang.Cloneable, java.lang.Comparable<GError>

    public class GError
    extends java.lang.Object
    implements java.lang.Cloneable, java.lang.Comparable<GError>
    This is a data holder class for property errors.
    Author:
    Christopher Mindus
    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  GError.Source
      The error source.
      static class  GError.Type
      The error types.
    • Constructor Summary

      Constructors 
      Constructor Description
      GError​(GError.Type type, GError.Source source, java.lang.String propertyName, java.lang.String propertyItem, java.lang.String description)
      Creates a new error object without quick fixes.
      GError​(GError.Type type, GError.Source source, java.lang.String propertyName, java.lang.String propertyItem, java.lang.String description, QuickFix[] quickFixes)
      Creates a new error object.
      GError​(org.w3c.dom.Element element)
      Creates a new error object from an XML element.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      int compareTo​(GError e)
      Used for sorting errors.
      boolean equals​(java.lang.Object o)
      Checks if two errors are equal, that is that they represent the same error cause.
      java.lang.String getDescription()
      Gets the description of the error.
      java.lang.String getPropertyItem()
      Gets the property item of the source property that is the cause of the error.
      java.lang.String getPropertyName()
      Gets the property name that is the cause of the error.
      QuickFix[] getQuickFixes()
      Gets a copy of the quick fixes.
      GError.Type getType()
      Gets the type.
      void saveTo​(org.w3c.dom.Element element)
      Saves the error to XML.
      • Methods inherited from class java.lang.Object

        clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • GError

        public GError​(GError.Type type,
                      GError.Source source,
                      java.lang.String propertyName,
                      java.lang.String propertyItem,
                      java.lang.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:
        java.lang.NullPointerException - If type, source, propertyName, description or a quickFix array item is null.
      • GError

        public GError​(GError.Type type,
                      GError.Source source,
                      java.lang.String propertyName,
                      java.lang.String propertyItem,
                      java.lang.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:
        java.lang.NullPointerException - If type, source, propertyName, description or a quickFix array item is null.
      • GError

        public GError​(org.w3c.dom.Element element)
               throws java.lang.Exception
        Creates a new error object from an XML element.
        Parameters:
        element - The element.
        Throws:
        java.lang.Exception - For errors in XML or quick-fix classes.
    • Method Detail

      • getType

        public GError.Type getType()
        Gets the type.
      • getPropertyName

        public java.lang.String getPropertyName()
        Gets the property name that is the cause of the error.
      • getPropertyItem

        public java.lang.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

        public java.lang.String getDescription()
        Gets the description of the error.
      • getQuickFixes

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

        public void saveTo​(org.w3c.dom.Element element)
        Saves the error to XML.
      • equals

        public boolean equals​(java.lang.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 java.lang.Object
      • compareTo

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