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

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

  public String getClassJavadoc() {
    return "Load a value from a map, based on the injected configuration.\n"
            + "The map which is used must be named by the mapname.\n"
            + "If the injected configuration contains a variable of this name\n"
            + "which is also a Map, then this map is referenced and read\n"
            + "by the provided variable name.\n";
  }

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

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

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

  public List getCtors() {
    return new ArrayList() {{
          add(new DocForFuncCtor("LoadElement", "", 
            new LinkedHashMap() {{
              put("varname","java.lang.String");
              put("mapname","java.lang.String");
              put("defaultValue","java.lang.Object");
            }},
            new ArrayList>() {{
              add(new ArrayList() {{
                add("LoadElement('varname','vars','defaultvalue')");
                add("Load the varable 'varname' from a map named 'vars', or provide 'defaultvalue' if neither is provided");
              }});
            }}
          ));
        }};
  }
}