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

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

  public String getClassJavadoc() {
    return "Pseudo-randomly extract a section of a text file and return it according to some\n"
            + "minimum and maximum extract size. The file is loaded into memory as a shared\n"
            + "text image. It is then indexed into as a character buffer to find a pseudo-randomly\n"
            + "sized fragment.\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("HashedFileExtractToString", "", 
            new LinkedHashMap() {{
              put("fileName","java.lang.String");
              put("minsize","int");
              put("maxsize","int");
            }},
            new ArrayList>() {{
              add(new ArrayList() {{
                add("HashedFileExtractToString('data/adventures.txt',100,200)");
                add("return a fragment from adventures.txt between 100 and 200 characters long");
              }});
            }}
          ));
        }};
  }
}