io.virtdata.libbasics.shared.conversions.from_long.ToIntAutoDocsInfo 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.conversions.from_long;

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

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

  public String getClassJavadoc() {
    return "Convert the input value to an int with long modulus remainder.\n"
            + "If the scale is chosen, then the value is wrapped at this value.\n"
            + "Otherwise, {@link Integer#MAX_VALUE} is used.\n";
  }

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

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

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

  public List getCtors() {
    return new ArrayList() {{
          add(new DocForFuncCtor("ToInt", "", 
            new LinkedHashMap() {{
              put("scale","int");
            }},
            new ArrayList>() {{
              add(new ArrayList() {{
                add("ToInt(1000)");
                add("converts a long input value to an int between 0 and 999, inclusive");
              }});
            }}
          ));
          add(new DocForFuncCtor("ToInt", "", 
            new LinkedHashMap() {{
            }},
            new ArrayList>() {{
              add(new ArrayList() {{
                add("ToInt()");
                add("converts a long input value to an int between 0 and 2147483647, inclusive ");
              }});
            }}
          ));
        }};
  }
}