RIDDL API Documentation
0.0.0-1-1f99f002
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.passes/com.ossuminc.riddl.passes.prettify/RiddlFileEmitter

RiddlFileEmitter

com.ossuminc.riddl.passes.prettify.RiddlFileEmitter
case class RiddlFileEmitter(url: URL) extends FileBuilder

Generates RIDDL in textual format based on the AST

Attributes

Source
RiddlFileEmitter.scala
Graph
Supertypes
trait Serializable
trait Product
trait Equals
trait FileBuilder
class Object
trait Matchable
class Any
Show all

Members list

Value members

Concrete methods

def add(strings: Seq[LiteralString]): this.type

Attributes

Source
RiddlFileEmitter.scala
def add[T](opt: Option[T])(map: T => String): this.type

Attributes

Source
RiddlFileEmitter.scala
def closeDef(definition: Definition): this.type

Attributes

Source
RiddlFileEmitter.scala
def emitAuthorRef(authorRef: AuthorRef): this.type

Attributes

Source
RiddlFileEmitter.scala
def emitCodeBlock(statements: Seq[Statements]): this.type

Attributes

Source
RiddlFileEmitter.scala
def emitComment(comment: Comment): this.type

Attributes

Source
RiddlFileEmitter.scala
def emitConstant(constant: Constant): this.type

Attributes

Source
RiddlFileEmitter.scala
def emitDescription(description: Description): this.type

Attributes

Source
RiddlFileEmitter.scala
def emitDescriptives(descriptives: Seq[MetaData]): this.type

Attributes

Source
RiddlFileEmitter.scala
def emitOption(option: OptionValue): this.type

Attributes

Source
RiddlFileEmitter.scala
def emitOptions(optionDef: WithOptions[_]): this.type

Attributes

Source
RiddlFileEmitter.scala
def emitPattern(pattern: Pattern): this.type

Attributes

Source
RiddlFileEmitter.scala
def emitString(s: String_): this.type

Attributes

Source
RiddlFileEmitter.scala
def emitType(t: Type): this.type

Attributes

Source
RiddlFileEmitter.scala
def emitTypeExpression(typEx: TypeExpression): this.type

Attributes

Source
RiddlFileEmitter.scala
def emitUndefined(): this.type

Attributes

Source
RiddlFileEmitter.scala
def openDef(definition: Definition, withBrace: Boolean): this.type

Attributes

Source
RiddlFileEmitter.scala

Inherited methods

def add(str: String): FileBuilder.this.type

Append a string without indent or suffix

Append a string without indent or suffix

Value parameters

str

The string to append

Attributes

Returns

This object for call chaining

Inherited from:
FileBuilder
Source
FileBuilder.scala
def addIndent(line: String): FileBuilder.this.type

Append an indented line with newline at the end and a level width indent prefix.

Append an indented line with newline at the end and a level width indent prefix. The indent will be done with level * spaces-per-level space characters.

Value parameters

line

The text of the line to be indented

Attributes

Returns

This object for call chaining

Inherited from:
FileBuilder
Source
FileBuilder.scala
def addIndent(): FileBuilder.this.type

Add just the indent spaces

Add just the indent spaces

Attributes

Returns

This object for call chaining

Inherited from:
FileBuilder
Source
FileBuilder.scala
def addLine(line: String): FileBuilder.this.type

Append a line to the buffer with a terminating newline.

Append a line to the buffer with a terminating newline. No prefix is inserted

Value parameters

line

The line to be appended

Attributes

Returns

This object for call chaining

Inherited from:
FileBuilder
Source
FileBuilder.scala
def append(text: String): FileBuilder.this.type

Append a line to the buffer without newlines or indentation

Append a line to the buffer without newlines or indentation

Value parameters

text

The text to be appended

Attributes

Returns

This object for call chaining

Inherited from:
FileBuilder
Source
FileBuilder.scala
def clear(): Unit

Completely erase the internal buffer

Completely erase the internal buffer

Attributes

Inherited from:
FileBuilder
Source
FileBuilder.scala
def decr: FileBuilder.this.type

Decrement the indent by one level

Decrement the indent by one level

Attributes

Returns
Inherited from:
FileBuilder
Source
FileBuilder.scala
def incr: FileBuilder.this.type

Increment the indent by one level

Increment the indent by one level

Attributes

Returns
Inherited from:
FileBuilder
Source
FileBuilder.scala
def nl: FileBuilder.this.type

Append a newline character

Append a newline character

Attributes

Returns

This object for call chaining

Inherited from:
FileBuilder
Source
FileBuilder.scala
def productElementNames: Iterator[String]

Attributes

Inherited from:
Product
def productIterator: Iterator[Any]

Attributes

Inherited from:
Product
protected def spc: String

The number of spaces at the current indent level

The number of spaces at the current indent level

Attributes

Inherited from:
FileBuilder
Source
FileBuilder.scala
def toLines: Seq[String]

Convert the buffer to a sequence of strings, one line per string

Convert the buffer to a sequence of strings, one line per string

Attributes

Returns
Inherited from:
FileBuilder
Source
FileBuilder.scala
override def toString: String

Returns a string representation of the object.

Returns a string representation of the object.

The default representation is platform dependent.

Attributes

Returns

a string representation of the object.

Definition Classes
FileBuilder -> Any
Inherited from:
FileBuilder
Source
FileBuilder.scala

Inherited fields

protected val new_line: String

Attributes

Inherited from:
FileBuilder
Source
FileBuilder.scala
protected val spaces_per_level: Int

Attributes

Inherited from:
FileBuilder
Source
FileBuilder.scala
Generated with
Copyright 2019 Ossum, Inc.. All Rights Reserved.
Copyright 2019 Ossum, Inc.. All Rights Reserved.