BriefDescription

com.ossuminc.riddl.language.AST.BriefDescription
case class BriefDescription(loc: At, brief: LiteralString) extends Meta

A single line description for any vital definition

Value parameters

brief

The brief description

Attributes

Source
AST.scala
Graph
Supertypes
trait Serializable
trait Product
trait Equals
trait Meta
trait RiddlValue
class Object
trait Matchable
class Any
Show all

Members list

Value members

Concrete methods

def format: String

Format the node to a string in a form suitable for use in error messages

Format the node to a string in a form suitable for use in error messages

Attributes

Source
AST.scala

Inherited methods

Determines if this RiddlValue references any Authors or not

Determines if this RiddlValue references any Authors or not

Attributes

Inherited from:
RiddlValue
Source
AST.scala

Determines if this RiddlValuedefines any Authors or not

Determines if this RiddlValuedefines any Authors or not

Attributes

Inherited from:
RiddlValue
Source
AST.scala

Determine if this RiddlValue has definitions it contains

Determine if this RiddlValue has definitions it contains

Attributes

Inherited from:
RiddlValue
Source
AST.scala

Determines if this RiddlValue has any includes in it

Determines if this RiddlValue has any includes in it

Attributes

Inherited from:
RiddlValue
Source
AST.scala

Determines if this RiddlValue has any options set or not

Determines if this RiddlValue has any options set or not

Attributes

Inherited from:
RiddlValue
Source
AST.scala

Determines if this RiddlValue contains any type definitions

Determines if this RiddlValue contains any type definitions

Attributes

Inherited from:
RiddlValue
Source
AST.scala

True only if this value does not have a name or has an empty name

True only if this value does not have a name or has an empty name

Attributes

Inherited from:
RiddlValue
Source
AST.scala

Determines if this RiddlValue is a comment or not

Determines if this RiddlValue is a comment or not

Attributes

Inherited from:
RiddlValue
Source
AST.scala

Determine if this RiddlValue contains other values or not

Determine if this RiddlValue contains other values or not

Attributes

Inherited from:
RiddlValue
Source
AST.scala

Determine if this RiddlValue is a definition or not

Determine if this RiddlValue is a definition or not

Attributes

Inherited from:
RiddlValue
Source
AST.scala

Determine if this RiddlValue is empty or not.

Determine if this RiddlValue is empty or not. Non-containers are always empty

Attributes

Inherited from:
RiddlValue
Source
AST.scala

Whether or not this instance has an id: Identifier field or not

Whether or not this instance has an id: Identifier field or not

Attributes

Inherited from:
RiddlValue
Source
AST.scala

Attributes

Inherited from:
RiddlValue
Source
AST.scala

Determines if this RiddlValue is a processor (handles messages) or not

Determines if this RiddlValue is a processor (handles messages) or not

Attributes

Inherited from:
RiddlValue
Source
AST.scala

Determine if this RiddlValue is the top most container, appearing at the root of the AST

Determine if this RiddlValue is the top most container, appearing at the root of the AST

Attributes

Inherited from:
RiddlValue
Source
AST.scala

Determines if this node is a vital node or not

Determines if this node is a vital node or not

Attributes

Inherited from:
RiddlValue
Source
AST.scala
def kind: String

Provide a string to specify the kind of thing this value is with default derived from class name

Provide a string to specify the kind of thing this value is with default derived from class name

Attributes

Inherited from:
RiddlValue
Source
AST.scala
final def nonEmpty: Boolean

implements the nonEmpty function based on the isEmpty function

implements the nonEmpty function based on the isEmpty function

Attributes

Inherited from:
RiddlValue
Source
AST.scala

Attributes

Inherited from:
Product

Attributes

Inherited from:
Product