Messages
This module handles everything needed to deal with the message output of the riddlc compiler
Attributes
- Source
- Messages.scala
- Graph
-
- Supertypes
-
class Objecttrait Matchableclass Any
- Self type
-
Messages.type
Members list
Type members
Classlikes
A utility to help accumulate error messages.
A utility to help accumulate error messages. Whether the messages are accumulated or not is governed by the settings in the options field of com.ossuminc.riddl.utils.PlatformContext
Attributes
- Companion
- object
- Source
- Messages.scala
- Supertypes
Attributes
- Companion
- class
- Source
- Messages.scala
- Supertypes
-
trait Producttrait Mirrorclass Objecttrait Matchableclass Any
- Self type
-
Accumulator.type
A case object for Error messages
A case object for Error messages
Attributes
- Source
- Messages.scala
- Supertypes
-
trait Singletontrait Producttrait Mirrortrait Serializabletrait Producttrait Equalstrait KindOfMessagetrait Ordered[KindOfMessage]trait Comparable[KindOfMessage]class Objecttrait Matchableclass AnyShow all
- Self type
-
Error.type
A case object for the Info kind of message
A case object for the Info kind of message
Attributes
- Source
- Messages.scala
- Supertypes
-
trait Singletontrait Producttrait Mirrortrait Serializabletrait Producttrait Equalstrait KindOfMessagetrait Ordered[KindOfMessage]trait Comparable[KindOfMessage]class Objecttrait Matchableclass AnyShow all
- Self type
-
Info.type
A sealed base trait for the kinds of messages that can be created each with their own existence test
A sealed base trait for the kinds of messages that can be created each with their own existence test
Attributes
- Source
- Messages.scala
- Supertypes
- Known subtypes
-
object Errorobject Infoobject MissingWarningobject SevereErrorobject StyleWarningobject UsageWarningobject WarningShow all
A Message instance.
A Message instance. There are helper functions below to help you create these.
Value parameters
- context
-
Additional context that indicates the conditions that produced the message
- kind
-
The kind of message as one of the case objects of KindOfMessage
- loc
-
The location in the model that generated the message
- message
-
The message text itself (there may be multiple lines, typically indent them 2 spaces, no tabs)
Attributes
- Source
- Messages.scala
- Supertypes
A case object for the Missing kind of warning message
A case object for the Missing kind of warning message
Attributes
- Source
- Messages.scala
- Supertypes
-
trait Singletontrait Producttrait Mirrortrait Serializabletrait Producttrait Equalstrait KindOfMessagetrait Ordered[KindOfMessage]trait Comparable[KindOfMessage]class Objecttrait Matchableclass AnyShow all
- Self type
-
MissingWarning.type
A case object for Severe Error messages
A case object for Severe Error messages
Attributes
- Source
- Messages.scala
- Supertypes
-
trait Singletontrait Producttrait Mirrortrait Serializabletrait Producttrait Equalstrait KindOfMessagetrait Ordered[KindOfMessage]trait Comparable[KindOfMessage]class Objecttrait Matchableclass AnyShow all
- Self type
-
SevereError.type
A case object for the Style kind of warning message
A case object for the Style kind of warning message
Attributes
- Source
- Messages.scala
- Supertypes
-
trait Singletontrait Producttrait Mirrortrait Serializabletrait Producttrait Equalstrait KindOfMessagetrait Ordered[KindOfMessage]trait Comparable[KindOfMessage]class Objecttrait Matchableclass AnyShow all
- Self type
-
StyleWarning.type
A case object for the Usage kind of warning message
A case object for the Usage kind of warning message
Attributes
- Source
- Messages.scala
- Supertypes
-
trait Singletontrait Producttrait Mirrortrait Serializabletrait Producttrait Equalstrait KindOfMessagetrait Ordered[KindOfMessage]trait Comparable[KindOfMessage]class Objecttrait Matchableclass AnyShow all
- Self type
-
UsageWarning.type
A case object for the generic kind of warning message
A case object for the generic kind of warning message
Attributes
- Source
- Messages.scala
- Supertypes
-
trait Singletontrait Producttrait Mirrortrait Serializabletrait Producttrait Equalstrait KindOfMessagetrait Ordered[KindOfMessage]trait Comparable[KindOfMessage]class Objecttrait Matchableclass AnyShow all
- Self type
-
Warning.type
Types
A frequently used shortcut for a scala.collection.immutable.List of Message.
A frequently used shortcut for a scala.collection.immutable.List of Message. Note that this has an extension that extends the capability of the list.
Attributes
- Source
- Messages.scala
Value members
Concrete methods
Generate an error message
Generate a scala.List with a single error message in it
Generate an informative message
Format and log the messages to the log per the options
Format and log the messages to the log per the options
Value parameters
- messages
-
The list of messages to log
Attributes
- Returns
- Source
- Messages.scala
Generate a missing warning
Generate a severe error message based on an exception received
Generate a severe error message
Generate a scala.List with a single server error message in it
Generate a style warning
Generate a usage warning
Generate a generic warning
Concrete fields
Canonical definition of an empty message list
The system's notion of a newline for sensible error message termination
The system's notion of a newline for sensible error message termination
Attributes
- Source
- Messages.scala
Extensions
Extensions
Format all the messages with a newline in between them.
Return true iff at least one of the messages is an Error
Return true iff at least one of the messages is of a Warning type.
Return a filtered list of just the Info messages.
Return true iff all the messages are considered ignorable (all warnings)
Return true iff all the messages are considered ignorable (all warnings)
Attributes
- Source
- Messages.scala
Return true iff all the messages are only warnings
Return a filtered list of just the Error messages.
Return a filtered list of just the Info messages.
Return a filtered list of just the MissingWarning messages.
Return a filtered list of just the StyleWarning messages.
Return a filtered list of just the UsageWarning messages.
Return a filtered list of just the Warning messages.