io.virtdata.libbasics.shared.from_long.to_collection.StringSetAutoDocsInfo 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_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 StringSetAutoDocsInfo implements DocFuncData {
  public String getClassName() {
    return "StringSet";
  }

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

  public String getClassJavadoc() {
    return "Create a {@code Set} from a long\n"
            + "based on two functions, the first to\n"
            + "determine the set size, and the second to populate the set with\n"
            + "String values. The input fed to the second function is incremented\n"
            + "between elements. Regardless of the object type provided by the\n"
            + "second function, {@link java.lang.Object#toString()} is used to get\n"
            + "the value to add to the list.\n"
            + "\n"
            + "To create Sets of any type of object simply use {@link Set} with\n"
            + "a specific value mapping function.\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("StringSet", "", 
            new LinkedHashMap() {{
              put("sizeFunc","java.util.function.LongToIntFunction");
              put("valueFunc","java.util.function.LongFunction");
            }},
            new ArrayList>() {{
              add(new ArrayList() {{
                add("StringSet(HashRange(3,7),Add(15L))");
                add("create a set between 3 and 7 elements of String representations of Long values");
              }});
            }}
          ));
        }};
  }
}