RIDDL API Documentation
0.0.0-1-1f99f002
RIDDL API Documentation
API
com.ossuminc.riddl
command
Command
CommandOptions
CommandOptions
CommonOptionsHelper
InputFileCommand
Options
InputFileCommand
PassCommand
PassCommandOptions
TranslationCommand
Options
TranslationCommand
commands
AboutCommand
Options
AboutCommand
Commands
DumpCommand
DumpCommand
FlattenCommand
FlattenCommand
FromCommand
Options
FromCommand
HelpCommand
Options
HelpCommand
HugoCommand
InfoCommand
Options
InfoCommand
InputFileCommand
Options
InputFileCommand
OnChangeCommand
Options
OnChangeCommand
ParseCommand
ParseCommand
PrettifyCommand
Options
PrettifyCommand
RepeatCommand
Options
RepeatCommand
StatsCommand
Options
StatsCommand
ValidateCommand
VersionCommand
Options
VersionCommand
diagrams.mermaid
C4Diagram
ContextMapDiagram
DataFlowDiagram
DomainMapDiagram
EntityRelationshipDiagram
FlowchartDiagramGenerator
MermaidDiagramGenerator
RootOverviewDiagram
RootOverviewDiagram
SequenceDiagramGenerator
UseCaseDiagram
UseCaseDiagramSupport
hugo
themes
DotdockGenerator
DotdockWriter
DotdockWriter
GeekDocGenerator
GeekDocWriter
GeekDocWriter
ThemeGenerator
ThemeGenerator
ThemeWriter
ThemeWriter
utils
TreeCopyFileVisitor
writers
AdaptorWriter
ApplicationWriter
ContextWriter
DomainWriter
EntityWriter
EpicWriter
FunctionWriter
MarkdownBasics
MarkdownWriter
ModuleWriter
ProjectorWriter
RepositoryWriter
SagaWriter
StreamletWriter
SummariesWriter
GlossaryEntry
GlossaryOutput
GlossaryPass
GlossaryPass
HugoOutput
HugoPass
Options
HugoPass
MessageInfo
MessageOutput
MessagesPass
MessagesPass
RiddlToHugoTranslator
Summarizer
ToDoItem
ToDoListOutput
ToDoListPass
ToDoListPass
language
parsing
EmptyParserInput
ExtensibleTopLevelParser
Keyword
Keywords
ParsingContext
ParsingErrors
PredefType
PredefTypes
ProcessorParser
Punctuation
Readability
Readability
RiddlParserInput
RiddlParserInput
RootParser
TopLevelParser
TopLevelParser
VitalDefinitionParser
AST
Abstract
Adaptor
AdaptorDirection
AdaptorRef
AggregateTypeExpression
AggregateUseCase
AggregateUseCaseTypeExpression
AggregateValue
Aggregation
Aggregation
AliasedTypeExpression
Alternation
Application
ApplicationRef
ArbitraryInteraction
ArbitraryStatement
Author
AuthorRef
BecomeStatement
Blob
BlobKind
BlockDescription
Bool
BranchDefinition
BriefDescription
CallStatement
Cardinality
CodeStatement
CommandCase
CommandRef
Comment
Connector
Constant
ConstantRef
ContainedGroup
Container
Contents
Context
Context
ContextRef
Currency
Current
Date
DateTime
Decimal
Definition
Definition
DefinitionStack
Definitions
Description
Description
DirectUserToURLInteraction
Domain
DomainRef
Duration
Entity
EntityRef
EntityReferenceTypeExpression
Enumeration
Enumerator
Epic
EpicRef
ErrorStatement
EventCase
EventRef
Field
FieldRef
FileAttachment
Flow
FocusOnGroupInteraction
FocusStatement
ForEachStatement
Function
FunctionRef
GenericInteraction
Graph
Group
GroupRef
Handler
HandlerRef
Identifier
Identifier
IfThenElseStatement
InboundAdaptor
Include
Inlet
InletRef
InletRef
InlineComment
Input
InputRef
Integer
IntegerTypeExpression
Interaction
InteractionContainer
Invariant
LeafDefinition
Length
LineComment
LiteralString
LiteralString
Location
Luminosity
Mapping
Mass
Merge
MessageRef
MessageRef
Meta
Method
MethodArgument
Module
Mole
MorphStatement
Natural
Nebula
Nebula
Nothing
Number
NumericType
OnClause
OnInitializationClause
OnMessageClause
OnOtherClause
OnTerminationClause
OneOrMore
OptionValue
Optional
OptionalInteractions
OutboundAdaptor
Outlet
OutletRef
OutletRef
Output
OutputRef
ParallelInteractions
Parent
ParentStack
Parents
PathIdentifier
PathIdentifier
Pattern
Portlet
PortletRef
PredefinedType
PredefinedType
Processor
ProcessorRef
Projector
ProjectorRef
QueryCase
QueryRef
RangeType
ReadStatement
Real
RealTypeExpression
RecordCase
RecordRef
Reference
Relationship
RelationshipCardinality
Replica
ReplyStatement
Repository
RepositoryRef
RepositorySchemaKind
ResultCase
ResultRef
ReturnStatement
RiddlValue
Root
Root
Router
Saga
SagaRef
SagaStep
Schema
SelectInputInteraction
SelfInteraction
SendMessageInteraction
SendStatement
Sequence
SequentialInteractions
Set
SetStatement
ShowOutputInteraction
ShownBy
SimpleContainer
Sink
Source
SpecificRange
Split
State
StateRef
Statement
StopStatement
Streamlet
StreamletRef
StreamletShape
StringAttachment
String_
Table
TakeInputInteraction
TellStatement
Temperature
Term
Time
TimeStamp
TimeType
TwoReferenceInteraction
Type
TypeCase
TypeExpression
TypeRef
TypeRef
ULIDAttachment
URI
URLDescription
UUID
UniqueId
UseCase
User
UserId
UserRef
UserStory
VagueInteraction
VitalDefinition
Void
Whole
WithAdaptors
WithApplications
WithAuthors
WithComments
WithConnectors
WithConstants
WithContexts
WithDomains
WithEntities
WithEpics
WithFunctions
WithGroups
WithHandlers
WithIdentifier
WithIncludes
WithInlets
WithInputs
WithInvariants
WithMetaData
WithModules
WithOptions
WithOutlets
WithOutputs
WithProjectors
WithRepositories
WithSagaSteps
WithSagas
WithShownBy
WithStatements
WithStates
WithStreamlets
WithTypes
WithUseCases
WithUsers
WriteStatement
ZeroOrMore
ZonedDateTime
At
At
Finder
Finder
Folding
KnownOption
KnownOptions
Messages
Accumulator
Accumulator
Error
Info
KindOfMessage
Message
MissingWarning
SevereError
StyleWarning
UsageWarning
Warning
passes
diagrams
ContextDiagramData
DataFlowDiagramData
DiagramsPass
DiagramsPass
DiagramsPassOutput
UseCaseDiagramData
prettify
PrettifyOutput
PrettifyPass
Options
PrettifyPass
PrettifyState
PrettifyVisitor
RiddlFileEmitter
resolve
KindMap
KindMap
ReferenceMap
ReferenceMap
ResolutionOutput
ResolutionPass
ResolutionPass
UsageBase
UsageResolution
Usages
Usages
stats
DefinitionStats
KindStats
StatsOutput
StatsPass
StatsPass
symbols
Symbols
SymbolsOutput
SymbolsPass
SymbolsPass
translate
TranslatingOptions
TranslatingPass
TranslatingState
validate
BasicValidation
DefinitionValidation
StreamingValidation
TypeValidation
ValidationOutput
ValidationPass
ValidationPass
CollectingPass
CollectingPassOutput
HierarchyPass
Pass
Pass
PassInfo
PassInput
PassInput
PassOptions
PassOptions
PassOutput
PassOutput
PassVisitor
PassesOutput
PassesResult
PassesResult
Riddl
VisitingPass
utils
AdjustableClock
Await
CallBackLogger
CommonOptions
CommonOptions
ExceptionUtils
FileBuilder
Interrupt
State
Interrupt
JVMPlatformContext
Logger
Logging
Error
Info
Lvl
Missing
Severe
Style
Usage
Warning
OutputFile
PathUtils
PlatformContext
RiddlBuildInfo
SeqHelpers
StringBuildingPrintStream
StringBuildingPrintStream
StringHelpers
StringLogger
SysLogger
Tar
TextFileWriter
TextFileWriter
Timer
URL
URL
Zip
RIDDL API Documentation
/
com.ossuminc.riddl
/
com.ossuminc.riddl.command
/
PassCommandOptions
PassCommandOptions
com.ossuminc.riddl.command.PassCommandOptions
trait
PassCommandOptions
extends
CommandOptions
Attributes
Source
PassCommand.scala
Graph
Reset zoom
Hide graph
Show graph
Supertypes
trait
CommandOptions
class
Object
trait
Matchable
class
Any
Known subtypes
trait
Options
class
Options
class
Options
class
Options
Members list
Clear all
Value members
Abstract methods
def
outputDir
:
Option
[
Path
]
Attributes
Source
PassCommand.scala
Concrete methods
override
def
check
:
Messages
Attributes
Definition Classes
CommandOptions
Source
PassCommand.scala
Inherited methods
def
withInputFile
[
S
](
f
:
Path
=>
Either
[
Messages
,
S
]):
Either
[
Messages
,
S
]
Attributes
Inherited from:
CommandOptions
Source
CommandOptions.scala
Inherited and Abstract methods
def
command
:
String
Attributes
Inherited from:
CommandOptions
Source
CommandOptions.scala
def
inputFile
:
Option
[
Path
]
Attributes
Inherited from:
CommandOptions
Source
CommandOptions.scala
In this article
Attributes
Members list
Value members
Abstract methods
Concrete methods
Inherited methods
Inherited and Abstract methods