io.virtdata.libbasics.shared.from_long.to_string.DirectoryLinesAutoDocsInfo 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 DirectoryLinesAutoDocsInfo implements DocFuncData {
  public String getClassName() {
    return "DirectoryLines";
  }

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

  public String getClassJavadoc() {
    return "Read each line in each matching file in a directory structure, providing one\n"
            + "line for each time this function is called. The files are sorted at the time\n"
            + "the function is initialized, and each line is read in order.\n"
            + "\n"
            + "This function does not produce the same result per cycle value. It is possible\n"
            + "that different cycle inputs will return different inputs if the cycles are not\n"
            + "applied in strict order. Still, this function is useful for consuming input\n"
            + "from a set of files as input to a test or simulation.\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("DirectoryLines", "", 
            new LinkedHashMap() {{
              put("basepath","java.lang.String");
              put("namePattern","java.lang.String");
            }},
            new ArrayList>() {{
              add(new ArrayList() {{
                add("DirectoryLines('/var/tmp/bardata', '.*')");
                add("load every line from every file in /var/tmp/bardata");
              }});
            }}
          ));
        }};
  }
}