net.sf.mmm.code.api.annotation.CodeAnnotation 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 java.lang.annotation.Annotation;
import java.util.Map;

import net.sf.mmm.code.api.copy.CodeCopyMapper;
import net.sf.mmm.code.api.copy.CodeNodeItemCopyable;
import net.sf.mmm.code.api.expression.CodeExpression;
import net.sf.mmm.code.api.item.CodeMutableItemWithComment;
import net.sf.mmm.code.api.item.CodeMutableItemWithType;

/**
 * {@link CodeMutableItemWithType} that represents an {@link java.lang.annotation.Annotation} instance.
 *
 * @author Joerg Hohwiller (hohwille at users.sourceforge.net)
 * @since 1.0.0
 */
public interface CodeAnnotation extends CodeMutableItemWithType, CodeMutableItemWithComment, CodeNodeItemCopyable {

  /** The character used as prefix for an annotation. */
  char PREFIX_CHAR = '@';

  /** The {@link String} used as prefix for an annotation. */
  String PREFIX = "@";

  /**
   * @return the {@link Map} with the parameters of this annotation. May be {@link Map#isEmpty() empty} but is never
   *         null. The {@link CodeExpression}s are most likely a
   *         {@link net.sf.mmm.code.api.expression.CodeConstant}.
   */
  Map getParameters();

  @Override
  Annotation getReflectiveObject();

  @Override
  CodeAnnotations getParent();

  @Override
  CodeAnnotation copy();

  @Override
  CodeAnnotation copy(CodeCopyMapper mapper);

}