RIDDL API Documentation
0.0.0-1-7df8d16a
API
Generated with
Copyright 2019 Ossum, Inc.. All Rights Reserved.
Copyright 2019 Ossum, Inc.. All Rights Reserved.
RIDDL API Documentation/com.ossuminc.riddl/com.ossuminc.riddl.language/Messages

Messages

com.ossuminc.riddl.language.Messages
object Messages

This module handles everything needed to deal with the message output of the riddlc compiler

Attributes

Source
Messages.scala
Graph
Supertypes
class Object
trait Matchable
class Any
Self type
Messages.type

Members list

Type members

Classlikes

case class Accumulator(commonOptions: CommonOptions)

A utility to help accumulate error messages with regards to the settings in the CommonOptions

A utility to help accumulate error messages with regards to the settings in the CommonOptions

Attributes

Companion
object
Source
Messages.scala
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object Accumulator

Attributes

Companion
class
Source
Messages.scala
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
case object Error extends KindOfMessage

A case object for Error messages

A case object for Error messages

Attributes

Source
Messages.scala
Supertypes
trait Singleton
trait Product
trait Mirror
trait Serializable
trait Product
trait Equals
trait Comparable[KindOfMessage]
class Object
trait Matchable
class Any
Show all
Self type
Error.type
case object Info extends KindOfMessage

A case object for the Info kind of message

A case object for the Info kind of message

Attributes

Source
Messages.scala
Supertypes
trait Singleton
trait Product
trait Mirror
trait Serializable
trait Product
trait Equals
trait Comparable[KindOfMessage]
class Object
trait Matchable
class Any
Show all
Self type
Info.type
sealed trait KindOfMessage extends Ordered[KindOfMessage]

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
trait Comparable[KindOfMessage]
class Object
trait Matchable
class Any
Known subtypes
object Error
object Info
object SevereError
object StyleWarning
object UsageWarning
object Warning
Show all
case class Message(loc: At, message: String, kind: KindOfMessage, context: String) extends Ordered[Message]

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
trait Serializable
trait Product
trait Equals
trait Ordered[Message]
trait Comparable[Message]
class Object
trait Matchable
class Any
Show all
case object MissingWarning extends KindOfMessage

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 Singleton
trait Product
trait Mirror
trait Serializable
trait Product
trait Equals
trait Comparable[KindOfMessage]
class Object
trait Matchable
class Any
Show all
Self type
case object SevereError extends KindOfMessage

A case object for Severe Error messages

A case object for Severe Error messages

Attributes

Source
Messages.scala
Supertypes
trait Singleton
trait Product
trait Mirror
trait Serializable
trait Product
trait Equals
trait Comparable[KindOfMessage]
class Object
trait Matchable
class Any
Show all
Self type
case object StyleWarning extends KindOfMessage

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 Singleton
trait Product
trait Mirror
trait Serializable
trait Product
trait Equals
trait Comparable[KindOfMessage]
class Object
trait Matchable
class Any
Show all
Self type
case object UsageWarning extends KindOfMessage

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 Singleton
trait Product
trait Mirror
trait Serializable
trait Product
trait Equals
trait Comparable[KindOfMessage]
class Object
trait Matchable
class Any
Show all
Self type
case object Warning extends KindOfMessage

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 Singleton
trait Product
trait Mirror
trait Serializable
trait Product
trait Equals
trait Comparable[KindOfMessage]
class Object
trait Matchable
class Any
Show all
Self type
Warning.type

Types

type Messages = List[Message]

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

def error(message: String, loc: At): Message

Generate an error message

Generate an error message

Attributes

Source
Messages.scala
def errors(message: String, loc: At): Messages

Generate a scala.List with a single error message in it

Generate a scala.List with a single error message in it

Attributes

Source
Messages.scala
def info(message: String, loc: At): Message

Generate an informative message

Generate an informative message

Attributes

Source
Messages.scala
def logMessages(messages: Messages, log: Logger, options: CommonOptions): Int

Format and log the messages to the log per the options

Format and log the messages to the log per the options

Value parameters

log

The com.ossuminc.riddl.utils.Logger instance to which the messages are sent.

messages

The list of messages to log

options

The com.ossuminc.riddl.language.CommonOptions that can control how the logged messages appear.

Attributes

Returns
Source
Messages.scala
def missing(message: String, loc: At): Message

Generate a missing warning

Generate a missing warning

Attributes

Source
Messages.scala
def severe(message: String, exception: Throwable, loc: At): Message

Generate a severe error message based on an exception received

Generate a severe error message based on an exception received

Attributes

Source
Messages.scala
def severe(message: String, loc: At): Message

Generate a severe error message

Generate a severe error message

Attributes

Source
Messages.scala
def severes(message: String, loc: At): Messages

Generate a scala.List with a single server error message in it

Generate a scala.List with a single server error message in it

Attributes

Source
Messages.scala
def style(message: String, loc: At): Message

Generate a style warning

Generate a style warning

Attributes

Source
Messages.scala
def usage(message: String, loc: At): Message

Generate a usage warning

Generate a usage warning

Attributes

Source
Messages.scala
def warning(message: String, loc: At): Message

Generate a generic warning

Generate a generic warning

Attributes

Source
Messages.scala
def warnings(message: String, loc: At): Messages

Generate a scala.List with a single warning message in it

Generate a scala.List with a single warning message in it

Attributes

Source
Messages.scala

Concrete fields

val empty: Messages

Canonical definition of an empty message list

Canonical definition of an empty message list

Attributes

Source
Messages.scala
val nl: String

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

extension (msgs: Messages)
def format: String

Format all the messages with a newline in between them.

Format all the messages with a newline in between them.

Attributes

Source
Messages.scala
def hasErrors: Boolean

Return true iff at least one of the messages is an Error

Return true iff at least one of the messages is an Error

Attributes

Source
Messages.scala
def hasWarnings: Boolean

Return true iff at least one of the messages is of a Warning type.

Return true iff at least one of the messages is of a Warning type.

Attributes

Source
Messages.scala
def highestSeverity: Int

Return a filtered list of just the Info messages.

Return a filtered list of just the Info messages.

Attributes

Source
Messages.scala
def isOnlyIgnorable: Boolean

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
def isOnlyWarnings: Boolean

Return true iff all the messages are only warnings

Return true iff all the messages are only warnings

Attributes

Source
Messages.scala
def justErrors: Messages

Return a filtered list of just the Error messages.

Return a filtered list of just the Error messages.

Attributes

Source
Messages.scala
def justInfo: Messages

Return a filtered list of just the Info messages.

Return a filtered list of just the Info messages.

Attributes

Source
Messages.scala
def justMissing: Messages

Return a filtered list of just the MissingWarning messages.

Return a filtered list of just the MissingWarning messages.

Attributes

Source
Messages.scala
def justStyle: Messages

Return a filtered list of just the StyleWarning messages.

Return a filtered list of just the StyleWarning messages.

Attributes

Source
Messages.scala
def justUsage: Messages

Return a filtered list of just the UsageWarning messages.

Return a filtered list of just the UsageWarning messages.

Attributes

Source
Messages.scala
def justWarnings: Messages

Return a filtered list of just the Warning messages.

Return a filtered list of just the Warning messages.

Attributes

Source
Messages.scala
Generated with
Copyright 2019 Ossum, Inc.. All Rights Reserved.
Copyright 2019 Ossum, Inc.. All Rights Reserved.