com.ossuminc.riddl.utils

An implementation of java.time.Clock which only moves through time via calls to updateInstant.

An implementation of java.time.Clock which only moves through time via calls to updateInstant. This allows fine-grained, side-effect-free deterministic control over the progression of system time, which is useful for testing purposes.

Attributes

Source: AdjustableClock.scala
Supertypes: class Clock

trait InstantSource

class Object

trait Matchable

class Any

Attributes

Source: Await.scala
Supertypes: class Object

trait Matchable

class Any
Self type: Await.type

Attributes

Source: Logging.scala
Supertypes: trait Serializable

trait Product

trait Equals

trait Logger

class Object

trait Matchable

class Any
Show all

The common options available to any pass.

The common options available to any pass. Common options occur before the command name on the riddlc command line

Value parameters

debug: Controls whether debug output should be printed out (this goes into the iterative data that verbose doesn't print)
dryRun: Controls whether everything should be done except the requested action (useful with verbose)
groupMessagesByKind: When set to true, the messages put out will be grouped by their kind and sorted with the most severe first.
maxIncludeWait: Provides the maximum amount of time that the parser should wait for a parallel include to finish processing. The default is 5 seconds.
maxParallelParsing: Provides the maximum number of threads to use when parsing in parallel. The default is the number of CPU cores on the machine the program is running on.
noANSIMessages: When set to true, ANSI coloring is not used in the output
quiet: Controls whether riddlc should not print anything out but just do the requested action (opposite of dryRun)
showIncludeTimes: Controls whether include processing timing is printed out
showInfoMessages: Controls whether any informative messages are printed out
showMissingWarnings: Controls whether any missing Warnings are printed out
showStyleWarnings: Controls whether any style Warnings are printed out
showTimes: Controls whether pass timing is printed out
showUsageWarnings: Controls whether any usage Warnings are printed out
showWarnings: Controls whether any warnings, of any kind, are printed out
sortMessagesByLocation: When set to true, the messages put out will be sorted by their location in the model (file, line, column)
verbose: Controls whether verbose steps taken are printed out (useful to implementors of riddlc)
warningsAreFatal: When set to true, any warnings are handled as if they were errors and terminate riddlc with a non-zero status

Attributes

Companion: object
Source: CommonOptions.scala
Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Attributes

Companion: class
Source: CommonOptions.scala
Supertypes: trait Product

trait Mirror

class Object

trait Matchable

class Any
Self type: CommonOptions.type

Attributes

Source: ExceptionUtils.scala
Supertypes: class Object

trait Matchable

class Any
Self type: ExceptionUtils.type

A trait to build a string up for writing to a file.

A trait to build a string up for writing to a file. This provides the platform specific definition of newline, an nl function to insert a newline, and other functions for putting changes into the file content. The file is assumed to have a UTF-8 content type.

Attributes

Source: FileBuilder.scala
Supertypes: class Object

trait Matchable

class Any
Known subtypes: class DataFlowDiagram

trait MermaidDiagramGenerator

trait FlowchartDiagramGenerator

class ContextMapDiagram

class DomainMapDiagram

class RootOverviewDiagram

trait SequenceDiagramGenerator

class UseCaseDiagram

class RiddlFileEmitter

trait OutputFile

class TextFileWriter

trait MarkdownBasics

trait MarkdownWriter

class DotdockWriter

class GeekDocWriter
Show all

Attributes

Companion: object
Source: Interrupt.scala
Supertypes: trait () => Boolean

class Object

trait Matchable

class Any

Attributes

Companion: class
Source: Interrupt.scala
Supertypes: class Object

trait Matchable

class Any
Self type: Interrupt.type

This is the JVM version of the Loader utility.

This is the JVM version of the Loader utility. It is used to load file content in UTF-8 via a URL as a String and returning the Future that will obtain it. Further processing can be chained onto the future. This handles the I/O part of parsing in a platform specific way.

Attributes

Source: JVMPlatformContext.scala
Supertypes: trait PlatformContext

class Object

trait Matchable

class Any

Attributes

Source: Logging.scala
Supertypes: class Object

trait Matchable

class Any
Known subtypes: class CallBackLogger

class StringLogger

class SysLogger

Attributes

Source: Logging.scala
Supertypes: class Object

trait Matchable

class Any
Self type: Logging.type

Attributes

Source: OutputFile.scala
Supertypes: trait FileBuilder

class Object

trait Matchable

class Any
Known subtypes: class TextFileWriter

trait MarkdownBasics

trait MarkdownWriter

class DotdockWriter

class GeekDocWriter

Attributes

Source: PathUtils.scala
Supertypes: class Object

trait Matchable

class Any
Self type: PathUtils.type

This trait allows RIDDL to abstract away its IO operations.

This trait allows RIDDL to abstract away its IO operations. Several places in RIDDL declare a using clause with this trait in order to allow RIDDL to invoke synchronous and asynchronous I/O operations. This allows RIDDL's pure-scala implementation to be used with: JVM, scala-native, scala-js for Browser, scala-js for Node, or any other environment that supports simple input/output operations on files.

Attributes

Source: PlatformContext.scala
Supertypes: class Object

trait Matchable

class Any
Known subtypes: class JVMPlatformContext

This object was generated by sbt-buildinfo.

Attributes

Source: RiddlBuildInfo.scala
Supertypes: trait Singleton

trait Product

trait Mirror

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all
Self type: RiddlBuildInfo.type

Attributes

Source: SeqHelpers.scala
Supertypes: class Object

trait Matchable

class Any
Self type: SeqHelpers.type

A PrintStream that captures any output into a String

Attributes

Companion: object
Source: StringBuildingPrintStream.scala
Supertypes: class PrintStream

trait Appendable

class FilterOutputStream

class OutputStream

trait Flushable

trait Closeable

trait AutoCloseable

class Object

trait Matchable

class Any
Show all

Attributes

Companion: class
Source: StringBuildingPrintStream.scala
Supertypes: class Object

trait Matchable

class Any
Self type: StringBuildingPrintStream.type

Attributes

Source: StringHelpers.scala
Supertypes: class Object

trait Matchable

class Any
Self type: StringHelpers.type

Attributes

Source: Logging.scala
Supertypes: trait Serializable

trait Product

trait Equals

trait Logger

class Object

trait Matchable

class Any
Show all

Attributes

Source: Logging.scala
Supertypes: trait Serializable

trait Product

trait Equals

trait Logger

class Object

trait Matchable

class Any
Show all

Attributes

Source: Tar.scala
Supertypes: class Object

trait Matchable

class Any
Self type: Tar.type

Unit Tests For TextFileWriter

Attributes

Companion: object
Source: TextFileWriter.scala
Supertypes: trait OutputFile

trait FileBuilder

class Object

trait Matchable

class Any
Known subtypes: trait MarkdownBasics

trait MarkdownWriter

class DotdockWriter

class GeekDocWriter

Attributes

Companion: class
Source: TextFileWriter.scala
Supertypes: class Object

trait Matchable

class Any
Self type: TextFileWriter.type

Private implementation details which allow for more testability

Attributes

Source: Timer.scala
Supertypes: class Object

trait Matchable

class Any
Self type: Timer.type

A RIDDL version of a URL since the JVM version isn't useful to Javascript.

A RIDDL version of a URL since the JVM version isn't useful to Javascript. This just allows a simplified URL that has a scheme, authority, basis and path part.

Value parameters

authority: The authority part providing the basic location and credentials of the resource. The full syntax should be user@host:port. This field must not contain a /
basis: The "root" path or basis of the URL. This is for compatibility with "file" scheme as taken from java.nio.file.Path's functionality that the current working directory will be presumed as the root of the path. You can use the toBasisString method to get the URL without the path part. basis should not start with a /
path: The path of the resource. Fragments (part after #) can be included in the path if necessary. This URL implementation doesn't check the validity or existence of the fragment. path should not start with a /
scheme: The URL's scheme, either file, http, or https

Attributes

Companion: object
Source: URL.scala
Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Attributes

Companion: class
Source: URL.scala
Supertypes: trait Product

trait Mirror

class Object

trait Matchable

class Any
Self type: URL.type

Attributes

Source: Zip.scala
Supertypes: class Object

trait Matchable

class Any
Self type: Zip.type

com.ossuminc.riddl.utils

Members list

Type members

Classlikes

Attributes

Attributes

Attributes

Value parameters

Attributes

Attributes

Attributes

Attributes

Attributes

Attributes

Attributes

Attributes

Attributes

Attributes

Attributes

Attributes

Attributes

Attributes

Attributes

Attributes

Attributes

Attributes

Attributes

Attributes

Attributes

Attributes

Attributes

Value parameters

Attributes

Attributes

Attributes

Givens

Givens

Attributes

Implicits

Implicits

Attributes