io.toolisticon.aptk.tools.FilerUtils Maven / Gradle / Ivy

Go to download
package io.toolisticon.aptk.tools;


import io.toolisticon.aptk.tools.generators.SimpleJavaWriter;
import io.toolisticon.aptk.tools.generators.SimpleKotlinWriter;
import io.toolisticon.aptk.tools.generators.SimpleResourceReader;
import io.toolisticon.aptk.tools.generators.SimpleResourceWriter;

import javax.lang.model.element.Element;
import javax.tools.StandardLocation;
import java.io.IOException;

/**
 * Utility class for handling {@link javax.tools.FileObject}.
 */
public final class FilerUtils {


    /**
     * Hidden constructor that prevents instantiation.
     */
    private FilerUtils() {
    }

    /**
     * Gets a SimpleResourceReader for reading a resource file.
     *
     * @param targetPackage the target package
     * @param fileName      the file name of the resource to be opened
     * @return SimpleResourceReader if resource exists and can be read (== not opened for writing)
     * @throws IOException if resource couldn't be read
     */
    public static SimpleResourceReader getResource(String fileName, String targetPackage) throws IOException {
        return getResource(StandardLocation.SOURCE_OUTPUT, targetPackage, fileName);
    }

    /**
     * Gets a SimpleResourceReader for reading a resource file.
     *
     * @param standardLocation the location to read the resource from
     * @param targetPackage    the target package
     * @param fileName         the file name of the resource to be opened
     * @return SimpleResourceReader if resource exists and can be read (== not opened for writing)
     * @throws IOException if resource couldn't be read
     */
    public static SimpleResourceReader getResource(StandardLocation standardLocation, String targetPackage, String fileName) throws IOException {
        return new SimpleResourceReader(ProcessingEnvironmentUtils.getFiler().getResource(standardLocation, targetPackage != null ? targetPackage : "", fileName));
    }

    /**
     * Gets a SimpleResourceReader for reading a resource file.
     *
     * @param fileName the file name of the resource to be opened
     * @return SimpleResourceReader if resource exists and can be read (== not opened for writing)
     * @throws IOException if resource couldn't be read
     */
    public static SimpleResourceReader getResource(String fileName) throws IOException {
        return getResource("", fileName);
    }

    /**
     * Creates a resource file resident in CLASS_OUTPUT in root package with give name.
     *
     * @param targetPackage       the target package to use
     * @param fileName            the file name to use
     * @param originatingElements the originating elements responsible for resource file creation.
     * @return SimpleResourceWriter if it hasn't been created before.
     * @throws IOException                                if resource couldn't be created
     * @throws javax.annotation.processing.FilerException if the same pathname has already been created
     */
    public static SimpleResourceWriter createResource(String targetPackage, String fileName, Element... originatingElements) throws IOException {
        return createResource(StandardLocation.CLASS_OUTPUT, targetPackage, fileName);
    }

    /**
     * Creates a resource file resident in passed location in root package with give name.
     *
     * @param location            the location to write the file to.
     * @param targetPackage       the target package to use
     * @param fileName            the file name to use
     * @param originatingElements the originating elements responsible for resource file creation.
     * @return SimpleResourceWriter if it hasn't been created before.
     * @throws IOException                                if resource couldn't be created
     * @throws javax.annotation.processing.FilerException if the same pathname has already been created
     */
    public static SimpleResourceWriter createResource(StandardLocation location, String targetPackage, String fileName, Element... originatingElements) throws IOException {
        return new SimpleResourceWriter(ProcessingEnvironmentUtils.getFiler().createResource(location, targetPackage != null ? targetPackage : "", fileName, originatingElements));
    }

    /**
     * Creates a resource file resident in CLASS_OUTPUT in root package with give name.
     *
     * @param fileName the file name to use
     * @return SimpleResourceWriter if it hasn't been created before.
     * @throws IOException                                if resource couldn't be created
     * @throws javax.annotation.processing.FilerException if the same pathname has already been created
     */
    public static SimpleResourceWriter createResource(String fileName) throws IOException {
        return createResource("", fileName);
    }


    /**
     * Creates a class file writer.
     *
     * @param fileName            the filename to use
     * @param originatingElements the element which originates the creation of the class file
     * @return a SimpleJavaWriter that can be used to write java classes
     * @throws IOException is thrown if writer can't be created
     */
    public static SimpleJavaWriter createClassFile(String fileName, Element... originatingElements) throws IOException {
        return new SimpleJavaWriter(ProcessingEnvironmentUtils.getFiler().createClassFile(fileName, originatingElements));
    }

    /**
     * Creates a java source file writer.
     *
     * @param fileName            the canonical name of the class to create
     * @param originatingElements the element which originates the creation of the source file
     * @return a SimpleJavaWriter that can be used to write java source code
     * @throws IOException is thrown if writer can't be created
     */
    public static SimpleJavaWriter createSourceFile(String fileName, Element... originatingElements) throws IOException {
        return new SimpleJavaWriter(ProcessingEnvironmentUtils.getFiler().createSourceFile(fileName, originatingElements));
    }

    /**
     * Creates a kotlin source file.
     * Compilation will fail if the kapt plugin isn't used properly (kapt.kotlin.generated must be configured in compiler options)
     *
     * @param fileName            the canonical name of the class to create
     * @param originatingElements the element which originates the creation of the source file
     * @return a SimpleJavaWriter that can be used to write java source code
     * @throws IOException is thrown if writer can't be created
     */
    public static SimpleKotlinWriter createKotlinSourceFile(String fileName, Element... originatingElements) throws IOException {
        return new SimpleKotlinWriter(fileName, originatingElements);
    }

}