io.virtdata.libbasics.shared.stateful.SaveStringAutoDocsInfo Maven / Gradle / Ivy

Go to download

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.stateful;

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 SaveStringAutoDocsInfo implements DocFuncData {
  public String getClassName() {
    return "SaveString";
  }

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

  public String getClassJavadoc() {
    return "Save a value to a named thread-local variable, where the variable\n"
            + "name is fixed or a generated variable name from a provided function.\n"
            + "Note that the input type is not that suitable for constructing names,\n"
            + "so this is more likely to be used in an indirect naming pattern like\n"
            + "SaveDouble(Load('id'))\n";
  }

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

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

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

  public List getCtors() {
    return new ArrayList() {{
          add(new DocForFuncCtor("SaveString", "", 
            new LinkedHashMap() {{
              put("name","java.lang.String");
            }},
            new ArrayList>() {{
              add(new ArrayList() {{
                add("SaveString('foo')");
                add("save the current String value to a named variable in this thread.");
              }});
            }}
          ));
          add(new DocForFuncCtor("SaveString", "", 
            new LinkedHashMap() {{
              put("nameFunc","java.util.function.Function");
            }},
            new ArrayList>() {{
              add(new ArrayList() {{
                add("SaveString(NumberNameToString())");
                add("save the current String value to a named variable in this thread, where the variable name is provided by a function.");
              }});
            }}
          ));
        }};
  }
}