io.virtdata.libbasics.shared.from_long.to_collection.SetAutoDocsInfo 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_collection;

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

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

  public String getClassJavadoc() {
    return "Create a {@code Set} from a long input based on two functions,\n"
            + "the first to determine the set size, and the second to populate\n"
            + "the set with object values. The input fed to the second function\n"
            + "is incremented between elements.\n"
            + "\n"
            + "To create Sets of Strings from the String version of the same\n"
            + "mapping functions, simply use {@link StringSet} instead.\n";
  }

  public String getInType() {
    return "long";
  }

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

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

  public List getCtors() {
    return new ArrayList() {{
          add(new DocForFuncCtor("Set", "", 
            new LinkedHashMap() {{
              put("sizeFunc","java.util.function.LongToIntFunction");
              put("valueFunc","java.util.function.LongFunction");
            }},
            new ArrayList>() {{
              add(new ArrayList() {{
                add("Set(HashRange(3,7),Add(15L))");
                add("create a set between 3 and 7 elements of Long values");
              }});
            }}
          ));
        }};
  }
}