net.sf.mmm.code.api.annotation.CodeAnnotations 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.annotation;

import net.sf.mmm.code.api.copy.CodeNodeItemCopyable;
import net.sf.mmm.code.api.element.CodeElement;
import net.sf.mmm.code.api.merge.CodeSimpleMergeableItem;
import net.sf.mmm.code.api.node.CodeNodeItemContainerHierarchical;
import net.sf.mmm.code.api.type.CodeType;

/**
 * {@link CodeNodeItemContainerHierarchical} containing {@link CodeAnnotation}s.
 *
 * @author Joerg Hohwiller (hohwille at users.sourceforge.net)
 * @since 1.0.0
 */
public interface CodeAnnotations
    extends CodeNodeItemContainerHierarchical, CodeSimpleMergeableItem, CodeNodeItemCopyable {

  @Override
  CodeElement getParent();

  /**
   * Attention:

   * This method can be expensive as it has to traverse inherited elements. However, due to the usage of
   * {@link Iterable} implementations can lazily traverse.
   *
   * @see net.sf.mmm.code.api.member.CodeMethod#getParentMethod()
   */
  @Override
  Iterable getAll();

  /**
   * @param type the {@link CodeAnnotation#getType() type} reflecting the {@link CodeType#isAnnotation()
   *        annotation}.
   * @return the new {@link CodeAnnotation} that has been created and added.
   */
  CodeAnnotation add(CodeType type);

  /**
   * @param annotation the {@link CodeAnnotation} to add.
   */
  void add(CodeAnnotation annotation);

  /**
   * @param type the {@link CodeAnnotation#getType() type} reflecting the {@link CodeType#isAnnotation()
   *        annotation}.
   * @return the {@link CodeAnnotation} from {@link #getDeclared()} {@link CodeAnnotation#getType() with} the
   *         give {@link CodeType} or {@code null} if not found.
   */
  CodeAnnotation getDeclared(CodeType type);

  /**
   * @param type the {@link CodeAnnotation#getType() type} reflecting the {@link CodeType#isAnnotation()
   *        annotation}.
   * @return the {@link CodeAnnotation} from {@link #getDeclared()} {@link CodeAnnotation#getType() with} the
   *         give {@link CodeType} or a new {@link #add(CodeType) added} one.
   */
  default CodeAnnotation getDeclaredOrAdd(CodeType type) {

    CodeAnnotation annotation = getDeclared(type);
    if (annotation == null) {
      annotation = add(type);
    }
    return annotation;
  }

  @Override
  CodeAnnotations copy();

}