net.sf.mmm.code.api.element.CodeElement Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of mmm-code-api Show documentation

The API to parse, analyze, transform and generate code.

There is a newer version: 1.0.0-beta7

/* Copyright (c) The m-m-m Team, Licensed under the Apache License, Version 2.0
 * http://www.apache.org/licenses/LICENSE-2.0 */
package net.sf.mmm.code.api.element;

import net.sf.mmm.code.api.annotation.CodeAnnotations;
import net.sf.mmm.code.api.doc.CodeDoc;
import net.sf.mmm.code.api.item.CodeMutableItemWithComment;
import net.sf.mmm.code.api.item.CodeMutableItemWithType;
import net.sf.mmm.code.api.node.CodeNodeItem;
import net.sf.mmm.util.exception.api.ReadOnlyException;

/**
 * {@link CodeMutableItemWithType} that can be {@link #getAnnotations() annotated}, {@link #getDoc() documented}, or
 * {@link #getComment() commented}.
 *
 * @author Joerg Hohwiller (hohwille at users.sourceforge.net)
 * @since 1.0.0
 */
public abstract interface CodeElement extends CodeNodeItem, CodeMutableItemWithComment {

  /**
   * @return the {@link CodeDoc documentation} of this element. May be {@link CodeDoc#isEmpty() empty} but will never be
   *         {@code null}.
   */
  CodeDoc getDoc();

  /**
   * @return the {@link CodeAnnotations} with the {@link net.sf.mmm.code.api.annotation.CodeAnnotation}s of this
   *         element.
   */
  CodeAnnotations getAnnotations();

  /**
   * Destroys this node and disconnects it from its parent.
   *
   * @throws ReadOnlyException if {@link #isImmutable() immutable}.
   */
  void removeFromParent();

  @Override
  CodeElement copy();

}