net.sf.mmm.code.api.node.CodeNodeWithFileWriting 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.nio.charset.Charset;
import java.nio.file.Path;

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

/**
 * {@link CodeItem} with {@link #write(Path) file writing support}.
 *
 * @author Joerg Hohwiller (hohwille at users.sourceforge.net)
 * @since 1.0.0
 */
public interface CodeNodeWithFileWriting extends CodeNode {

  /**
   * Recursively writes the {@link net.sf.mmm.code.api.item.CodeItem#getSourceCode() source code} of this item
   * recursively with all its children to the folder identified by the given {@link Path}.
   *
   * @param targetFolder the {@link Path} pointing to the folder where to write the content of the given
   *        {@link CodePackage}.
   */
  void write(Path targetFolder);

  /**
   * Recursively writes the {@link net.sf.mmm.code.api.item.CodeItem#getSourceCode() source code} of this item
   * recursively with all its children to the folder identified by the given {@link Path}.
   *
   * @param targetFolder the {@link Path} pointing to the folder where to write the content of the given
   *        {@link CodePackage}.
   * @param encoding the {@link Charset} used to encode the characters in the file.
   */
  void write(Path targetFolder, Charset encoding);

}