io.nosqlbench.virtdata.library.basics.shared.functionadapters.FlowAutoDocsInfo Maven / Gradle / Ivy
// This file is auto-generated.
package io.nosqlbench.virtdata.library.basics.shared.functionadapters;
import io.nosqlbench.nb.annotations.Service;
import io.nosqlbench.virtdata.api.annotations.Category;
import io.nosqlbench.virtdata.api.processors.DocCtorData;
import io.nosqlbench.virtdata.api.processors.DocForFuncCtor;
import io.nosqlbench.virtdata.api.processors.DocFuncData;
import java.lang.String;
import java.util.ArrayList;
import java.util.LinkedHashMap;
import java.util.List;
@Service(
value = DocFuncData.class,
selector = "io.nosqlbench.virtdata.library.basics.shared.functionadapters.Flow"
)
public class FlowAutoDocsInfo implements DocFuncData {
public String getClassName() {
return "Flow";
}
public String getPackageName() {
return "io.nosqlbench.virtdata.library.basics.shared.functionadapters";
}
public String getClassJavadoc() {
return "Combine functions into one.
\n"
+ "\n"
+ "This function allows you to combine multiple other functions into one. This is often useful\n"
+ "for constructing more sophisticated recipes, when you don't have the ability to use\n"
+ "control flow or non-functional forms.
\n"
+ "\n"
+ "The functions will be stitched together using the same logic that VirtData uses when\n"
+ "combining flows outside functions. That said, if the functions selected are not the right ones,\n"
+ "then it is possible to end up with the wrong data type at the end. To remedy this, be sure\n"
+ "to add input and output qualifiers, like long-> or ->String where\n"
+ "appropriate, to ensure that VirtData selects the right functions within the flow.
\n";
}
public String getInType() {
return "long";
}
public String getOutType() {
return "java.lang.Object";
}
public Category[] getCategories() {
return new Category[] { Category.conversion };
}
public List getCtors() {
return new ArrayList() {{
add(new DocForFuncCtor("Flow", "",
new LinkedHashMap() {{
put("funcs","java.lang.Object[]...");
}},
new ArrayList>() {{
}}
));
}};
}
}