io.virtdata.libbasics.shared.from_long.to_string.CombinationsAutoDocsInfo 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_string;

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

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

  public String getClassJavadoc() {
    return "Convert a numeric value into a code according to ASCII printable\n"
            + "characters. This is useful for creating various encodings using different\n"
            + "character ranges, etc.\n"
            + "\n"
            + "This mapper can map over the sequences of character ranges providing every unique\n"
            + "combination and then wrapping around to the beginning again.\n"
            + "It can convert between character bases with independent radix in each position.\n"
            + "Each position in the final string takes its values from a position-specific\n"
            + "character set, described by the shorthand in the examples below.\n"
            + "\n"
            + "The constructor will throw an error if the number of combinations exceeds that\n"
            + "which can be represented in a long value. (This is a very high number).\n";
  }

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

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

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

  public List getCtors() {
    return new ArrayList() {{
          add(new DocForFuncCtor("Combinations", "", 
            new LinkedHashMap() {{
              put("spec","java.lang.String");
            }},
            new ArrayList>() {{
              add(new ArrayList() {{
                add("Combinations('A-Z;A-Z')");
                add("a two digit alphanumeric code. Wraps at 26^2");
              }});
              add(new ArrayList() {{
                add("Combinations('0-9A-F')");
                add("a single hexadecimal digit");
              }});
              add(new ArrayList() {{
                add("Combinations('0123456789ABCDEF')");
                add("a single hexadecimal digit");
              }});
              add(new ArrayList() {{
                add("Combinations('0-9A-F;0-9A-F;0-9A-F;0-9A-F;')");
                add("two bytes of hexadecimal");
              }});
              add(new ArrayList() {{
                add("Combinations('A-9')");
                add("upper case alphanumeric");
              }});
            }}
          ));
        }};
  }
}