Package com.ss.android.ugc.bytex.common.flow

Interface TransformFlow

All Superinterfaces:

java.lang.Iterable<TransformFlow>

All Known Implementing Classes:

AbsTransformFlow, MainTransformFlow

public interface TransformFlow
extends java.lang.Iterable<TransformFlow>

Method Summary

Modifier and Type	Method	Description
default Graph	getClassGraph()	Every TransformFlow(such as MainTransformFlow.But it needs to be generated after t he traverse method is called) has the possibility to build a class diagram
java.io.File	getGraphCache()	返回TransformFlow的Graph缓存文件路径，增量编译需要读取和写入使用 Returns the path of the Graph cache file of TransformFlow,witch is used by incremental compilation
TransformFlow	getNextTransformFlow()
TransformFlow	getPreTransformFlow()
default int	getPriority()	As a ByteX Plugin，it can run as a single Transform（With single TransformFlow）.
default boolean	isLifecycleAware()
default java.lang.String	name()
default void	prepare()	internal only
default void	registerTransformFlowListener(TransformFlowListener listener)
void	run()	internal only
void	setNextTransformFlow(TransformFlow transformFlow)	internal only
void	setPreTransformFlow(TransformFlow transformFlow)	internal only

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Method Detail

name

default java.lang.String name()

prepare

default void prepare()
              throws java.io.IOException,
                     java.lang.InterruptedException

internal only

Throws:

java.io.IOException

java.lang.InterruptedException

run

void run()
  throws java.io.IOException,
         java.lang.InterruptedException

internal only

Throws:

java.io.IOException

java.lang.InterruptedException

getClassGraph

@Nullable
default Graph getClassGraph()

Every TransformFlow(such as MainTransformFlow.But it needs to be generated after t he traverse method is called) has the possibility to build a class diagram

Returns:

Graph. Maybe return null if current transformFlow does not generate the class diagram or class diagram has not been generated yet

getGraphCache

java.io.File getGraphCache()

返回TransformFlow的Graph缓存文件路径，增量编译需要读取和写入使用 Returns the path of the Graph cache file of TransformFlow,witch is used by incremental compilation

setPreTransformFlow

void setPreTransformFlow(TransformFlow transformFlow)

internal only

getPreTransformFlow

@Nullable
TransformFlow getPreTransformFlow()

setNextTransformFlow

void setNextTransformFlow(TransformFlow transformFlow)

internal only

getNextTransformFlow

@Nullable
TransformFlow getNextTransformFlow()

getPriority

default int getPriority()

As a ByteX Plugin，it can run as a single Transform（With single TransformFlow）. Universally， multiple bytex plugins run together in a single Transform. However, there are some plugins or several plugins that require separate running in a single TransformFlow ，so , we will collect and sort all the TransformFlows before running

Returns:

TransformFlow's priority.default is 0.If the priorities are the same, we will sort them in the order of apply

registerTransformFlowListener

default void registerTransformFlowListener(TransformFlowListener listener)
                                    throws java.lang.UnsupportedOperationException

Throws:

java.lang.UnsupportedOperationException

isLifecycleAware

default boolean isLifecycleAware()