io.virtdata.libbasics.shared.functionadapters.ToLongFunctionAutoDocsInfo Maven / Gradle / Ivy

Go to download

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.functionadapters;

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

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

  public String getClassJavadoc() {
    return "Adapts any compatible {@link FunctionalInterface} type to a LongFunction,\n"
            + "for use with higher-order functions, when they require a\n"
            + "LongFunction as an argument. Some of the higher-order functions within\n"
            + "this library specifically require a LongFunction as an argument, while\n"
            + "some of the other functions are provided in semantically equivalent\n"
            + "forms with compatible types which can't be converted directly or\n"
            + "automatically by Java.\n"
            + "\n"
            + "In such cases, those types of functions can be wrapped with the forms\n"
            + "described here in order to allow the inner and outer functions to work together.\n";
  }

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

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

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

  public List getCtors() {
    return new ArrayList() {{
          add(new DocForFuncCtor("ToLongFunction", "", 
            new LinkedHashMap() {{
              put("op","java.util.function.LongUnaryOperator");
            }},
            new ArrayList>() {{
            }}
          ));
          add(new DocForFuncCtor("ToLongFunction", "", 
            new LinkedHashMap() {{
              put("op","java.util.function.Function");
            }},
            new ArrayList>() {{
            }}
          ));
          add(new DocForFuncCtor("ToLongFunction", "", 
            new LinkedHashMap() {{
              put("op","java.util.function.LongToIntFunction");
            }},
            new ArrayList>() {{
            }}
          ));
          add(new DocForFuncCtor("ToLongFunction", "", 
            new LinkedHashMap() {{
              put("op","java.util.function.LongToDoubleFunction");
            }},
            new ArrayList>() {{
            }}
          ));
          add(new DocForFuncCtor("ToLongFunction", "", 
            new LinkedHashMap() {{
              put("func","java.util.function.LongFunction");
            }},
            new ArrayList>() {{
            }}
          ));
        }};
  }
}