com.android.ide.common.res2

Interface ResourceCompiler

All Known Subinterfaces:

QueueableResourceCompiler

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface
public interface ResourceCompiler

Compiler that will process individual resource files. A compiler will produce an optional output file for an input file.

Field Summary

Fields

Modifier and Type	Field and Description
static ResourceCompiler	NONE Resource compiler that doesn't do anything.

Method Summary

Modifier and Type	Method and Description
com.google.common.util.concurrent.ListenableFuture<java.io.File>	compile(java.io.File file, java.io.File output) Produces an optional output file for an input file.

Field Detail

NONE

static final ResourceCompiler NONE

Resource compiler that doesn't do anything.

Method Detail

compile

@NonNull
com.google.common.util.concurrent.ListenableFuture<java.io.File> compile(@NonNull
                                                                                  java.io.File file,
                                                                                  @NonNull
                                                                                  java.io.File output)
                                                                           throws java.lang.Exception

Produces an optional output file for an input file. Not all files are compilable. An individual resource compiler will know if a file is compilable or not.

Parameters:

file - the resource file to compile

output - the directory where the compiled file should be placed; the actual output file will be decided by the compiler

Returns:

a future for the output file, which may be produced asynchronously; if the future is computed as null, then the file is not compilable; this future may hol an exception if compilation fails

Throws:

java.lang.Exception - failed to process the compilation request