Class AbstractSourceContainerTypeDelegate

  • All Implemented Interfaces:
    ISourceContainerTypeDelegate

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

    Clients implementing source container delegates should subclass this class.

    Since:
    3.0
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      protected void abort​(java.lang.String message, java.lang.Throwable exception)
      Throws an exception with the given message and underlying exception.
      protected org.w3c.dom.Document newDocument()
      Creates and returns a new XML document.
      protected org.w3c.dom.Element parseDocument​(java.lang.String document)
      Parses the given XML document, returning its root element.
      protected java.lang.String serializeDocument​(org.w3c.dom.Document document)
      Returns the given XML document as a string.
      • Methods inherited from class java.lang.Object

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

      • AbstractSourceContainerTypeDelegate

        public AbstractSourceContainerTypeDelegate()
    • Method Detail

      • abort

        protected void abort​(java.lang.String message,
                             java.lang.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 org.w3c.dom.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 java.lang.String serializeDocument​(org.w3c.dom.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 org.w3c.dom.Element parseDocument​(java.lang.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