Val

Abstract Value Members

abstract def annotations: List[Annotation]

The annotations attached to this entity, if any.
The annotations attached to this entity, if any.

Definition Classes
Entity
abstract def byConversion: Option[ImplicitConversion]

If this member originates from an implicit conversion, we set the implicit information to the correct origin
If this member originates from an implicit conversion, we set the implicit information to the correct origin

Definition Classes
MemberEntity
abstract def comment: Option[Comment]

The comment attached to this member, if any.
The comment attached to this member, if any.

Definition Classes
MemberEntity
abstract def definitionName: String

The qualified name of the member in its currently active declaration template.
The qualified name of the member in its currently active declaration template.

Definition Classes
MemberEntity
abstract def deprecation: Option[Body]

Some deprecation message if this member is deprecated, or none otherwise.
Some deprecation message if this member is deprecated, or none otherwise.

Definition Classes
MemberEntity
abstract def flags: List[Paragraph]

The flags that have been set for this entity.
The flags that have been set for this entity. The following flags are supported: implicit, sealed, abstract, and final.

Definition Classes
MemberEntity
abstract def group: String

The group this member is from
The group this member is from

Definition Classes
MemberEntity
abstract def id: Int

Similar to symbols, so we can track entities
Similar to symbols, so we can track entities

Definition Classes
Entity
abstract def inDefinitionTemplates: List[TemplateEntity]

The templates in which this member has been declared.
The templates in which this member has been declared. The first element of the list is the template that contains the currently active declaration of this member, subsequent elements are declarations that have been overriden. If the first element is equal to inTemplate, the member is declared locally, if not, it has been inherited. All elements of this list are in the linearization of inTemplate.

Definition Classes
MemberEntity
abstract def inPackageObject: Boolean

Whether or not the template was defined in a package object
Whether or not the template was defined in a package object

Definition Classes
Entity
abstract def inTemplate: DocTemplateEntity

The template of which this entity is a member.
The template of which this entity is a member.

Definition Classes
MemberEntity → Entity
abstract def isAbstract: Boolean

Whether this member is abstract.
Whether this member is abstract.

Definition Classes
MemberEntity
abstract def isAbstractType: Boolean

Whether this member is an abstract type.
Whether this member is an abstract type.

Definition Classes
MemberEntity
abstract def isAliasType: Boolean

Whether this member is an alias type.
Whether this member is an alias type.

Definition Classes
MemberEntity
abstract def isAmbiguousImplicit: Boolean

Indicates whether there are other implicitly inherited members that have similar signatures (and thus they all become ambiguous)
Indicates whether there are other implicitly inherited members that have similar signatures (and thus they all become ambiguous)

Definition Classes
MemberEntity
abstract def isBridge: Boolean

Whether this member is a bridge member.
Whether this member is a bridge member. A bridge member does only exist for binary compatibility reasons and should not appear in ScalaDoc.

Definition Classes
NonTemplateMemberEntity
abstract def isConstructor: Boolean

Whether this member is a constructor.
Whether this member is a constructor.

Definition Classes
MemberEntity
abstract def isDef: Boolean

Whether this member is a method.
Whether this member is a method.

Definition Classes
MemberEntity
abstract def isImplicit: Boolean

Whether this member is implicit.
Whether this member is implicit.

Definition Classes
MemberEntity
abstract def isImplicitlyInherited: Boolean

Indicates whether the member is inherited by implicit conversion
Indicates whether the member is inherited by implicit conversion

Definition Classes
MemberEntity
abstract def isLazyVal: Boolean

Whether this member is a lazy value.
Whether this member is a lazy value.

Definition Classes
MemberEntity
abstract def isShadowedImplicit: Boolean

Indicates whether there is another member with the same name in the template that will take precendence
Indicates whether there is another member with the same name in the template that will take precendence

Definition Classes
MemberEntity
abstract def isShadowedOrAmbiguousImplicit: Boolean

Indicates whether the implicitly inherited member is shadowed or ambiguous in its template
Indicates whether the implicitly inherited member is shadowed or ambiguous in its template

Definition Classes
MemberEntity
abstract def isTemplate: Boolean

Whether this member is a template.
Whether this member is a template.

Definition Classes
MemberEntity
abstract def isTerm: Boolean

Indicates whether this entity lives in the terms namespace (objects, packages, methods, values)
Indicates whether this entity lives in the terms namespace (objects, packages, methods, values)

Definition Classes
Entity
abstract def isType: Boolean

Indicates whether this entity lives in the types namespace (classes, traits, abstract/alias types)
Indicates whether this entity lives in the types namespace (classes, traits, abstract/alias types)

Definition Classes
Entity
abstract def isUseCase: Boolean

Whether this member is a use case.
Whether this member is a use case. A use case is a member which does not exist in the documented code. It corresponds to a real member, and provides a simplified, yet compatible signature for that member.

Definition Classes
NonTemplateMemberEntity
abstract def isVal: Boolean

Whether this member is a value (this excludes lazy values).
Whether this member is a value (this excludes lazy values).

Definition Classes
MemberEntity
abstract def isVar: Boolean

Whether this member is a variable.
Whether this member is a variable.

Definition Classes
MemberEntity
abstract def migration: Option[Body]

Some migration warning if this member has a migration annotation, or none otherwise.
Some migration warning if this member has a migration annotation, or none otherwise.

Definition Classes
MemberEntity
abstract def name: String

The name of the entity.
The name of the entity. Note that the name does not qualify this entity uniquely; use its qualifiedName instead.

Definition Classes
Entity
abstract def qualifiedName: String

The qualified name of the entity.
The qualified name of the entity. This is this entity's name preceded by the qualified name of the template of which this entity is a member. The qualified name is unique to this entity.

Definition Classes
Entity
abstract def resultType: TypeEntity

For members representing values: the type of the value returned by this member; for members representing types: the type itself.
For members representing values: the type of the value returned by this member; for members representing types: the type itself.

Definition Classes
MemberEntity
abstract def signature: String

The identity of this member, used for linking
The identity of this member, used for linking

Definition Classes
MemberEntity
abstract def toRoot: List[MemberEntity]

The list of entities such that each is a member of the entity that follows it; the first entity is always this member, the last the root package entity.
The list of entities such that each is a member of the entity that follows it; the first entity is always this member, the last the root package entity.

Definition Classes
MemberEntity → Entity
abstract def universe: Universe

The Scaladoc universe of which this entity is a member.
The Scaladoc universe of which this entity is a member.

Definition Classes
Entity
abstract def useCaseOf: Option[MemberEntity]

If this symbol is a use case, the useCaseOf will contain the member it was derived from, containing the full signature and the complete parameter descriptions.
If this symbol is a use case, the useCaseOf will contain the member it was derived from, containing the full signature and the complete parameter descriptions.

Definition Classes
MemberEntity
abstract def visibility: Visibility

The visibility of this member.
The visibility of this member. Note that members with restricted visibility may not be modeled in some universes.

Definition Classes
MemberEntity
abstract def inheritedFrom: List[TemplateEntity]

Definition Classes
MemberEntity
Annotations
@deprecated
Deprecated
(Since version 2.9.0) Use inDefinitionTemplates instead

Concrete Value Members

final def !=(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def !=(arg0: Any): Boolean

Definition Classes
Any
final def ##(): Int

Definition Classes
AnyRef → Any
def +(other: String): String

Implicit information
This member is added by an implicit conversion from Val to StringAdd performed by method any2stringadd in scala.Predef.
Definition Classes
StringAdd
def ->[B](y: B): (Val, B)

Implicit information
This member is added by an implicit conversion from Val to ArrowAssoc[Val] performed by method any2ArrowAssoc in scala.Predef.
Definition Classes
ArrowAssoc
Annotations
@inline()
final def ==(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def ==(arg0: Any): Boolean

Definition Classes
Any
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws()
def ensuring(cond: (Val) ⇒ Boolean, msg: ⇒ Any): Val

Implicit information
This member is added by an implicit conversion from Val to Ensuring[Val] performed by method any2Ensuring in scala.Predef.
Definition Classes
Ensuring
def ensuring(cond: (Val) ⇒ Boolean): Val

Implicit information
This member is added by an implicit conversion from Val to Ensuring[Val] performed by method any2Ensuring in scala.Predef.
Definition Classes
Ensuring
def ensuring(cond: Boolean, msg: ⇒ Any): Val

Implicit information
This member is added by an implicit conversion from Val to Ensuring[Val] performed by method any2Ensuring in scala.Predef.
Definition Classes
Ensuring
def ensuring(cond: Boolean): Val

Implicit information
This member is added by an implicit conversion from Val to Ensuring[Val] performed by method any2Ensuring in scala.Predef.
Definition Classes
Ensuring
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws()
def formatted(fmtstr: String): String

Implicit information
This member is added by an implicit conversion from Val to StringFormat performed by method any2stringfmt in scala.Predef.
Definition Classes
StringFormat
Annotations
@inline()
final def getClass(): java.lang.Class[_]

Definition Classes
AnyRef → Any
def hashCode(): Int

Definition Classes
AnyRef → Any
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
def kind: String

The kind of the entity
The kind of the entity

Definition Classes
Val → Entity
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

The qualified name of this entity.
The qualified name of this entity.

Definition Classes
Entity → AnyRef → Any
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws()
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws()
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws()
def →[B](y: B): (Val, B)

Implicit information
This member is added by an implicit conversion from Val to ArrowAssoc[Val] performed by method any2ArrowAssoc in scala.Predef.
Definition Classes
ArrowAssoc

Shadowed Implict Value Members

val self: Any
Implicit information
This member is added by an implicit conversion from Val to StringAdd performed by method any2stringadd in scala.Predef.
Shadowing
This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
To access this member you can use a type ascription:
(val: StringAdd).self
Definition Classes
StringAdd
val self: Any
Implicit information
This member is added by an implicit conversion from Val to StringFormat performed by method any2stringfmt in scala.Predef.
Shadowing
This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
To access this member you can use a type ascription:
(val: StringFormat).self
Definition Classes
StringFormat

Deprecated Value Members

def x: Val
Implicit information
This member is added by an implicit conversion from Val to ArrowAssoc[Val] performed by method any2ArrowAssoc in scala.Predef.
Shadowing
This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
To access this member you can use a type ascription:
(val: ArrowAssoc[Val]).x
Definition Classes
ArrowAssoc
Annotations
@deprecated
Deprecated
(Since version 2.10.0) Use leftOfArrow instead
def x: Val
Implicit information
This member is added by an implicit conversion from Val to Ensuring[Val] performed by method any2Ensuring in scala.Predef.
Shadowing
This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
To access this member you can use a type ascription:
(val: Ensuring[Val]).x
Definition Classes
Ensuring
Annotations
@deprecated
Deprecated
(Since version 2.10.0) Use resultOfEnsuring instead

trait Val extends NonTemplateMemberEntity

Abstract Value Members

abstract def annotations: List[Annotation]

abstract def byConversion: Option[ImplicitConversion]

abstract def comment: Option[Comment]

abstract def definitionName: String

abstract def deprecation: Option[Body]

abstract def flags: List[Paragraph]

abstract def group: String

abstract def id: Int

abstract def inDefinitionTemplates: List[TemplateEntity]

abstract def inPackageObject: Boolean

abstract def inTemplate: DocTemplateEntity

abstract def isAbstract: Boolean

abstract def isAbstractType: Boolean

abstract def isAliasType: Boolean

abstract def isAmbiguousImplicit: Boolean

abstract def isBridge: Boolean

abstract def isConstructor: Boolean

abstract def isDef: Boolean

abstract def isImplicit: Boolean

abstract def isImplicitlyInherited: Boolean

abstract def isLazyVal: Boolean

abstract def isShadowedImplicit: Boolean

abstract def isShadowedOrAmbiguousImplicit: Boolean

abstract def isTemplate: Boolean

abstract def isTerm: Boolean

abstract def isType: Boolean

abstract def isUseCase: Boolean

abstract def isVal: Boolean

abstract def isVar: Boolean

abstract def migration: Option[Body]

abstract def name: String

abstract def qualifiedName: String

abstract def resultType: TypeEntity

abstract def signature: String

abstract def toRoot: List[MemberEntity]

abstract def universe: Universe

abstract def useCaseOf: Option[MemberEntity]

abstract def visibility: Visibility

abstract def inheritedFrom: List[TemplateEntity]

Concrete Value Members

final def !=(arg0: AnyRef): Boolean

final def !=(arg0: Any): Boolean

final def ##(): Int

def +(other: String): String

def ->[B](y: B): (Val, B)

final def ==(arg0: AnyRef): Boolean

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

def clone(): AnyRef

def ensuring(cond: (Val) ⇒ Boolean, msg: ⇒ Any): Val

def ensuring(cond: (Val) ⇒ Boolean): Val

def ensuring(cond: Boolean, msg: ⇒ Any): Val

def ensuring(cond: Boolean): Val

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

def formatted(fmtstr: String): String

final def getClass(): java.lang.Class[_]

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

def kind: String

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

final def synchronized[T0](arg0: ⇒ T0): T0

def toString(): String

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

def →[B](y: B): (Val, B)

Shadowed Implict Value Members

val self: Any

val self: Any

Deprecated Value Members

def x: Val

def x: Val

Inherited from NonTemplateMemberEntity