RIDDL
3.3.1
API
Generated with
RIDDL/com.reactific.riddl.language/AST/Input

Input

com.reactific.riddl.language.AST.Input
case class Input(loc: At, nounAlias: String, id: Identifier, verbAlias: String, putIn: TypeRef, inputs: Seq[InputDefinition], brief: Option[LiteralString], description: Option[Description]) extends ApplicationDefinition, GroupDefinition, InputDefinition

A Give is a UI Element to allow the user to 'give' some data to the application. It is analogous to a form in HTML

Value parameters

brief

A brief description of the Give

description

a detailed description of the Give

id

Name of the give

loc

Location of the Give

putIn

a Type reference of the type given by the user

Attributes

Graph
Supertypes
trait Serializable
trait Product
trait Equals
trait Definition
trait RiddlValue
trait RiddlNode
class Object
trait Matchable
class Any
Show all

Members list

Value members

Concrete methods

override def format: String

Format the node to a string

Format the node to a string

Attributes

Definition Classes
override def isAppRelated: Boolean

Attributes

Definition Classes
override def kind: String

Attributes

Definition Classes

Inherited methods

def asVital[OPT <: OptionValue, DEF <: Definition]: VitalDefinition[OPT, DEF]

Attributes

Inherited from:
Definition
def briefValue: String

Attributes

Inherited from:
BrieflyDescribedValue
def descriptionValue: String

Attributes

Inherited from:
DescribedValue
def hasAuthors: Boolean

Attributes

Inherited from:
Definition
def hasBriefDescription: Boolean

Attributes

Inherited from:
BrieflyDescribedValue
override def hasDefinitions: Boolean

Attributes

Definition Classes
Inherited from:
Definition
def hasDescription: Boolean

Attributes

Inherited from:
DescribedValue
def hasOptions: Boolean

Attributes

Inherited from:
Definition
def hasTypes: Boolean

Attributes

Inherited from:
Definition
def identify: String

Attributes

Inherited from:
Definition
def identifyWithLoc: String

Attributes

Inherited from:
Definition
override def isContainer: Boolean

Determine if this node is a container or not

Determine if this node is a container or not

Attributes

Definition Classes
Inherited from:
Container
override def isDefinition: Boolean

Attributes

Definition Classes
Inherited from:
Definition
override def isEmpty: Boolean

determine if this node is empty or not.

determine if this node is empty or not. Non-containers are always empty

Attributes

Definition Classes
Inherited from:
Container
def isImplicit: Boolean

Attributes

Inherited from:
Definition
def isRootContainer: Boolean

Attributes

Inherited from:
Container
def isVital: Boolean

Attributes

Inherited from:
Definition
final def nonEmpty: Boolean

Attributes

Inherited from:
RiddlNode
def productElementNames: Iterator[String]

Attributes

Inherited from:
Product
def productIterator: Iterator[Any]

Attributes

Inherited from:
Product
def resolveNameTo(name: String): Option[Definition]

Attributes

Inherited from:
Definition

Concrete fields

lazy override val contents: Seq[Definition]
Generated with