public abstract class CreateFrameRecipe<T extends CreateFrameRecipe<T>> extends Iced<T>
Constructor and Description |
---|
CreateFrameRecipe() |
Modifier and Type | Method and Description |
---|---|
protected abstract void |
buildRecipe(CreateFrameExecutor cfe)
Set up the provided
CreateFrameExecutor so that it knows how to
construct the frame corresponding to the recipe being built. |
protected void |
check(boolean test,
java.lang.String msg)
Simple helper function for parameter testing.
|
protected abstract void |
checkParametersValidity()
Test whether the input parameters are valid, and throw error if they
aren't.
|
protected void |
checkParametersValidity2(CreateFrameExecutor cfe)
Final step of parameter testing, after the
CreateFrameExecutor
has been set up, but just before the actual frame creation commences. |
Job<Frame> |
exec()
This function will be called by the REST API handler to initiate making
of the recipe.
|
protected void |
fillMissingParameters()
Resolve parameter values that cannot be initialized to static defaults.
|
asBytes, clone, copyOver, frozenType, read, readExternal, readJSON, reloadFromBytes, toJsonString, write, writeExternal, writeJSON
protected abstract void checkParametersValidity()
check(boolean, String)
helper function
to make this somewhat easier.protected abstract void buildRecipe(CreateFrameExecutor cfe)
CreateFrameExecutor
so that it knows how to
construct the frame corresponding to the recipe being built.public Job<Frame> exec()
Job
which will hold the created frame
once it is finished.protected void fillMissingParameters()
protected void checkParametersValidity2(CreateFrameExecutor cfe)
CreateFrameExecutor
has been set up, but just before the actual frame creation commences.
This method shall only be used to perform checks that cannot be done
without the CreateFrameExecutor
instance.protected void check(boolean test, java.lang.String msg)