io.virtdata.libbasics.shared.stateful.from_long.SwapAutoDocsInfo 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.stateful.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 SwapAutoDocsInfo implements DocFuncData {
  public String getClassName() {
    return "Swap";
  }

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

  public String getClassJavadoc() {
    return "Load a named value from the per-thread state map.\n"
            + "The previous input value will be stored in the named value, and the previously\n"
            + "stored value will be returned. A default value to return may be provided\n"
            + "in case there was no previously stored value under the given name.\n";
  }

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

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

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

  public List getCtors() {
    return new ArrayList() {{
          add(new DocForFuncCtor("Swap", "", 
            new LinkedHashMap() {{
              put("name","java.lang.String");
            }},
            new ArrayList>() {{
              add(new ArrayList() {{
                add("Swap('foo')");
                add("for the current thread, swap the input value with the named variable and returned the named variable");
              }});
            }}
          ));
          add(new DocForFuncCtor("Swap", "", 
            new LinkedHashMap() {{
              put("name","java.lang.String");
              put("defaultValue","java.lang.Object");
            }},
            new ArrayList>() {{
              add(new ArrayList() {{
                add("Swap('foo','examplevalue')");
                add("for the current thread, swap the input value with the named variable and returned the named variable, or return the default value if the named value is not defined.");
              }});
            }}
          ));
          add(new DocForFuncCtor("Swap", "", 
            new LinkedHashMap() {{
              put("nameFunc","java.util.function.LongFunction");
            }},
            new ArrayList>() {{
              add(new ArrayList() {{
                add("Swap(NumberNameToString())");
                add("for the current thread, swap the input value with the named variable and returned the named variable, where the variable name is generated by the provided function.");
              }});
            }}
          ));
          add(new DocForFuncCtor("Swap", "", 
            new LinkedHashMap() {{
              put("nameFunc","java.util.function.LongFunction");
              put("defaultValue","java.lang.Object");
            }},
            new ArrayList>() {{
              add(new ArrayList() {{
                add("Swap(NumberNameToString(),'examplevalue')");
                add("for the current thread, swap the input value with the named variable and returned the named variable, where the variable name is generated by the provided function, or the default value if the named value is not defined.");
              }});
            }}
          ));
        }};
  }
}