class ScaladocJavaUnitParser extends JavaUnitParser

Source
ScaladocAnalyzer.scala
Linear Supertypes
ScaladocSyntaxAnalyzer.JavaUnitParser, ScaladocSyntaxAnalyzer.JavaParser, ScaladocSyntaxAnalyzer.ParserCommon, AnyRef, Any
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ScaladocJavaUnitParser
  2. JavaUnitParser
  3. JavaParser
  4. ParserCommon
  5. AnyRef
  6. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new ScaladocJavaUnitParser(unit: G.CompilationUnit)

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. def +(other: String): String
    Implicit
    This member is added by an implicit conversion from ScaladocJavaUnitParser toany2stringadd[ScaladocJavaUnitParser] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (ScaladocJavaUnitParser, B)
    Implicit
    This member is added by an implicit conversion from ScaladocJavaUnitParser toArrowAssoc[ScaladocJavaUnitParser] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. def accept(token: Int): Int

    Consume one token of the specified type, or signal an error if it is not there.

    Consume one token of the specified type, or signal an error if it is not there.

    Definition Classes
    JavaParser → ParserCommon
  7. def acceptClosingAngle(): Unit
    Definition Classes
    JavaParser
  8. def adaptRecordIdentifier(): Unit

    If the next token is the identifier "record", convert it into a proper token.

    If the next token is the identifier "record", convert it into a proper token. Technically, "record" is just a restricted identifier. However, once we've figured out that it is in a position where it identifies a "record" class, it is much more convenient to promote it to a token.

    Definition Classes
    JavaParser
  9. def addCompanionObject(statics: List[G.Tree], cdef: G.ClassDef): List[G.Tree]
    Definition Classes
    JavaParser
  10. def annotation(): G.Tree

    Annotation ::= NormalAnnotation | MarkerAnnotation | SingleElementAnnotation

    Annotation ::= NormalAnnotation | MarkerAnnotation | SingleElementAnnotation

    NormalAnnotation ::= @ TypeName ( [ElementValuePairList] ) ElementValuePairList ::= ElementValuePair {, ElementValuePair} ElementValuePair ::= Identifier = ElementValue ElementValue ::= ConditionalExpressionSubset | ElementValueArrayInitializer | Annotation

    // We only support a subset of the Java syntax that can form constant expressions. // https://docs.oracle.com/javase/specs/jls/se14/html/jls-15.html#jls-15.29 // // Luckily, we can just parse matching ( and ) to find our way to the end of the the argument list. // and drop the arguments until we implement full support for Java constant expressions // ConditionalExpressionSubset := Literal | Identifier | QualifiedName | ClassLiteral

    ElementValueArrayInitializer ::= { [ElementValueList] [,] } ElementValueList ::= ElementValue {, ElementValue}

    Definition Classes
    JavaParser
  11. def annotationDecl(mods: G.Modifiers): List[G.Tree]
    Definition Classes
    JavaParser
  12. def annotationParents: collection.immutable.List[G.Select]
    Definition Classes
    JavaParser
  13. def annotations(): List[G.Tree]
    Definition Classes
    JavaParser
  14. def arrayOf(tpt: G.Tree): G.AppliedTypeTree
    Definition Classes
    JavaParser
  15. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  16. def basicType(): G.Tree
    Definition Classes
    JavaParser
  17. def blankExpr: EmptyTree
    Definition Classes
    JavaParser
  18. def bound(): G.Tree
    Definition Classes
    JavaParser
  19. def classDecl(mods: G.Modifiers): List[G.Tree]
    Definition Classes
    JavaParser
  20. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  21. final def commaSeparated[T](part: => T): List[T]

    , with the separator fixed to commas.

    tokenSeparated

    , with the separator fixed to commas.

    Definition Classes
    ParserCommon
    Annotations
    @inline()
  22. def compilationUnit(): G.Tree

    CompilationUnit ::= [package QualId semi] TopStatSeq

    CompilationUnit ::= [package QualId semi] TopStatSeq

    Definition Classes
    JavaParser
  23. def convertToTypeId(tree: G.Tree): G.Tree

    Convert (qual)ident to type identifier

    Convert (qual)ident to type identifier

    Definition Classes
    JavaParser
  24. def definesInterface(token: Int): Boolean
    Definition Classes
    JavaParser
  25. def deprecationWarning(off: Int, msg: String, since: String, actions: List[CodeAction]): Unit
    Definition Classes
    JavaUnitParser → ParserCommon
  26. final def dropAnyBraces[T](body: => T): T
    Definition Classes
    ParserCommon
    Annotations
    @inline()
  27. def ensuring(cond: (ScaladocJavaUnitParser) => Boolean, msg: => Any): ScaladocJavaUnitParser
    Implicit
    This member is added by an implicit conversion from ScaladocJavaUnitParser toEnsuring[ScaladocJavaUnitParser] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  28. def ensuring(cond: (ScaladocJavaUnitParser) => Boolean): ScaladocJavaUnitParser
    Implicit
    This member is added by an implicit conversion from ScaladocJavaUnitParser toEnsuring[ScaladocJavaUnitParser] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  29. def ensuring(cond: Boolean, msg: => Any): ScaladocJavaUnitParser
    Implicit
    This member is added by an implicit conversion from ScaladocJavaUnitParser toEnsuring[ScaladocJavaUnitParser] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  30. def ensuring(cond: Boolean): ScaladocJavaUnitParser
    Implicit
    This member is added by an implicit conversion from ScaladocJavaUnitParser toEnsuring[ScaladocJavaUnitParser] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  31. def enumConst(enumType: G.Tree): (G.ValDef, Boolean)
    Definition Classes
    JavaParser
  32. def enumDecl(mods: G.Modifiers): List[G.Tree]
    Definition Classes
    JavaParser
  33. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  34. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  35. def errorTypeTree: G.TypeTree
    Definition Classes
    JavaParser
  36. def fieldDecls(pos: G.Position, mods: G.Modifiers, tpt: G.Tree, name: G.Name): List[G.Tree]

    Parse a sequence of field declarations, separated by commas.

    Parse a sequence of field declarations, separated by commas. This one is tricky because a comma might also appear in an initializer. Since we don't parse initializers we don't know what the comma signifies. We solve this with a second list buffer maybe which contains potential variable definitions. Once we have reached the end of the statement, we know whether these potential definitions are real or not.

    Definition Classes
    JavaParser
  37. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  38. def formalParam(): G.ValDef
    Definition Classes
    JavaParser
  39. def formalParams(): List[G.ValDef]
    Definition Classes
    JavaParser
  40. def freshName(prefix: String): G.Name
    Definition Classes
    JavaUnitParser → JavaParser
  41. def freshTermName(prefix: String): G.TermName
    Definition Classes
    JavaUnitParser
  42. def freshTypeName(prefix: String): G.TypeName
    Definition Classes
    JavaUnitParser
  43. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  44. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  45. implicit def i2p(offset: Int): G.Position
    Definition Classes
    JavaUnitParser → JavaParser
  46. def ident(): G.Name
    Definition Classes
    JavaParser
  47. def identForType(): G.TypeName
    Definition Classes
    JavaParser
  48. def importDecl(): List[G.Tree]
    Definition Classes
    JavaParser
  49. val in: ScaladocJavaUnitScanner
    Definition Classes
    ScaladocJavaUnitParser → JavaUnitParser → JavaParser → ParserCommon
  50. final def inBraces[T](body: => T): T
    Definition Classes
    ParserCommon
    Annotations
    @inline()
  51. final def inBracesOrError[T](body: => T, alt: T): T
    Definition Classes
    ParserCommon
    Annotations
    @inline()
  52. final def inBracesOrNil[T](body: => List[T]): List[T]
    Definition Classes
    ParserCommon
    Annotations
    @inline()
  53. final def inBracesOrUnit[T](body: => G.Tree): G.Tree
    Definition Classes
    ParserCommon
    Annotations
    @inline()
  54. final def inBrackets[T](body: => T): T
    Definition Classes
    ParserCommon
    Annotations
    @inline()
  55. final def inGroupers[T](left: ScaladocSyntaxAnalyzer.Token)(body: => T): T

    Methods inParensOrError and similar take a second argument which, should the next token not be the expected opener (e.g.

    Methods inParensOrError and similar take a second argument which, should the next token not be the expected opener (e.g. LPAREN) will be returned instead of the contents of the groupers. However in all cases accept(LPAREN) will be called, so a parse error will still result. If the grouping is optional, in.token should be tested before calling these methods.

    Skip trailing comma is pushed down to scanner because this abstract parser doesn't have token info.

    Definition Classes
    ParserCommon
    Annotations
    @inline()
  56. final def inParens[T](body: => T): T
    Definition Classes
    ParserCommon
    Annotations
    @inline()
  57. final def inParensOrError[T](body: => T, alt: T): T
    Definition Classes
    ParserCommon
    Annotations
    @inline()
  58. final def inParensOrNil[T](body: => List[T]): List[T]
    Definition Classes
    ParserCommon
    Annotations
    @inline()
  59. final def inParensOrUnit[T](body: => G.Tree): G.Tree
    Definition Classes
    ParserCommon
    Annotations
    @inline()
  60. def interfaceDecl(mods: G.Modifiers): List[G.Tree]
    Definition Classes
    JavaParser
  61. def interfacesOpt(): List[G.Tree]
    Definition Classes
    JavaParser
  62. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  63. def javaDot(name: G.Name): G.Tree
    Definition Classes
    JavaParser
  64. def javaLangDot(name: G.Name): G.Tree
    Definition Classes
    JavaParser
  65. def javaLangObject(): G.Tree
    Definition Classes
    JavaParser
  66. def javaLangRecord(): G.Tree
    Definition Classes
    JavaParser
  67. def joinComment(trees: => List[G.Tree]): List[G.Tree]

    A hook for joining the comment associated with a definition.

    A hook for joining the comment associated with a definition. Overridden by scaladoc.

    Definition Classes
    ScaladocJavaUnitParser → JavaParser
  68. def makeCompanionObject(cdef: G.ClassDef, statics: List[G.Tree]): G.Tree
    Definition Classes
    JavaParser
  69. def makeConstructor(formals: List[G.Tree]): G.DefDef
    Definition Classes
    JavaParser
  70. def makePackaging(pkg: G.RefTree, stats: List[G.Tree]): G.PackageDef
    Definition Classes
    JavaParser
  71. def makeParam(name: G.TermName, tpt: G.Tree): G.ValDef
    Definition Classes
    JavaParser
  72. def makeParam(name: String, tpt: G.Tree): G.ValDef
    Definition Classes
    JavaParser
  73. final def makeParens(body: => List[G.Tree]): G.Parens

    Creates an actual Parens node (only used during parsing.)

    Creates an actual Parens node (only used during parsing.)

    Definition Classes
    ParserCommon
    Annotations
    @inline()
  74. def makeSyntheticParam(count: Int, tpt: G.Tree): G.ValDef
    Definition Classes
    JavaParser
  75. def makeTemplate(parents: List[G.Tree], stats: List[G.Tree]): G.Template
    Definition Classes
    JavaParser
  76. def memberDecl(mods: G.Modifiers, parentToken: Int): List[G.Tree]
    Definition Classes
    JavaParser
  77. def methodBody(): G.Tree
    Definition Classes
    JavaParser
  78. def modifiers(inInterface: Boolean): G.Modifiers
    Definition Classes
    JavaParser
  79. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  80. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  81. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  82. final def optArrayBrackets(tpt: G.Tree): G.Tree
    Definition Classes
    JavaParser
    Annotations
    @tailrec()
  83. def optThrows(): Unit
    Definition Classes
    JavaParser
  84. def parse(): G.Tree

    this is the general parse method

    this is the general parse method

    Definition Classes
    JavaParser
  85. def permitsOpt(): List[G.Tree]
    Definition Classes
    JavaParser
  86. def qualId(orClassLiteral: Boolean = false): G.Tree
    Definition Classes
    JavaParser
  87. def recordDecl(mods: G.Modifiers): List[G.Tree]
    Definition Classes
    JavaParser
  88. def repsep[T <: G.Tree](p: () => T, sep: Int): List[T]
    Definition Classes
    JavaParser
  89. def separatedToken[T](separator: ScaladocSyntaxAnalyzer.Token, part: => T): List[T]

    .

    { `sep` part }

    .

    Definition Classes
    ParserCommon
  90. def skip(): Unit
    Attributes
    protected
    Definition Classes
    JavaParser
  91. def skipAhead(): Unit

    skip parent or brace enclosed sequence of things

    skip parent or brace enclosed sequence of things

    Definition Classes
    JavaParser
  92. def skipTo(tokens: Int*): Unit
    Definition Classes
    JavaParser
  93. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  94. def syntaxError(pos: Int, msg: String): Unit
    Definition Classes
    JavaUnitParser → JavaParser
  95. def syntaxError(pos: Int, msg: String, skipIt: Boolean): Unit
    Definition Classes
    JavaParser
  96. def syntaxError(msg: String, skipIt: Boolean): Unit
    Definition Classes
    JavaParser
  97. def termDecl(mods: G.Modifiers, parentToken: Int): List[G.Tree]
    Definition Classes
    JavaParser
  98. def toString(): String
    Definition Classes
    AnyRef → Any
  99. def tokenSeparated[T](separator: ScaladocSyntaxAnalyzer.Token, part: => T): List[T]

    .

    { `sep` part }

    .

    Definition Classes
    ParserCommon
  100. def tryLiteral(negate: Boolean = false): Option[G.Constant]
    Definition Classes
    JavaParser
  101. def typ(): G.Tree
    Definition Classes
    JavaParser
  102. def typeArgs(t: G.Tree): G.Tree
    Definition Classes
    JavaParser
  103. def typeBody(leadingToken: Int): (List[G.Tree], List[G.Tree])
    Definition Classes
    JavaParser
  104. def typeBodyDecls(parentToken: Int): (List[G.Tree], List[G.Tree])
    Definition Classes
    JavaParser
  105. def typeDecl(mods: G.Modifiers): List[G.Tree]
    Definition Classes
    JavaParser
  106. def typeParam(): G.TypeDef
    Definition Classes
    JavaParser
  107. def typeParams(): List[G.TypeDef]
    Definition Classes
    JavaParser
  108. val unit: G.CompilationUnit
    Definition Classes
    JavaUnitParser → JavaParser
  109. def varDecl(pos: G.Position, mods: G.Modifiers, tpt: G.Tree, name: G.TermName): G.ValDef
    Definition Classes
    JavaParser
  110. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  111. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  112. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  113. def warning(pos: Int, msg: String): Unit
    Definition Classes
    JavaUnitParser → JavaParser

Deprecated Value Members

  1. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from ScaladocJavaUnitParser toStringFormat[ScaladocJavaUnitParser] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @deprecated @inline()
    Deprecated

    (Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString), or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.

  2. def →[B](y: B): (ScaladocJavaUnitParser, B)
    Implicit
    This member is added by an implicit conversion from ScaladocJavaUnitParser toArrowAssoc[ScaladocJavaUnitParser] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.

Inherited from ScaladocSyntaxAnalyzer.JavaUnitParser

Inherited from ScaladocSyntaxAnalyzer.JavaParser

Inherited from ScaladocSyntaxAnalyzer.ParserCommon

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd fromScaladocJavaUnitParser to any2stringadd[ScaladocJavaUnitParser]

Inherited by implicit conversion StringFormat fromScaladocJavaUnitParser to StringFormat[ScaladocJavaUnitParser]

Inherited by implicit conversion Ensuring fromScaladocJavaUnitParser to Ensuring[ScaladocJavaUnitParser]

Inherited by implicit conversion ArrowAssoc fromScaladocJavaUnitParser to ArrowAssoc[ScaladocJavaUnitParser]

Ungrouped