net.sf.mmm.code.api.node.CodeNodeItemContainerWithName 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 net.sf.mmm.code.api.item.CodeItem;
import net.sf.mmm.code.api.item.CodeItemWithName;
import net.sf.mmm.util.exception.api.ObjectNotFoundException;
import net.sf.mmm.util.exception.api.ReadOnlyException;

/**
 * {@link CodeNodeItemContainer} containing {@link CodeItemWithName#getName() named} {@link CodeItem}s.
 *
 * @author Joerg Hohwiller (hohwille at users.sourceforge.net)
 * @param  the type of the contained {@link CodeItem}s.
 * @since 1.0.0
 */
public abstract interface CodeNodeItemContainerWithName extends CodeNodeItemContainer {

  /**
   * @param name the {@link CodeItemWithName#getName() name} of the requested {@link CodeItem}.
   * @return the {@link CodeItem} from all items with the given {@code name} or {@code null} if no such item
   *         exists.
   */
  I get(String name);

  /**
   * @param name the {@link CodeItemWithName#getName() name} of the requested {@link CodeItem}.
   * @return the {@link CodeItem} from all items with the given {@code name}.
   * @throws ObjectNotFoundException if the requested item was not found.
   */
  default I getRequired(String name) {

    I item = get(name);
    if (item == null) {
      throw new ObjectNotFoundException(getClass().getSimpleName(), name);
    }
    return item;
  }

  /**
   * @param name the {@link CodeItemWithName#getName() name} of the requested {@link CodeItem}.
   * @return the {@link #get(String) existing} or {@link #add(String) added} {@link CodeItem}.
   */
  default I getOrCreate(String name) {

    I item = get(name);
    if (item == null) {
      item = add(name);
    }
    return item;
  }

  /**
   * @param name the {@link CodeItemWithName#getName() name} of the requested {@link CodeItem}.
   * @return the {@link CodeItem} from the {@link #getDeclared() declared items} with the given {@code name}
   *         or {@code null} if no such item exists.
   */
  I getDeclared(String name);

  /**
   * @param name the {@link CodeItemWithName#getName() name} of the requested {@link CodeItem}.
   * @return the {@link #getDeclared(String) existing} or {@link #add(String) added} {@link CodeItem}.
   */
  default I getDeclaredOrCreate(String name) {

    I item = getDeclared(name);
    if (item == null) {
      item = add(name);
    }
    return item;
  }

  /**
   * @param name the {@link CodeItemWithName#getName() name} of the {@link CodeItemWithName} to create.
   * @return a new {@link CodeItem} that has been added.
   * @throws ReadOnlyException if {@link #isImmutable() immutable}.
   */
  I add(String name);

  @Override
  CodeNodeItemContainerWithName copy();

}