net.sf.mmm.code.api.node.CodeNodeContainer 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.node;

import java.util.Iterator;
import java.util.List;

import net.sf.mmm.code.api.item.CodeItem;

/**
 * {@link CodeItem} containing {@link CodeItem}s of a particular type. It groups these items and all the methods to
 * operate on them. This makes the API more structured as you do not get too much methods for top-level types such as
 * {@link net.sf.mmm.code.api.type.CodeType}. Further it supports reuse and avoids redundant declaration of methods with
 * their JavaDoc. So instead of {@link Class#getDeclaredMethods()} you will do
 * {@link net.sf.mmm.code.api.type.CodeType#getMethods()}.{@link net.sf.mmm.code.api.member.CodeMethods#getDeclared()
 * getDeclared()}.
 *
 * @author Joerg Hohwiller (hohwille at users.sourceforge.net)
 * @param  the type of the contained {@link CodeItem}s.
 * @since 1.0.0
 */
public abstract interface CodeNodeContainer extends CodeNode, Iterable {

  /**
   * @return all items directly contained in this container.
   */
  List getDeclared();

  @SuppressWarnings("unchecked")
  @Override
  default Iterator iterator() {

    return (Iterator) getDeclared().iterator();
  }

  /**
   * @return {@code true} if this container is {@link List#isEmpty() empty}, {@code false} otherwise.
   */
  default boolean isEmpty() {

    return getDeclared().isEmpty();
  }

}