io.nosqlbench.virtdata.library.basics.shared.stateful.UnsetOrPassAutoDocsInfo 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

The newest version!

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

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.stateful.UnsetOrPass"
)
public class UnsetOrPassAutoDocsInfo implements DocFuncData {
  public String getClassName() {
    return "UnsetOrPass";
  }

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

  public String getClassJavadoc() {
    return "Reads a long variable from the thread local variable map, hashes and scales it\n"
            + "to the unit interval 0.0d - 1.0d, then uses the result to determine whether\n"
            + "to return UNSET.value or the input value.\n";
  }

  public String getInType() {
    return "java.lang.Object";
  }

  public String getOutType() {
    return "java.lang.Object";
  }

  public Category[] getCategories() {
    return new Category[] { Category.state,Category.nulls };
  }

  public List getCtors() {
    return new ArrayList() {{
          add(new DocForFuncCtor("UnsetOrPass", "", 
            new LinkedHashMap() {{
              put("ratio","double");
              put("varname","java.lang.String");
            }},
            new ArrayList>() {{
            }}
          ));
        }};
  }
}