Package com.iizix.prop

Class PropVerificationError

  • public class PropVerificationError
extends java.lang.Object
    Class used to hold information about a verification error of a property container.
    Author:
    Christopher Mindus

    • Field Detail

      • property

        public final GProp<?> property
        The property causing the error.

      • errorText

        public final java.lang.String errorText
        The error text.

      • id

        public final java.lang.String id
        The ID of the error.

      • location

        public final java.lang.String location
        Location, or null for none.

      • quickFixes

        public final java.lang.String[] quickFixes
        Quick fixes, or null for none.

    • Constructor Detail

      • PropVerificationError

        public PropVerificationError​(java.lang.String id,
                             PropVerificationError.Severity severity,
                             java.lang.String location,
                             GProp<?> property,
                             java.lang.String errorText,
                             java.lang.String... quickFixes)
        The standard constructor for a property in error.
        Parameters:
        id - The unique ID of the error.
        severity - The severity of the problem.
        location - The location.
        property - The property in error.
        errorText - The error text description.
        quickFixes - A list of optional quick fixes.
        Throws:
        java.lang.NullPointerException - If id, severity, property or errorText is null.

      • PropVerificationError

        public PropVerificationError​(PropCnr parent,
                             Atom childName,
                             PropVerificationError.Severity severity,
                             java.lang.String location,
                             java.lang.String errorText,
                             java.lang.String... quickFixes)
        Constructs an error for a child property. This error can only be added once in the parent container.
        Parameters:
        parent - The parent property.
        childName - The name of the child property.
        severity - The severity of the problem.
        location - The location.
        errorText - The error text description.
        quickFixes - A list of optional quick fixes.
        Throws:
        java.lang.NullPointerException - If parent, childName, id, severity or errorText is null.

      • PropVerificationError

        public PropVerificationError​(PropCnr parent,
                             java.lang.String childName,
                             PropVerificationError.Severity severity,
                             java.lang.String location,
                             java.lang.String errorText,
                             java.lang.String... quickFixes)
        Constructs an error for a child property. This error can only be added once in the parent container.
        Parameters:
        parent - The parent property.
        childName - The name of the child property.
        severity - The severity of the problem.
        location - The location.
        errorText - The error text description.
        quickFixes - A list of optional quick fixes.
        Throws:
        java.lang.NullPointerException - If parent, childName, id, severity or errorText is null.

    • Method Detail

      • getPropErrorItem

        public IPropErrorItem getPropErrorItem()
        Gets the error item for the property error.