VitalDefinition
The base class of the primary, or vital, definitions. Most of the important definitions are derivatives of this sealed trait. All vital definitions contain comments, documentation, options, authors that defined it, include statements, and term definitions.
Type parameters
- CT
-
The type of the contents of the Vital Definition which must be rooted in RiddlValue
Attributes
- Graph
-
- Supertypes
-
trait WithMetaDatatrait WithOptions[CT]trait WithComments[CT]trait WithIncludes[CT]trait WithTypes[CT]trait Branch[CT]trait Container[CT]trait Definitiontrait WithIdentifiertrait RiddlValueclass Objecttrait Matchableclass AnyShow all
- Known subtypes
Members list
Type members
Inherited and Abstract types
Attributes
- Inherited from:
- Branch
Value members
Concrete methods
Determines if this node is a vital node or not
Inherited methods
AN optional BriefDescription
A reliable extractor of the brief description, dealing with the optionality and plurality of it
A reliable extractor of the brief description, dealing with the optionality and plurality of it
Attributes
- Inherited from:
- WithMetaData
Attributes
- Inherited from:
- WithComments
A reliable extractor of the description, dealing with the optionality and plurality of it
A reliable extractor of the description, dealing with the optionality and plurality of it
Attributes
- Inherited from:
- WithMetaData
A lazily constructed scala.Seq of Description
Attributes
- Inherited from:
- WithIdentifier
Get the value of name
'd option, if there is one.
Determines if this RiddlValue references any Authors or not
Determines if this RiddlValue references any Authors or not
Attributes
- Definition Classes
- Inherited from:
- WithMetaData
Determines if this RiddlValuedefines any Authors or not
Determine if this RiddlValue has definitions it contains
Determine if this RiddlValue has definitions it contains
Attributes
- Definition Classes
- Inherited from:
- Branch
Determines if this RiddlValue has any includes in it
Determines if this RiddlValue has any includes in it
Attributes
- Definition Classes
- Inherited from:
- WithIncludes
True if this value contains an option with the given name
.
Determines if this RiddlValue has any options set or not
Determines if this RiddlValue has any options set or not
Attributes
- Definition Classes
- Inherited from:
- WithOptions
Determines if this RiddlValue contains any type definitions
Determines if this RiddlValue contains any type definitions
Attributes
- Definition Classes
- Inherited from:
- WithTypes
Convert the identifier into a string format with its kind and dealing with anonymity.
Convert the identifier into a string format with its kind and dealing with anonymity.
Attributes
- Inherited from:
- WithIdentifier
Attributes
- Inherited from:
- WithIdentifier
Attributes
- Inherited from:
- WithIncludes
This one has an identifier so it is only anonymous if that identifier is empty
This one has an identifier so it is only anonymous if that identifier is empty
Attributes
- Definition Classes
- Inherited from:
- WithIdentifier
Determines if this RiddlValue is a comment or not
Force all subclasses to return true as they are containers
Force all subclasses to return true as they are containers
Attributes
- Definition Classes
- Inherited from:
- Container
Yes anything deriving from here is a definition
Yes anything deriving from here is a definition
Attributes
- Definition Classes
- Inherited from:
- Definition
Determine if this RiddlValue is empty or not.
Determine if this RiddlValue is empty or not. Non-containers are always empty
Attributes
- Definition Classes
- Inherited from:
- WithOptions
Whether or not this instance has an id: Identifier field or not
Whether or not this instance has an id: Identifier field or not
Attributes
- Definition Classes
- Inherited from:
- WithIdentifier
Attributes
- Definition Classes
- Inherited from:
- Branch
Determines if this RiddlValue is a processor (handles messages) or not
Determines if this RiddlValue is a processor (handles messages) or not
Attributes
- Inherited from:
- RiddlValue
Determine if this RiddlValue is the top most container, appearing at the root of the AST
Determine if this RiddlValue is the top most container, appearing at the root of the AST
Attributes
- Inherited from:
- RiddlValue
Provide a string to specify the kind of thing this value is with default derived from class name
Provide a string to specify the kind of thing this value is with default derived from class name
Attributes
- Inherited from:
- RiddlValue
implements the nonEmpty function based on the isEmpty function
implements the nonEmpty function based on the isEmpty function
Attributes
- Inherited from:
- RiddlValue
A lazily constructed Seq of OptionValue filtered from the contents
A lazily constructed Seq of OptionValue filtered from the contents
Attributes
- Inherited from:
- WithOptions
Inherited and Abstract methods
Format the node to a string in a form suitable for use in error messages
Format the node to a string in a form suitable for use in error messages
Attributes
- Inherited from:
- RiddlValue
the name/identifier of this value.
the name/identifier of this value. All definitions have one
Attributes
- Inherited from:
- WithIdentifier
The point location in the parse at which this RiddlValue occurs
The point location in the parse at which this RiddlValue occurs
Attributes
- Inherited from:
- RiddlValue
Attributes
- Inherited from:
- WithMetaData
Inherited fields
Attributes
- Inherited from:
- WithMetaData