io.virtdata.libbasics.shared.stateful.ClearAutoDocsInfo 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.stateful;

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

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

  public String getClassJavadoc() {
    return "Clears the per-thread map which is used by the Expr function.\n";
  }

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

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

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

  public List getCtors() {
    return new ArrayList() {{
          add(new DocForFuncCtor("Clear", "Clear all named entries from the per-thread map.\n", 
            new LinkedHashMap() {{
            }},
            new ArrayList>() {{
              add(new ArrayList() {{
                add("Clear()");
                add("clear all thread-local variables");
              }});
            }}
          ));
          add(new DocForFuncCtor("Clear", "Clear the specified names from the per-thread map.\n"
              + "@param names The names to be removed from the map.\n", 
            new LinkedHashMap() {{
              put("names","java.lang.String[]...");
            }},
            new ArrayList>() {{
              add(new ArrayList() {{
                add("Clear('foo')");
                add("clear the thread-local variable 'foo'");
              }});
              add(new ArrayList() {{
                add("Clear('foo','bar')");
                add("clear the thread-local variables 'foo' and 'bar'");
              }});
            }}
          ));
        }};
  }
}