Class JavaScriptScanner


  • @Deprecated
    public class JavaScriptScanner
    extends java.lang.Object
    Deprecated.
    Parser to detect use of JavaScript in documentation comments.
    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected int bp
      Deprecated.
       
      protected char[] buf
      Deprecated.
      The input buffer, index of most recent character read, index of one past last character in buffer.
      protected int buflen
      Deprecated.
       
      protected char ch
      Deprecated.
      The current character.
      (package private) java.util.Set<java.lang.String> eventAttrs
      Deprecated.
       
      private boolean newline
      Deprecated.
       
      private JavaScriptScanner.Reporter reporter
      Deprecated.
       
      (package private) java.util.Map<java.lang.String,​JavaScriptScanner.TagParser> tagParsers
      Deprecated.
       
      (package private) java.util.Set<java.lang.String> uriAttrs
      Deprecated.
       
    • Constructor Summary

      Constructors 
      Constructor Description
      JavaScriptScanner()
      Deprecated.
       
    • Method Summary

      All Methods Instance Methods Concrete Methods Deprecated Methods 
      Modifier and Type Method Description
      protected void attrValueChar​(java.lang.Void list)
      Deprecated.
       
      protected void blockContent()
      Deprecated.
      Read block content, consisting of text, html and inline tags.
      protected void blockTag()
      Deprecated.
      Read a single block tag, including its content.
      protected void blockTags()
      Deprecated.
      Read a series of block tags, including their content.
      private void checkHtmlAttr​(java.lang.String name, java.lang.String value)
      Deprecated.
       
      private void checkHtmlTag​(java.lang.String tag)
      Deprecated.
       
      protected void entity()
      Deprecated.
      Read an HTML entity.
      protected void entity​(java.lang.Void list)
      Deprecated.
       
      protected void html()
      Deprecated.
      Read the start or end of an HTML tag, or an HTML comment <identifier attrs> or </identifier>
      protected void htmlAttrs()
      Deprecated.
      Read a series of HTML attributes, terminated by > .
      protected void identifier()
      Deprecated.
      Read Java identifier Matching pairs of { } are skipped; the text is terminated by the first unmatched }.
      private void initEventAttrs()
      Deprecated.
       
      private void initTagParsers()
      Deprecated.
       
      private void initURIAttrs()
      Deprecated.
       
      private void inlineContent()
      Deprecated.
      Read general text content of an inline tag, including HTML entities and elements.
      protected void inlineTag()
      Deprecated.
      Read a single inline tag, including its content.
      protected void inlineTag​(java.lang.Void list)
      Deprecated.
       
      private void inlineText​(JavaScriptScanner.WhitespaceRetentionPolicy whitespacePolicy)
      Deprecated.
      Read plain text content of an inline tag.
      protected void inlineWord()
      Deprecated.
      Read a term ie.
      protected boolean isDecimalDigit​(char ch)
      Deprecated.
       
      protected boolean isHexDigit​(char ch)
      Deprecated.
       
      protected boolean isIdentifierStart​(char ch)
      Deprecated.
       
      protected boolean isJavaIdentifierStart​(char ch)
      Deprecated.
       
      protected boolean isUnquotedAttrValueTerminator​(char ch)
      Deprecated.
       
      protected boolean isWhitespace​(char ch)
      Deprecated.
       
      (package private) java.lang.String newString​(int start, int end)
      Deprecated.
       
      (package private) void nextChar()
      Deprecated.
       
      void parse​(java.lang.String comment, JavaScriptScanner.Reporter r)
      Deprecated.
       
      protected void quotedString()
      Deprecated.
      Read a quoted string.
      protected java.lang.String readAttributeName()
      Deprecated.
       
      protected java.lang.String readIdentifier()
      Deprecated.
       
      protected java.lang.String readJavaIdentifier()
      Deprecated.
       
      protected java.lang.String readTagName()
      Deprecated.
       
      protected void reference​(boolean allowMember)
      Deprecated.
      Read Java class name, possibly followed by member Matching pairs of < > are skipped.
      protected void skipWhitespace()
      Deprecated.
       
      • Methods inherited from class java.lang.Object

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

      • buf

        protected char[] buf
        Deprecated.
        The input buffer, index of most recent character read, index of one past last character in buffer.
      • bp

        protected int bp
        Deprecated.
      • buflen

        protected int buflen
        Deprecated.
      • ch

        protected char ch
        Deprecated.
        The current character.
      • newline

        private boolean newline
        Deprecated.
      • eventAttrs

        java.util.Set<java.lang.String> eventAttrs
        Deprecated.
      • uriAttrs

        java.util.Set<java.lang.String> uriAttrs
        Deprecated.
    • Constructor Detail

      • JavaScriptScanner

        public JavaScriptScanner()
        Deprecated.
    • Method Detail

      • checkHtmlTag

        private void checkHtmlTag​(java.lang.String tag)
        Deprecated.
      • checkHtmlAttr

        private void checkHtmlAttr​(java.lang.String name,
                                   java.lang.String value)
        Deprecated.
      • nextChar

        void nextChar()
        Deprecated.
      • blockContent

        protected void blockContent()
        Deprecated.
        Read block content, consisting of text, html and inline tags. Terminated by the end of input, or the beginning of the next block tag: i.e. @ as the first non-whitespace character on a line.
      • blockTags

        protected void blockTags()
        Deprecated.
        Read a series of block tags, including their content. Standard tags parse their content appropriately. Non-standard tags are represented by UnknownBlockTag.
      • blockTag

        protected void blockTag()
        Deprecated.
        Read a single block tag, including its content. Standard tags parse their content appropriately. Non-standard tags are represented by UnknownBlockTag.
      • inlineTag

        protected void inlineTag​(java.lang.Void list)
        Deprecated.
      • inlineTag

        protected void inlineTag()
        Deprecated.
        Read a single inline tag, including its content. Standard tags parse their content appropriately. Non-standard tags are represented by UnknownBlockTag. Malformed tags may be returned as Erroneous.
      • reference

        protected void reference​(boolean allowMember)
                          throws JavaScriptScanner.ParseException
        Deprecated.
        Read Java class name, possibly followed by member Matching pairs of < > are skipped. The text is terminated by the first unmatched }. It is an error if the beginning of the next tag is detected.
        Throws:
        JavaScriptScanner.ParseException
      • quotedString

        protected void quotedString()
        Deprecated.
        Read a quoted string. It is an error if the beginning of the next tag is detected.
      • inlineWord

        protected void inlineWord()
        Deprecated.
        Read a term ie. one word. It is an error if the beginning of the next tag is detected.
      • inlineContent

        private void inlineContent()
        Deprecated.
        Read general text content of an inline tag, including HTML entities and elements. Matching pairs of { } are skipped; the text is terminated by the first unmatched }. It is an error if the beginning of the next tag is detected.
      • entity

        protected void entity​(java.lang.Void list)
        Deprecated.
      • entity

        protected void entity()
        Deprecated.
        Read an HTML entity. &identifier; or &#digits; or &#xhex-digits;
      • html

        protected void html()
        Deprecated.
        Read the start or end of an HTML tag, or an HTML comment <identifier attrs> or </identifier>
      • htmlAttrs

        protected void htmlAttrs()
        Deprecated.
        Read a series of HTML attributes, terminated by > . Each attribute is of the form identifier[=value] . "value" may be unquoted, single-quoted, or double-quoted.
      • attrValueChar

        protected void attrValueChar​(java.lang.Void list)
        Deprecated.
      • isIdentifierStart

        protected boolean isIdentifierStart​(char ch)
        Deprecated.
      • readIdentifier

        protected java.lang.String readIdentifier()
        Deprecated.
      • readAttributeName

        protected java.lang.String readAttributeName()
        Deprecated.
      • readTagName

        protected java.lang.String readTagName()
        Deprecated.
      • isJavaIdentifierStart

        protected boolean isJavaIdentifierStart​(char ch)
        Deprecated.
      • readJavaIdentifier

        protected java.lang.String readJavaIdentifier()
        Deprecated.
      • isDecimalDigit

        protected boolean isDecimalDigit​(char ch)
        Deprecated.
      • isHexDigit

        protected boolean isHexDigit​(char ch)
        Deprecated.
      • isUnquotedAttrValueTerminator

        protected boolean isUnquotedAttrValueTerminator​(char ch)
        Deprecated.
      • isWhitespace

        protected boolean isWhitespace​(char ch)
        Deprecated.
      • skipWhitespace

        protected void skipWhitespace()
        Deprecated.
      • newString

        java.lang.String newString​(int start,
                                   int end)
        Deprecated.
        Parameters:
        start - position of first character of string
        end - position of character beyond last character to be included
      • initTagParsers

        private void initTagParsers()
        Deprecated.
        See Also:
        Javadoc Tags
      • initEventAttrs

        private void initEventAttrs()
        Deprecated.
      • initURIAttrs

        private void initURIAttrs()
        Deprecated.