net.sf.mmm.code.api.member.CodeConstructor 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.member;

import java.lang.reflect.Constructor;

import net.sf.mmm.code.api.copy.CodeNodeItemCopyable;
import net.sf.mmm.code.api.merge.CodeAdvancedMergeableItem;
import net.sf.mmm.code.api.type.CodeGenericType;
import net.sf.mmm.code.api.type.CodeType;
import net.sf.mmm.util.exception.api.ReadOnlyException;

/**
 * {@link CodeOperation} representing a constructor of a {@link CodeType}.
 *
 * @see CodeType#getConstructors()
 * @see CodeConstructors#getDeclared()
 * @see java.lang.reflect.Constructor
 * @author Joerg Hohwiller (hohwille at users.sourceforge.net)
 * @since 1.0.0
 */
public interface CodeConstructor extends CodeOperation, CodeAdvancedMergeableItem, CodeNodeItemCopyable {

  @Override
  default CodeGenericType getType() {

    return getDeclaringType();
  }

  /**
   * @deprecated the {@link #getName() name} of a {@link CodeConstructor} has to be equal to the
   *             {@link CodeType#getSimpleName() simple name} of its {@link #getDeclaringType() declaring type}.
   */
  @Deprecated
  @Override
  default void setName(String name) {

    throw new ReadOnlyException(getClass().getSimpleName(), "name");
  }

  @Override
  Constructor getReflectiveObject();

  @Override
  CodeConstructor copy();
}