case class ConfigObject(entries: Map[String, ConfigNode], comment: DocumentationComment) extends ConfigNode with Product with Serializable
Stores a List structure inside the ConfigNode structure.
- entries
contains a K,V Map of ConfigNodes.
- comment
are all the comments associated with the Object.
- Source
- ConfigObject.scala
- Alphabetic
- By Inheritance
- ConfigObject
- Serializable
- Product
- Equals
- ConfigNode
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new ConfigObject(entries: Map[String, ConfigNode], comment: DocumentationComment)
- entries
contains a K,V Map of ConfigNodes.
- comment
are all the comments associated with the Object.
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native() @IntrinsicCandidate()
- def collapse(): Unit
This method collapses the object structure by joining inheriting objects containing only one value.
This method collapses the object structure by joining inheriting objects containing only one value. Inverse function of expand.
- Definition Classes
- ConfigObject → ConfigNode
- var comment: DocumentationComment
- Definition Classes
- ConfigObject → ConfigNode
- var entries: Map[String, ConfigNode]
- def entriesToHTML(exporter: HTMLExporter, pageHTML: StringBuilder)(implicit project: SomeProject): Unit
Produces the HTML for the individual entries.
Produces the HTML for the individual entries.
- pageHTML
accepts a StringBuilder. The method adds the HTML String to this StringBuilder.
- Attributes
- protected
- Definition Classes
- ConfigObject → ConfigNode
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def expand(): Unit
This method expands the current object to represent all objects within the structure.
This method expands the current object to represent all objects within the structure. Inverse function of collapse (except for comments, which are not unmerged).
- Definition Classes
- ConfigObject → ConfigNode
- def getBrief(exporter: HTMLExporter)(implicit project: SomeProject): String
Returns an HMTL-escaped text for the brief description.
Returns an HMTL-escaped text for the brief description.
- Attributes
- protected
- Definition Classes
- ConfigNode
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @IntrinsicCandidate()
- def getHeadlineText(label: String): String
Returns a text for the HTML headline entry.
Returns a text for the HTML headline entry.
- Attributes
- protected
- Definition Classes
- ConfigNode
- def isEmpty: Boolean
Checks if the object is empty.
Checks if the object is empty.
- returns
true if both the Object and the comment are empty.
- Definition Classes
- ConfigObject → ConfigNode
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- implicit val logContext: LogContext
- def merge(insertingObject: ConfigObject): Unit
Merges two type compatible objects.
Merges two type compatible objects. This means that the objects are free of conflicting values and lists. Objects are allowed to overlap as long as there are no conflicts down the tree.
- insertingObject
Is the object that is supposed to be merged into the executing one.
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @IntrinsicCandidate()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @IntrinsicCandidate()
- def productElementNames: Iterator[String]
- Definition Classes
- Product
- def replaceClasses(se: SubclassExtractor): Unit
Replaces subclass types of all members of the Object.
Replaces subclass types of all members of the Object.
- se
Accepts an initialized SubclassExtractor containing the ClassHierarchy required for a successful replacement.
- Definition Classes
- ConfigObject → ConfigNode
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toHTML(exporter: HTMLExporter, label: String, pageHTML: StringBuilder)(implicit project: SomeProject): Unit
Method for handling the export of the configuration structure into an HTML file.
Method for handling the export of the configuration structure into an HTML file.
- label
required if the Object is part of another object (Writes the key of the K,V Map there instead). Overrides the label property of the Comment object. Supply an empty string if not needed.
- pageHTML
accepts a StringBuilder. The method adds the HTML String to this StringBuilder.
- Definition Classes
- ConfigNode
- def valueToHTML(exporter: HTMLExporter, pageHTML: StringBuilder)(implicit project: SomeProject): Unit
- Definition Classes
- ConfigObject → ConfigNode
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
Deprecated Value Members
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable]) @Deprecated @Deprecated
- Deprecated