io.nosqlbench.virtdata.library.basics.shared.unary_int.HashIntervalAutoDocsInfo Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of virtdata-lib-basics Show documentation

There is a newer version: 5.17.0

// This file is auto-generated.
package io.nosqlbench.virtdata.library.basics.shared.unary_int;

import io.nosqlbench.nb.annotations.Service;
import io.nosqlbench.virtdata.api.annotations.Category;
import io.nosqlbench.virtdata.api.processors.DocCtorData;
import io.nosqlbench.virtdata.api.processors.DocForFuncCtor;
import io.nosqlbench.virtdata.api.processors.DocFuncData;
import java.lang.String;
import java.util.ArrayList;
import java.util.LinkedHashMap;
import java.util.List;

@Service(
    value = DocFuncData.class,
    selector = "io.nosqlbench.virtdata.library.basics.shared.unary_int.HashInterval"
)
public class HashIntervalAutoDocsInfo implements DocFuncData {
  public String getClassName() {
    return "HashInterval";
  }

  public String getPackageName() {
    return "io.nosqlbench.virtdata.library.basics.shared.unary_int";
  }

  public String getClassJavadoc() {
    return "";
  }

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

  public String getOutType() {
    return "int";
  }

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

  public List getCtors() {
    return new ArrayList() {{
          add(new DocForFuncCtor("HashInterval", "Create a hash interval based on a minimum value of 0 and a specified width.\n"
              + "@param width The maximum value, which is excluded.\n", 
            new LinkedHashMap() {{
              put("width","int");
            }},
            new ArrayList>() {{
              add(new ArrayList() {{
                add("HashInterval(4)");
                add("return values which could include 0, 1, 2, 3, but not 4");
              }});
            }}
          ));
          add(new DocForFuncCtor("HashInterval", "Create a hash interval\n"
              + "@param minIncl The minimum value, which is included\n"
              + "@param maxExcl The maximum value, which is excluded\n", 
            new LinkedHashMap() {{
              put("minIncl","int");
              put("maxExcl","int");
            }},
            new ArrayList>() {{
              add(new ArrayList() {{
                add("HashInterval(2,5)");
                add("return values which could include 2, 3, 4, but not 5");
              }});
            }}
          ));
        }};
  }
}