Class AbstractSourceContainerTypeDelegate

  • All Implemented Interfaces:
    ISourceContainerTypeDelegate

    public abstract class AbstractSourceContainerTypeDelegate
    extends Object
    implements ISourceContainerTypeDelegate
    Common function for source container type delegates.

    Clients implementing source container delegates should subclass this class.

    Since:
    3.0
    • Constructor Detail

      • AbstractSourceContainerTypeDelegate

        public AbstractSourceContainerTypeDelegate()
    • Method Detail

      • abort

        protected void abort​(String message,
                             Throwable exception)
                      throws CoreException
        Throws an exception with the given message and underlying exception.
        Parameters:
        message - error message
        exception - underlying exception, or null
        Throws:
        CoreException - if a problem is encountered
      • newDocument

        protected Document newDocument()
                                throws CoreException
        Creates and returns a new XML document.
        Returns:
        a new XML document
        Throws:
        CoreException - if unable to create a new document
      • serializeDocument

        protected String serializeDocument​(Document document)
                                    throws CoreException
        Returns the given XML document as a string.
        Parameters:
        document - document to serialize
        Returns:
        the given XML document as a string
        Throws:
        CoreException - if unable to serialize the document
      • parseDocument

        protected Element parseDocument​(String document)
                                 throws CoreException
        Parses the given XML document, returning its root element.
        Parameters:
        document - XML document as a string
        Returns:
        the document's root element
        Throws:
        CoreException - if unable to parse the document