Class BaseElement

java.lang.Object
io.github.mmm.code.base.item.BaseItem
io.github.mmm.code.base.item.BaseMutableItem
io.github.mmm.code.base.node.BaseNodeItem
io.github.mmm.code.base.element.BaseElement
All Implemented Interfaces:
io.github.mmm.code.api.CodeWithContext, io.github.mmm.code.api.element.CodeElement, io.github.mmm.code.api.item.CodeItem, io.github.mmm.code.api.item.CodeItemWithComment, io.github.mmm.code.api.item.CodeMutableItem, io.github.mmm.code.api.item.CodeMutableItemWithComment, io.github.mmm.code.api.node.CodeNode, io.github.mmm.code.api.node.CodeNodeItem, io.github.mmm.code.api.object.CodeMutable
Direct Known Subclasses:
BaseElementWithDeclaringType, BaseElementWithQualifiedName
public abstract class BaseElement extends BaseNodeItem implements io.github.mmm.code.api.element.CodeElement
Base implementation of CodeElement.
Since:
1.0.0
Author:
Joerg Hohwiller (hohwille at users.sourceforge.net)

  • Constructor Details

    • BaseElement

      public BaseElement()
      The constructor.

    • BaseElement

      public BaseElement(BaseElement template, io.github.mmm.code.api.copy.CodeCopyMapper mapper)
      The copy-constructor.
      Parameters:
      template - the BaseElement to copy.
      mapper - the CodeCopyMapper.

  • Method Details

    • doInitialize

      protected void doInitialize()
      Description copied from class: BaseNodeItem
      Called from BaseMutableItem.initialize() on first invocation. May be overridden but never be called from anywhere else.
      Overrides:
      doInitialize in class BaseNodeItem

    • removeFromParent

      public void removeFromParent()
      Specified by:
      removeFromParent in interface io.github.mmm.code.api.element.CodeElement

    • getDoc

      public BaseDoc getDoc()
      Specified by:
      getDoc in interface io.github.mmm.code.api.element.CodeElement

    • getAnnotations

      public BaseAnnotations getAnnotations()
      Specified by:
      getAnnotations in interface io.github.mmm.code.api.element.CodeElement

    • getComment

      public io.github.mmm.code.api.comment.CodeComment getComment()
      Specified by:
      getComment in interface io.github.mmm.code.api.item.CodeItemWithComment

    • setComment

      public void setComment(io.github.mmm.code.api.comment.CodeComment comment)
      Specified by:
      setComment in interface io.github.mmm.code.api.item.CodeMutableItemWithComment

    • doSetImmutable

      protected void doSetImmutable()
      Description copied from class: BaseMutableItem
      Called on the first call of BaseMutableItem.setImmutable(). Has to be overridden to update Collections, make child items immutable, etc.
      Overrides:
      doSetImmutable in class BaseMutableItem

    • getSourceCodeObject

      public io.github.mmm.code.api.element.CodeElement getSourceCodeObject()
      Overrides:
      getSourceCodeObject in class BaseMutableItem
      Returns:
      the optional internal CodeItem representing the source-code (to merge). Otherwise null. This is an internal API. Do not use or rely on it from outside.

    • doMerge

      protected void doMerge(io.github.mmm.code.api.element.CodeElement other, io.github.mmm.code.api.merge.CodeMergeStrategy strategy)
      Parameters:
      other - the CodeElement to merge.
      strategy - the CodeMergeStrategy.

    • doWrite

      protected void doWrite(Appendable sink, String newline, String defaultIndent, String currentIndent, io.github.mmm.code.api.language.CodeLanguage language) throws IOException
      Specified by:
      doWrite in class BaseItem
      Parameters:
      sink - the Appendable where to append the code from this CodeItem.
      newline - the newline String.
      defaultIndent - the String used for indentation (e.g. a number of spaces to insert per indent level).
      currentIndent - the current indent (number of spaces). Initially the empty string (""). Before a recursion the defaultIndent will be appended.
      language - the CodeLanguage to use.
      Throws:
      IOException - if thrown by Appendable.
      See Also:
      • CodeItem.write(Appendable, String, String)

    • doWriteComment

      protected void doWriteComment(Appendable sink, String newline, String defaultIndent, String currentIndent, io.github.mmm.code.api.language.CodeLanguage language) throws IOException
      Writes the comment.
      Parameters:
      sink - the Appendable.
      newline - the newline String.
      defaultIndent - the default indent.
      currentIndent - the current indent.
      language - the CodeLanguage.
      Throws:
      IOException - if thrown by Appendable.

    • doWriteDoc

      protected void doWriteDoc(Appendable sink, String newline, String defaultIndent, String currentIndent, io.github.mmm.code.api.language.CodeLanguage language)
      Writes the JavaDoc.
      Parameters:
      sink - the Appendable.
      newline - the newline String.
      defaultIndent - the default indent.
      currentIndent - the current indent.
      language - the CodeLanguage.

    • doWriteAnnotations

      protected void doWriteAnnotations(Appendable sink, String newline, String defaultIndent, String currentIndent, io.github.mmm.code.api.language.CodeLanguage language)
      Writes the annotations.
      Parameters:
      sink - the Appendable.
      newline - the newline String.
      defaultIndent - the default indent.
      currentIndent - the current indent.
      language - the CodeLanguage.