net.sf.jelly.apt.strategies.FileStrategy Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of apt-jelly-core
Core support for APT-Jelly
The newest version!
/*
 * Copyright 2006 Ryan Heaton
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package net.sf.jelly.apt.strategies;

import com.sun.mirror.apt.AnnotationProcessorEnvironment;
import com.sun.mirror.apt.Filer;

import java.io.File;
import java.io.PrintWriter;
import java.io.IOException;

import net.sf.jelly.apt.Context;
import net.sf.jelly.apt.TemplateBlock;

/**
 * Strategy for getting the output to a new file relative to the output directory specified for APT.
 *
 * @author Ryan Heaton
 */
public class FileStrategy extends TemplateOutputRedirectionStrategy {

  private String name;
  private String pkg = "";
  private String charset;

  /**
   * Return the writer to the specified file.
   *
   * @return The writer to the specified file.
   */
  public PrintWriter getWriter() throws IOException, MissingParameterException {
    if (getName() == null) {
      throw new MissingParameterException("name");
    }

    AnnotationProcessorEnvironment env = getAnnotationProcessorEnvironment();
    return env.getFiler().createTextFile(Filer.Location.SOURCE_TREE, pkg, new File(getName()), charset);
  }

  /**
   * The current annotation processor environment.
   *
   * @return The current annotation processor environment.
   */
  protected AnnotationProcessorEnvironment getAnnotationProcessorEnvironment() {
    return Context.getCurrentEnvironment();
  }

  /**
   * The name of the file.
   *
   * @return The name of the file.
   */
  public String getName() {
    return name;
  }

  /**
   * The name of the file.
   *
   * @param name The name of the file.
   */
  public void setName(String name) {
    this.name = name;
  }

  /**
   * Package relative to which the file should be named, or the empty string if none.
   *
   * @return Package relative to which the file should be named, or the empty string if none.
   */
  public String getPackage() {
    return pkg;
  }

  /**
   * Package relative to which the file should be named, or the empty string if none.
   *
   * @param pkg Package relative to which the file should be named, or the empty string if none.
   */
  public void setPackage(String pkg) {
    this.pkg = pkg;
  }

  /**
   * The name of the charset to use.
   *
   * @return The name of the charset to use.
   */
  public String getCharset() {
    return charset;
  }

  /**
   * The name of the charset to use.
   *
   * @param charset The name of the charset to use.
   */
  public void setCharset(String charset) {
    this.charset = charset;
  }

}