Class ValidationProblems


  • @API(type=EXTENDABLE,
         src=PUBLIC)
    public class ValidationProblems
    extends java.lang.Object
    Holds a set of problems which were reported during the validation process.
    Since:
    13
    • Field Detail

      • VALIDATION_AUTOMATIC

        public static final int VALIDATION_AUTOMATIC
        The problem was generated by the automatic validation.
        See Also:
        Constant Field Values
      • VALIDATION_CUSTOM

        public static final int VALIDATION_CUSTOM
        The problem was generated by the custom schema validation.
        See Also:
        Constant Field Values
      • VALIDATION_NORMAL

        public static final int VALIDATION_NORMAL
        The problem was generated by the regular validation.
        See Also:
        Constant Field Values
      • VALIDATION_DITA_MAP_CHECK_FOR_COMPLETENESS

        public static final int VALIDATION_DITA_MAP_CHECK_FOR_COMPLETENESS
        The problem was generated by the validate and check for completeness action.
        See Also:
        Constant Field Values
    • Constructor Detail

      • ValidationProblems

        public ValidationProblems​(java.util.List<DocumentPositionedInfo> problemsList,
                                  int problemType)
        Constructor.
        Parameters:
        problemsList - The list of problems, can be null if validation was successful.
        problemType - The type of validation, one of the constants in this class.
    • Method Detail

      • addValidationProblems

        public void addValidationProblems​(ValidationProblems validationProblems)
        Add the validation problems to the new one.
        Parameters:
        validationProblems - The validation problems to add.
      • getProblemsList

        public java.util.List<DocumentPositionedInfo> getProblemsList()
        Get the list of problems. Can be null or an empty list if there are no problems.
        Returns:
        The list of problems. The actual internal list, not a clone. Can be null
      • setProblemsList

        public void setProblemsList​(java.util.List<DocumentPositionedInfo> problemsList)
        Set the list of problems.
        Parameters:
        problemsList - The list of problems.
      • getValidationType

        public int getValidationType()
        Get the validation type. One of the constants defined in the class.
        Returns:
        The validation type (manual or automatic).