Scala Compiler 2.13.16 - scala.tools.nsc.doc.ScaladocSyntaxAnalyzer.ScaladocJavaUnitScanner
Keywords: Scala Compiler 2.13.16 scala.tools.nsc.doc.ScaladocSyntaxAnalyzer.ScaladocJavaUnitScanner

Scala Compiler2.13.16 < Back


# Packages

-  package root

  The Scala compiler and reflection APIs.

  The Scala compiler and reflection APIs.

  Definition Classes
    root
-  package scala
  Definition Classes
    root
-  package tools
  Definition Classes
    scala
-  package nsc
  Definition Classes
    tools
-  package doc
  Definition Classes
    nsc
-  abstract class ScaladocSyntaxAnalyzer[G <: Global] extends SyntaxAnalyzer
  Definition Classes
    doc
- AbstractJavaScanner
- AbstractJavaTokenData
- CommonTokenData
- ConfusedAboutBracesControl
- DocScanner
- JavaOpInfo
- JavaParser
- JavaScanner
- JavaScannerConfiguration
- JavaTokenData
- JavaUnitParser
- JavaUnitScanner
- MalformedInput
- MarkupParser
- MemberDefTraverser
- MemberPosReporter
- MissingEndTagControl
- OpInfo
- OutlineParser
- ParamOwner
- ParensAnalyzer
- Parser
- ParserCommon
- ParserPhase
- ScaladocJavaUnitParser
- ScaladocJavaUnitScanner
- ScaladocScanner
- ScaladocUnitParser
- ScaladocUnitScanner
- Scanner
- ScannerCommon
- ScannerData
- SourceFileParser
- SourceFileScanner
- StdPhase
- TokenData
- TruncatedXMLControl
- UnitParser
- UnitScanner

c

scala.tools.nsc.doc.ScaladocSyntaxAnalyzer

# ScaladocJavaUnitScanner

###

#### class ScaladocJavaUnitScanner extends JavaUnitScanner with ScaladocScanner

Source
  ScaladocAnalyzer.scala

Linear Supertypes
ScaladocScanner, ScaladocSyntaxAnalyzer.JavaUnitScanner, ScaladocSyntaxAnalyzer.JavaScanner, ScaladocSyntaxAnalyzer.DocScanner, ScaladocSyntaxAnalyzer.ScannerCommon, ScaladocSyntaxAnalyzer.CommonTokenData, java.lang.Cloneable, ScaladocSyntaxAnalyzer.JavaTokenData, ScaladocSyntaxAnalyzer.AbstractJavaScanner, ScaladocSyntaxAnalyzer.AbstractJavaTokenData, AnyRef, Any
Type Hierarchy

Ordering

1. Alphabetic
2. By Inheritance

Inherited

1. ScaladocJavaUnitScanner
2. ScaladocScanner
3. JavaUnitScanner
4. JavaScanner
5. DocScanner
6. ScannerCommon
7. CommonTokenData
8. Cloneable
9. JavaTokenData
10. AbstractJavaScanner
11. AbstractJavaTokenData
12. AnyRef
13. 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 ScaladocJavaUnitScanner(unit: G.CompilationUnit)

### Type Members

1.  type ScanPosition = Int
   Definition Classes
     JavaTokenData → AbstractJavaTokenData

### 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 ScaladocJavaUnitScanner toany2stringadd[ScaladocJavaUnitScanner] performed by method any2stringadd in scala.Predef.
   Definition Classes
     any2stringadd
4.  def ->[B](y: B): (ScaladocJavaUnitScanner, B)
   Implicit
     This member is added by an implicit conversion from ScaladocJavaUnitScanner toArrowAssoc[ScaladocJavaUnitScanner] performed by method ArrowAssoc in scala.Predef.
   Definition Classes
     ArrowAssoc
   Annotations
     @inline()
5.  final def ==(arg0: Any): Boolean
   Definition Classes
     AnyRef → Any
6.  val NoPos: Int
   Definition Classes
     JavaTokenData → AbstractJavaTokenData
7.  final def asInstanceOf[T0]: T0
   Definition Classes
     Any
8.  val base: Int

   the base of a number

   the base of a number

   Definition Classes
     JavaTokenData
9.  def beginDocComment(prefix: String): Unit
   Attributes
     protected
   Definition Classes
     ScaladocJavaUnitScanner → ScaladocScanner → DocScanner
10.  val cbuf: collection.mutable.StringBuilder

    character buffer for literals

    character buffer for literals

    Definition Classes
      JavaScanner
11.  def ch: Char
    Attributes
      protected
    Definition Classes
      ScaladocJavaUnitScanner → ScaladocScanner
12.  def clone(): AnyRef
    Attributes
      protected[lang]
    Definition Classes
      AnyRef
    Annotations
      @throws(classOf[java.lang.CloneNotSupportedException]) @native()
13.  def copyFrom(td: ScaladocSyntaxAnalyzer.JavaTokenData): ScaladocJavaUnitScanner.this.type
    Definition Classes
      JavaTokenData
14.  def currentPos: G.Position
    Definition Classes
      JavaScanner → AbstractJavaScanner
15.  def deprecationWarning(pos: Int, msg: String, since: String, actions: List[CodeAction]): Unit
    Definition Classes
      JavaUnitScanner → ScannerCommon
16.  def discardDocBuffer(): Unit

    To prevent doc comments attached to expressions from leaking out of scope onto the next documentable entity, they are discarded upon passing a right brace, bracket, or parenthesis.

    To prevent doc comments attached to expressions from leaking out of scope onto the next documentable entity, they are discarded upon passing a right brace, bracket, or parenthesis.

    Definition Classes
      DocScanner
17.  def docPosition: Position
    Attributes
      protected
    Definition Classes
      ScaladocJavaUnitScanner → ScaladocScanner
18.  def ensuring(cond: (ScaladocJavaUnitScanner) => Boolean, msg: => Any): ScaladocJavaUnitScanner
    Implicit
      This member is added by an implicit conversion from ScaladocJavaUnitScanner toEnsuring[ScaladocJavaUnitScanner] performed by method Ensuring in scala.Predef.
    Definition Classes
      Ensuring
19.  def ensuring(cond: (ScaladocJavaUnitScanner) => Boolean): ScaladocJavaUnitScanner
    Implicit
      This member is added by an implicit conversion from ScaladocJavaUnitScanner toEnsuring[ScaladocJavaUnitScanner] performed by method Ensuring in scala.Predef.
    Definition Classes
      Ensuring
20.  def ensuring(cond: Boolean, msg: => Any): ScaladocJavaUnitScanner
    Implicit
      This member is added by an implicit conversion from ScaladocJavaUnitScanner toEnsuring[ScaladocJavaUnitScanner] performed by method Ensuring in scala.Predef.
    Definition Classes
      Ensuring
21.  def ensuring(cond: Boolean): ScaladocJavaUnitScanner
    Implicit
      This member is added by an implicit conversion from ScaladocJavaUnitScanner toEnsuring[ScaladocJavaUnitScanner] performed by method Ensuring in scala.Predef.
    Definition Classes
      Ensuring
22.  final def eq(arg0: AnyRef): Boolean
    Definition Classes
      AnyRef
23.  def equals(arg0: AnyRef): Boolean
    Definition Classes
      AnyRef → Any
24.  def error(pos: Int, msg: String): Unit
    Definition Classes
      JavaUnitScanner → ScannerCommon
25.  def finalize(): Unit
    Attributes
      protected[lang]
    Definition Classes
      AnyRef
    Annotations
      @throws(classOf[java.lang.Throwable])
26.  def finishDocComment(): Unit
    Attributes
      protected
    Definition Classes
      ScaladocScanner → DocScanner
27.  def floatVal(negated: Boolean): Double

    convert name, base to double value

    convert name, base to double value

    Definition Classes
      JavaScanner → AbstractJavaScanner
28.  def floatVal: Double
    Definition Classes
      JavaScanner → AbstractJavaScanner
29.  def flushDoc(): G.DocComment
    Definition Classes
      DocScanner
30.  implicit def g2p(pos: Int): G.Position
    Definition Classes
      JavaUnitScanner → AbstractJavaScanner
31.  final def getClass(): Class[_ <: AnyRef]
    Definition Classes
      AnyRef → Any
    Annotations
      @native()
32.  def getFraction(): Unit

    read fractional part and exponent of floating point number if one is present.

    read fractional part and exponent of floating point number if one is present.

    Attributes
      protected
    Definition Classes
      JavaScanner
33.  def getNumber(): Unit

    read a number into name and set base

    read a number into name and set base

    Attributes
      protected
    Definition Classes
      JavaScanner
34.  def getlitch(scanOnly: Boolean = false, inTextBlock: Boolean = false): Unit

    read next character in character or string literal:

    read next character in character or string literal:

    scanOnly

      skip emitting errors or adding to the literal buffer

    inTextBlock

      is this for a text block?

    Attributes
      protected
    Definition Classes
      JavaScanner
35.  def hashCode(): Int
    Definition Classes
      AnyRef → Any
    Annotations
      @native()
36.  var in: JavaCharArrayReader
    Definition Classes
      JavaScanner
37.  def incompleteInputError(pos: Int, msg: String): Unit
    Definition Classes
      JavaUnitScanner → ScannerCommon
38.  def incompleteInputError(msg: String): Unit

    signal an error where the input ended in the middle of a token

    signal an error where the input ended in the middle of a token

    Definition Classes
      JavaScanner
39.  def init(): Unit

    INIT: read lookahead character and token.

    INIT: read lookahead character and token.

    Definition Classes
      JavaScanner
40.  def intVal(negated: Boolean): Long

    convert name to long value

    convert name to long value

    Definition Classes
      JavaScanner → AbstractJavaScanner
41.  def intVal: Long
    Definition Classes
      JavaScanner → AbstractJavaScanner
42.  final def isInstanceOf[T0]: Boolean
    Definition Classes
      Any
43.  val lastPos: Int

    the first character position after the previous token

    the first character position after the previous token

    Definition Classes
      JavaTokenData
44.  def lookaheadToken: Int
    Definition Classes
      JavaScanner
45.  val name: G.TermName

    the name of an identifier or token

    the name of an identifier or token

    Definition Classes
      JavaTokenData → AbstractJavaTokenData
46.  final def ne(arg0: AnyRef): Boolean
    Definition Classes
      AnyRef
47.  val next: ScaladocSyntaxAnalyzer.JavaTokenData

    we need one token lookahead

    we need one token lookahead

    Definition Classes
      JavaScanner → AbstractJavaScanner
48.  def nextToken(): Unit

    Consume and discard the next token.

    Consume and discard the next token.

    Definition Classes
      JavaScanner → ScannerCommon → AbstractJavaScanner
49.  final def notify(): Unit
    Definition Classes
      AnyRef
    Annotations
      @native()
50.  final def notifyAll(): Unit
    Definition Classes
      AnyRef
    Annotations
      @native()
51.  val pos: Int

    the token's position

    the token's position

    Definition Classes
      JavaTokenData → AbstractJavaTokenData
52.  val prev: ScaladocSyntaxAnalyzer.JavaTokenData
    Definition Classes
      JavaScanner
53.  def processCommentChar(): Unit
    Attributes
      protected
    Definition Classes
      ScaladocScanner → DocScanner
54.  def putChar(c: Char): Unit

    append Unicode character to "lit" buffer

    append Unicode character to "lit" buffer

    Attributes
      protected
    Definition Classes
      JavaScanner
55.  final def putCommentChar(): Unit
    Attributes
      protected
    Definition Classes
      JavaScanner
56.  def registerDocComment(raw: String, pos: G.Position): Unit
    Definition Classes
      DocScanner
57.  final def skipBlockComment(isDoc: Boolean): Unit
    Attributes
      protected
    Definition Classes
      JavaScanner
    Annotations
      @tailrec()
58.  final def skipComment(): Boolean
    Attributes
      protected
    Definition Classes
      JavaScanner
59.  final def skipLineComment(): Unit
    Attributes
      protected
    Definition Classes
      JavaScanner
    Annotations
      @tailrec()
60.  def skipTrailingComma(right: ScaladocSyntaxAnalyzer.Token): Boolean
    Definition Classes
      ScannerCommon
61.  final def synchronized[T0](arg0: => T0): T0
    Definition Classes
      AnyRef
62.  def syntaxError(msg: String): Unit

    generate an error at the current token position

    generate an error at the current token position

    Definition Classes
      JavaScanner
63.  def syntaxError(pos: Int, msg: String): Unit

    generate an error at the given position

    generate an error at the given position

    Definition Classes
      JavaScanner
64.  def toString(): String
    Definition Classes
      JavaScanner → AnyRef → Any
65.  val token: Int

    the next token

    the next token

    Definition Classes
      JavaTokenData → AbstractJavaTokenData
66.  final def wait(): Unit
    Definition Classes
      AnyRef
    Annotations
      @throws(classOf[java.lang.InterruptedException])
67.  final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
      AnyRef
    Annotations
      @throws(classOf[java.lang.InterruptedException])
68.  final def wait(arg0: Long): Unit
    Definition Classes
      AnyRef
    Annotations
      @throws(classOf[java.lang.InterruptedException]) @native()
69.  def warning(pos: Int, msg: String, category: WarningCategory): Unit
    Definition Classes
      JavaUnitScanner → ScannerCommon

### Deprecated Value Members

1.  def formatted(fmtstr: String): String
   Implicit
     This member is added by an implicit conversion from ScaladocJavaUnitScanner toStringFormat[ScaladocJavaUnitScanner] 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): (ScaladocJavaUnitScanner, B)
   Implicit
     This member is added by an implicit conversion from ScaladocJavaUnitScanner toArrowAssoc[ScaladocJavaUnitScanner] 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 ScaladocScanner

### Inherited from ScaladocSyntaxAnalyzer.JavaUnitScanner

### Inherited from ScaladocSyntaxAnalyzer.JavaScanner

### Inherited from ScaladocSyntaxAnalyzer.DocScanner

### Inherited from ScaladocSyntaxAnalyzer.ScannerCommon

### Inherited from ScaladocSyntaxAnalyzer.CommonTokenData

### Inherited from java.lang.Cloneable

### Inherited from ScaladocSyntaxAnalyzer.JavaTokenData

### Inherited from ScaladocSyntaxAnalyzer.AbstractJavaScanner

### Inherited from ScaladocSyntaxAnalyzer.AbstractJavaTokenData

### Inherited from AnyRef

### Inherited from Any

### Inherited by implicit conversion any2stringadd fromScaladocJavaUnitScanner to any2stringadd[ScaladocJavaUnitScanner]

### Inherited by implicit conversion StringFormat fromScaladocJavaUnitScanner to StringFormat[ScaladocJavaUnitScanner]

### Inherited by implicit conversion Ensuring fromScaladocJavaUnitScanner to Ensuring[ScaladocJavaUnitScanner]

### Inherited by implicit conversion ArrowAssoc fromScaladocJavaUnitScanner to ArrowAssoc[ScaladocJavaUnitScanner]

### Ungrouped