Class DocType


  • @Deprecated
    public class DocType
    extends Content
    Deprecated.
    Class for generating document type for HTML pages of javadoc output.

    This is NOT part of any supported API. If you write code that depends on this, you do so at your own risk. This code and its internal interfaces are subject to change or deletion without notice.

    • Constructor Summary

      Constructors 
      Modifier Constructor Description
      private DocType()
      Deprecated.
      Constructor to construct a DocType object.
      private DocType​(java.lang.String type, java.lang.String dtd)
      Deprecated.
      Constructor to construct a DocType object.
    • Method Summary

      All Methods Instance Methods Concrete Methods Deprecated Methods 
      Modifier and Type Method Description
      void addContent​(Content content)
      Deprecated.
      This method is not supported by the class.
      void addContent​(java.lang.String stringContent)
      Deprecated.
      This method is not supported by the class.
      boolean isEmpty()
      Deprecated.
      Returns true if the content is empty.
      boolean write​(java.io.Writer out, boolean atNewline)
      Deprecated.
      Writes content to a writer.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
    • Field Detail

      • docType

        private java.lang.String docType
        Deprecated.
      • TRANSITIONAL

        public static final DocType TRANSITIONAL
        Deprecated.
      • HTML5

        public static final DocType HTML5
        Deprecated.
    • Constructor Detail

      • DocType

        private DocType​(java.lang.String type,
                        java.lang.String dtd)
        Deprecated.
        Constructor to construct a DocType object.
        Parameters:
        type - the doctype to be added
        dtd - the dtd of the doctype
      • DocType

        private DocType()
        Deprecated.
        Constructor to construct a DocType object.
    • Method Detail

      • addContent

        public void addContent​(Content content)
        Deprecated.
        This method is not supported by the class.
        Specified by:
        addContent in class Content
        Parameters:
        content - content that needs to be added
        Throws:
        DocletAbortException - this method will always throw a DocletAbortException because it is not supported.
      • addContent

        public void addContent​(java.lang.String stringContent)
        Deprecated.
        This method is not supported by the class.
        Specified by:
        addContent in class Content
        Parameters:
        stringContent - string content that needs to be added
        Throws:
        DocletAbortException - this method will always throw a DocletAbortException because it is not supported.
      • isEmpty

        public boolean isEmpty()
        Deprecated.
        Returns true if the content is empty.
        Specified by:
        isEmpty in class Content
        Returns:
        true if no content to be displayed else return false
      • write

        public boolean write​(java.io.Writer out,
                             boolean atNewline)
                      throws java.io.IOException
        Deprecated.
        Writes content to a writer.
        Specified by:
        write in class Content
        Throws:
        java.io.IOException