io.virtdata.libbasics.shared.from_long.to_string.TemplateAutoDocsInfo Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of virtdata-lib-realer Show documentation
With inspiration from other libraries
There is a newer version: 2.12.15
// This file is auto-generated.
package io.virtdata.libbasics.shared.from_long.to_string;

import io.virtdata.annotations.Category;
import io.virtdata.annotations.Service;
import io.virtdata.processors.DocCtorData;
import io.virtdata.processors.DocForFuncCtor;
import io.virtdata.processors.DocFuncData;
import java.lang.String;
import java.util.ArrayList;
import java.util.LinkedHashMap;
import java.util.List;

@Service(DocFuncData.class)
public class TemplateAutoDocsInfo implements DocFuncData {
  public String getClassName() {
    return "Template";
  }

  public String getPackageName() {
    return "io.virtdata.libbasics.shared.from_long.to_string";
  }

  public String getClassJavadoc() {
    return "Creates a template function which will yield a string which fits the template\n"
            + "provided, with all occurrences of {} substituted pair-wise with the\n"
            + "result of the provided functions. The number of {} entries in the template\n"
            + "must strictly match the number of functions or an error will be thrown.\n"
            + "\n"
            + "The objects passed must be functions of any of the following types:\n"
            + "\n"
            + "    LongUnaryOperator\n"
            + "    IntUnaryOperator\n"
            + "    DoubleUnaryOperator\n"
            + "    LongFunction\n"
            + "    IntFunction\n"
            + "    DoubleFunction\n"
            + "    Function<Long,?>\n"
            + "\n"
            + "\n"
            + "The result of applying the input value to any of these functions is converted to a String\n"
            + "and then stitched together according to the template provided.\n";
  }

  public String getInType() {
    return "long";
  }

  public String getOutType() {
    return "java.lang.String";
  }

  public Category[] getCategories() {
    return new Category[] {  };
  }

  public List getCtors() {
    return new ArrayList() {{
          add(new DocForFuncCtor("Template", "", 
            new LinkedHashMap() {{
              put("template","java.lang.String");
              put("funcs","java.lang.Object[]...");
            }},
            new ArrayList>() {{
              add(new ArrayList() {{
                add("Template('{}-{}',Add(10),Hash())");
                add("concatenate input+10, '-', and a pseudo-random long");
              }});
            }}
          ));
          add(new DocForFuncCtor("Template", "", 
            new LinkedHashMap() {{
              put("truncate","boolean");
              put("template","java.lang.String");
              put("funcs","java.lang.Object[]...");
            }},
            new ArrayList>() {{
              add(new ArrayList() {{
                add("Template(true, '{}-{}', Add(10),Hash())");
                add("throws an error, as the Add(10) function causes a narrowing conversion for a long input");
              }});
            }}
          ));
          add(new DocForFuncCtor("Template", "If an operator is provided, it is used to change the function input value in an additional way before each function.\n"
              + "\n"
              + "@param iterOp   A pre-generation value mapping function\n"
              + "@param template A string template containing {} anchors\n"
              + "@param funcs    A varargs length of LongFunctions of any output type\n", 
            new LinkedHashMap() {{
              put("iterOp","java.util.function.LongUnaryOperator");
              put("template","java.lang.String");
              put("funcs","java.util.function.LongFunction[]...");
            }},
            new ArrayList>() {{
            }}
          ));
        }};
  }
}