com.android.builder.merge

Class RenameIncrementalFileMergerInput

java.lang.Object

com.android.builder.merge.DelegateIncrementalFileMergerInput

com.android.builder.merge.RenameIncrementalFileMergerInput

All Implemented Interfaces:

IncrementalFileMergerInput, OpenableCloseable

public class RenameIncrementalFileMergerInput
extends DelegateIncrementalFileMergerInput

IncrementalFileMergerInput that renames files in another input according to a renaming function. This means that the actual paths of the files reported have been transformed.

For example, a rename input that prepends a/ to the files created over an input that has file b, will report having file a/b. Opening file a/b will effectively open file b.

The rename input will effectively create a view over another input in which files have been renamed according to an injective function. Because name transformation needs to occur in both directions, for example, it is necessary to transform b into a/b and a/b back into b, the rename input needs to receive two functions: the transformation function and its inverse.

Both rename and inverse rename functions are assumed to be stable, that is, the transformations should always yield the same output for the same input.

Constructor Summary

Constructors

Constructor and Description
RenameIncrementalFileMergerInput(IncrementalFileMergerInput input, java.util.function.Function<java.lang.String,java.lang.String> rename, java.util.function.Function<java.lang.String,java.lang.String> inverseRename) Creates a new input.

Method Summary

Modifier and Type	Method and Description
com.google.common.collect.ImmutableSet<java.lang.String>	getAllPaths() Obtains all OS-independent paths of all files that in this input, regardless of being changed or not.
com.android.ide.common.res2.FileStatus	getFileStatus(java.lang.String path) Obtains the status of a path in this input.
com.google.common.collect.ImmutableSet<java.lang.String>	getUpdatedPaths() Obtains all OS-independent paths of all files that were changed in this input.
java.io.InputStream	openPath(java.lang.String path) Opens a path for reading.

Methods inherited from class com.android.builder.merge.DelegateIncrementalFileMergerInput

close, getName, open

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RenameIncrementalFileMergerInput

public RenameIncrementalFileMergerInput(@NonNull
                                        IncrementalFileMergerInput input,
                                        @NonNull
                                        java.util.function.Function<java.lang.String,java.lang.String> rename,
                                        @NonNull
                                        java.util.function.Function<java.lang.String,java.lang.String> inverseRename)

Creates a new input.

Parameters:

input - the input that serves as input for this one

rename - the function that renames paths as they are reported by input to whatever this input should return as paths; the function should be bijective

inverseRename - the function that provides the inverse of rename

Method Detail

getUpdatedPaths

@NonNull
public com.google.common.collect.ImmutableSet<java.lang.String> getUpdatedPaths()

Description copied from interface: IncrementalFileMergerInput

Obtains all OS-independent paths of all files that were changed in this input.

Specified by:

getUpdatedPaths in interface IncrementalFileMergerInput

Overrides:

getUpdatedPaths in class DelegateIncrementalFileMergerInput

Returns:

the paths, may be empty if no paths were changed

getAllPaths

@NonNull
public com.google.common.collect.ImmutableSet<java.lang.String> getAllPaths()

Description copied from interface: IncrementalFileMergerInput

Obtains all OS-independent paths of all files that in this input, regardless of being changed or not.

Specified by:

getAllPaths in interface IncrementalFileMergerInput

Overrides:

getAllPaths in class DelegateIncrementalFileMergerInput

Returns:

the paths, may be empty if the relative tree of this input is empty

getFileStatus

@Nullable
public com.android.ide.common.res2.FileStatus getFileStatus(@NonNull
                                                                      java.lang.String path)

Description copied from interface: IncrementalFileMergerInput

Obtains the status of a path in this input.

Specified by:

getFileStatus in interface IncrementalFileMergerInput

Overrides:

getFileStatus in class DelegateIncrementalFileMergerInput

Parameters:

path - the OS-independent path; the path may or not exist in the input

Returns:

the status of the path or null if the path does not exist in the input or if the path has not been changed; null is returned if and only if !getUpdatedPaths().contains(path)

openPath

@NonNull
public java.io.InputStream openPath(@NonNull
                                             java.lang.String path)

Description copied from interface: IncrementalFileMergerInput

Opens a path for reading. This method should only be called when the input is open.

Specified by:

openPath in interface IncrementalFileMergerInput

Overrides:

openPath in class DelegateIncrementalFileMergerInput

Parameters:

path - the path

Returns:

the input stream that should be closed by the caller before OpenableCloseable.close() is called