io.virtdata.libbasics.shared.stateful.LoadAutoDocsInfo 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.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 LoadAutoDocsInfo implements DocFuncData {
  public String getClassName() {
    return "Load";
  }

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

  public String getClassJavadoc() {
    return "Load a named value from the per-thread state map.\n"
            + "The previous input value will be forgotten, and the named value will replace it\n"
            + "before the next function in the chain.\n";
  }

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

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

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

  public List getCtors() {
    return new ArrayList() {{
          add(new DocForFuncCtor("Load", "", 
            new LinkedHashMap() {{
              put("name","java.lang.String");
            }},
            new ArrayList>() {{
              add(new ArrayList() {{
                add("Load('foo')");
                add("for the current thread, load an Object value from the named variable");
              }});
            }}
          ));
          add(new DocForFuncCtor("Load", "", 
            new LinkedHashMap() {{
              put("nameFunc","java.util.function.Function");
            }},
            new ArrayList>() {{
              add(new ArrayList() {{
                add("Load(NumberNameToString())");
                add("for the current thread, load an Object value from the named variable, where the variable name is returned by the provided function");
              }});
            }}
          ));
          add(new DocForFuncCtor("Load", "", 
            new LinkedHashMap() {{
              put("name","java.lang.String");
              put("defaultValue","java.lang.Object");
            }},
            new ArrayList>() {{
              add(new ArrayList() {{
                add("Load('foo','testvalue')");
                add("for the current thread, load an Object value from the named variable, or the default value if the variable is not yet defined.");
              }});
            }}
          ));
          add(new DocForFuncCtor("Load", "", 
            new LinkedHashMap() {{
              put("nameFunc","java.util.function.Function");
              put("defaultValue","java.lang.Object");
            }},
            new ArrayList>() {{
              add(new ArrayList() {{
                add("Load(NumberNameToString(),'testvalue')");
                add("for the current thread, load an Object value from the named variable, where the variable name is returned by the provided function, or thedefault value if the variable is not yet defined.");
              }});
            }}
          ));
        }};
  }
}