c

scala.tools.nsc.doc.ScaladocSyntaxAnalyzer

ScaladocJavaUnitParser

class ScaladocJavaUnitParser extends JavaUnitParser

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. All

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 to any2stringadd[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 to ArrowAssoc[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 addCompanionObject(statics: List[G.Tree], cdef: G.ClassDef): List[G.Tree]
    Definition Classes
    JavaParser
  9. 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
  10. def annotationDecl(mods: G.Modifiers): List[G.Tree]
    Definition Classes
    JavaParser
  11. def annotationParents: collection.immutable.List[G.Select]
    Definition Classes
    JavaParser
  12. def annotations(): List[G.Tree]
    Definition Classes
    JavaParser
  13. def arrayOf(tpt: G.Tree): G.AppliedTypeTree
    Definition Classes
    JavaParser
  14. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  15. def basicType(): G.Tree
    Definition Classes
    JavaParser
  16. def blankExpr: G.EmptyTree.type
    Definition Classes
    JavaParser
  17. def bound(): G.Tree
    Definition Classes
    JavaParser
  18. def classDecl(mods: G.Modifiers): List[G.Tree]
    Definition Classes
    JavaParser
  19. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  20. final def commaSeparated[T](part: ⇒ T): List[T]

    , with the separator fixed to commas.

    tokenSeparated

    , with the separator fixed to commas. tokenSeparated }}}

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

    CompilationUnit ::= [package QualId semi] TopStatSeq

    CompilationUnit ::= [package QualId semi] TopStatSeq

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

    Convert (qual)ident to type identifier

    Convert (qual)ident to type identifier

    Definition Classes
    JavaParser
  23. def definesInterface(token: Int): Boolean
    Definition Classes
    JavaParser
  24. def deprecationWarning(off: Int, msg: String, since: String): Unit
    Definition Classes
    JavaUnitParser → ParserCommon
  25. final def dropAnyBraces[T](body: ⇒ T): T
    Definition Classes
    ParserCommon
    Annotations
    @inline()
  26. def ensuring(cond: (ScaladocJavaUnitParser) ⇒ Boolean, msg: ⇒ Any): ScaladocJavaUnitParser
    Implicit
    This member is added by an implicit conversion from ScaladocJavaUnitParser to Ensuring[ScaladocJavaUnitParser] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  27. def ensuring(cond: (ScaladocJavaUnitParser) ⇒ Boolean): ScaladocJavaUnitParser
    Implicit
    This member is added by an implicit conversion from ScaladocJavaUnitParser to Ensuring[ScaladocJavaUnitParser] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  28. def ensuring(cond: Boolean, msg: ⇒ Any): ScaladocJavaUnitParser
    Implicit
    This member is added by an implicit conversion from ScaladocJavaUnitParser to Ensuring[ScaladocJavaUnitParser] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  29. def ensuring(cond: Boolean): ScaladocJavaUnitParser
    Implicit
    This member is added by an implicit conversion from ScaladocJavaUnitParser to Ensuring[ScaladocJavaUnitParser] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  30. def enumConst(enumType: G.Tree): (G.ValDef, Boolean)
    Definition Classes
    JavaParser
  31. def enumDecl(mods: G.Modifiers): List[G.Tree]
    Definition Classes
    JavaParser
  32. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  33. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  34. def errorTypeTree: G.TypeTree
    Definition Classes
    JavaParser
  35. 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
  36. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  37. def formalParam(): G.ValDef
    Definition Classes
    JavaParser
  38. def formalParams(): List[G.ValDef]
    Definition Classes
    JavaParser
  39. def freshName(prefix: String): G.Name
    Definition Classes
    JavaUnitParser → JavaParser
  40. def freshTermName(prefix: String): G.TermName
    Definition Classes
    JavaUnitParser
  41. def freshTypeName(prefix: String): G.TypeName
    Definition Classes
    JavaUnitParser
  42. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  43. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  44. implicit def i2p(offset: Int): G.Position
    Definition Classes
    JavaUnitParser → JavaParser
  45. def ident(): G.Name
    Definition Classes
    JavaParser
  46. def identForType(): G.TypeName
    Definition Classes
    JavaParser
  47. def importCompanionObject(cdef: G.ClassDef): G.Tree
    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 inParens[T](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.

    Definition Classes
    ParserCommon
    Annotations
    @inline()
  56. final def inParensOrError[T](body: ⇒ T, alt: T): T
    Definition Classes
    ParserCommon
    Annotations
    @inline()
  57. final def inParensOrNil[T](body: ⇒ List[T]): List[T]
    Definition Classes
    ParserCommon
    Annotations
    @inline()
  58. final def inParensOrUnit[T](body: ⇒ G.Tree): G.Tree
    Definition Classes
    ParserCommon
    Annotations
    @inline()
  59. def interfaceDecl(mods: G.Modifiers): List[G.Tree]
    Definition Classes
    JavaParser
  60. def interfacesOpt(): List[G.Tree]
    Definition Classes
    JavaParser
  61. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  62. def javaDot(name: G.Name): G.Tree
    Definition Classes
    JavaParser
  63. def javaLangDot(name: G.Name): G.Tree
    Definition Classes
    JavaParser
  64. def javaLangObject(): G.Tree
    Definition Classes
    JavaParser
  65. 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
  66. def makeCompanionObject(cdef: G.ClassDef, statics: List[G.Tree]): G.Tree
    Definition Classes
    JavaParser
  67. def makeConstructor(formals: List[G.Tree]): G.DefDef
    Definition Classes
    JavaParser
  68. def makePackaging(pkg: G.RefTree, stats: List[G.Tree]): G.PackageDef
    Definition Classes
    JavaParser
  69. def makeParam(name: G.TermName, tpt: G.Tree): G.ValDef
    Definition Classes
    JavaParser
  70. def makeParam(name: String, tpt: G.Tree): G.ValDef
    Definition Classes
    JavaParser
  71. 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()
  72. def makeSyntheticParam(count: Int, tpt: G.Tree): G.ValDef
    Definition Classes
    JavaParser
  73. def makeTemplate(parents: List[G.Tree], stats: List[G.Tree]): G.Template
    Definition Classes
    JavaParser
  74. def memberDecl(mods: G.Modifiers, parentToken: Int): List[G.Tree]
    Definition Classes
    JavaParser
  75. def methodBody(): G.Tree
    Definition Classes
    JavaParser
  76. def modifiers(inInterface: Boolean): G.Modifiers
    Definition Classes
    JavaParser
  77. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  78. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  79. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  80. def optArrayBrackets(tpt: G.Tree): G.Tree
    Definition Classes
    JavaParser
  81. def optThrows(): Unit
    Definition Classes
    JavaParser
  82. def parse(): G.Tree

    this is the general parse method

    this is the general parse method

    Definition Classes
    JavaParser
  83. def qualId(orClassLiteral: Boolean = false): G.Tree
    Definition Classes
    JavaParser
  84. def repsep[T <: G.Tree](p: () ⇒ T, sep: Int): List[T]
    Definition Classes
    JavaParser
  85. def skip(): Unit
    Attributes
    protected
    Definition Classes
    JavaParser
  86. def skipAhead(): Unit

    skip parent or brace enclosed sequence of things

    skip parent or brace enclosed sequence of things

    Definition Classes
    JavaParser
  87. def skipTo(tokens: Int*): Unit
    Definition Classes
    JavaParser
  88. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  89. def syntaxError(pos: Int, msg: String): Unit
    Definition Classes
    JavaUnitParser → JavaParser
  90. def syntaxError(pos: Int, msg: String, skipIt: Boolean): Unit
    Definition Classes
    JavaParser
  91. def syntaxError(msg: String, skipIt: Boolean): Unit
    Definition Classes
    JavaParser
  92. def termDecl(mods: G.Modifiers, parentToken: Int): List[G.Tree]
    Definition Classes
    JavaParser
  93. def toString(): String
    Definition Classes
    AnyRef → Any
  94. final def tokenSeparated[T](separator: ScaladocSyntaxAnalyzer.Token, sepFirst: Boolean, part: ⇒ T): List[T]

    , or if sepFirst is true, 

    part { `sep` part }

    , or if sepFirst is true, 

    { `sep` part }

    . { sep part } }}} part { sep part } }}}

    Definition Classes
    ParserCommon
  95. def tryLiteral(negate: Boolean = false): Option[G.Constant]
    Definition Classes
    JavaParser
  96. def typ(): G.Tree
    Definition Classes
    JavaParser
  97. def typeArgs(t: G.Tree): G.Tree
    Definition Classes
    JavaParser
  98. def typeBody(leadingToken: Int, parentName: G.Name): (List[G.Tree], List[G.Tree])
    Definition Classes
    JavaParser
  99. def typeBodyDecls(parentToken: Int, parentName: G.Name): (List[G.Tree], List[G.Tree])
    Definition Classes
    JavaParser
  100. def typeDecl(mods: G.Modifiers): List[G.Tree]
    Definition Classes
    JavaParser
  101. def typeParam(): G.TypeDef
    Definition Classes
    JavaParser
  102. def typeParams(): List[G.TypeDef]
    Definition Classes
    JavaParser
  103. val unit: G.CompilationUnit
    Definition Classes
    JavaUnitParser
  104. def varDecl(pos: G.Position, mods: G.Modifiers, tpt: G.Tree, name: G.TermName): G.ValDef
    Definition Classes
    JavaParser
  105. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  106. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  107. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  108. def warning(pos: Int, msg: String): Unit
    Definition Classes
    JavaUnitParser → JavaParser
  109. def →[B](y: B): (ScaladocJavaUnitParser, B)
    Implicit
    This member is added by an implicit conversion from ScaladocJavaUnitParser to ArrowAssoc[ScaladocJavaUnitParser] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Deprecated Value Members

  1. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from ScaladocJavaUnitParser to StringFormat[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.

Inherited from ScaladocSyntaxAnalyzer.JavaUnitParser

Inherited from ScaladocSyntaxAnalyzer.JavaParser

Inherited from ScaladocSyntaxAnalyzer.ParserCommon

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from ScaladocJavaUnitParser to any2stringadd[ScaladocJavaUnitParser]

Inherited by implicit conversion StringFormat from ScaladocJavaUnitParser to StringFormat[ScaladocJavaUnitParser]

Inherited by implicit conversion Ensuring from ScaladocJavaUnitParser to Ensuring[ScaladocJavaUnitParser]

Inherited by implicit conversion ArrowAssoc from ScaladocJavaUnitParser to ArrowAssoc[ScaladocJavaUnitParser]

Ungrouped