io.nosqlbench.virtdata.library.basics.shared.unary_int.CycleRangeAutoDocsInfo 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.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.CycleRange"
)
public class CycleRangeAutoDocsInfo implements DocFuncData {
  public String getClassName() {
    return "CycleRange";
  }

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

  public String getClassJavadoc() {
    return "Yields a value within a specified range, which rolls over continuously.\n";
  }

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

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

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

  public List getCtors() {
    return new ArrayList() {{
          add(new DocForFuncCtor("CycleRange", "Sets the maximum value of the cycle range. The minimum is default to 0.\n"
              + "@param maxValue The maximum value in the cycle to be added.\n", 
            new LinkedHashMap() {{
              put("maxValue","int");
            }},
            new ArrayList>() {{
              add(new ArrayList() {{
                add("CycleRange(34)");
                add("add a rotating value between 0 and 34 to the input");
              }});
            }}
          ));
          add(new DocForFuncCtor("CycleRange", "Sets the minimum and maximum value of the cycle range.\n"
              + "@param minValue minimum value of the cycle to be added.\n"
              + "@param maxValue maximum value of the cycle to be added.\n", 
            new LinkedHashMap() {{
              put("minValue","int");
              put("maxValue","int");
            }},
            new ArrayList>() {{
            }}
          ));
        }};
  }
}