io.nosqlbench.virtdata.library.basics.shared.unary_string.URLEncodeAutoDocsInfo Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of virtdata-lib-basics Show documentation

There is a newer version: 5.17.0

// This file is auto-generated.
package io.nosqlbench.virtdata.library.basics.shared.unary_string;

import io.nosqlbench.nb.annotations.Service;
import io.nosqlbench.virtdata.api.annotations.Category;
import io.nosqlbench.virtdata.api.processors.DocCtorData;
import io.nosqlbench.virtdata.api.processors.DocForFuncCtor;
import io.nosqlbench.virtdata.api.processors.DocFuncData;
import java.lang.String;
import java.util.ArrayList;
import java.util.LinkedHashMap;
import java.util.List;

@Service(
    value = DocFuncData.class,
    selector = "io.nosqlbench.virtdata.library.basics.shared.unary_string.URLEncode"
)
public class URLEncodeAutoDocsInfo implements DocFuncData {
  public String getClassName() {
    return "URLEncode";
  }

  public String getPackageName() {
    return "io.nosqlbench.virtdata.library.basics.shared.unary_string";
  }

  public String getClassJavadoc() {
    return "URLEncode string data\n";
  }

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

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

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

  public List getCtors() {
    return new ArrayList() {{
          add(new DocForFuncCtor("URLEncode", "UrlEncode any incoming string using the specified charset.\n"
              + "\n"
              + "@param charset A valid character set name from {@link Charset}\n", 
            new LinkedHashMap() {{
              put("charset","java.lang.String");
            }},
            new ArrayList>() {{
              add(new ArrayList() {{
                add("URLEncode('UTF-16')");
                add("URLEncode using the UTF-16 charset.");
              }});
            }}
          ));
          add(new DocForFuncCtor("URLEncode", "", 
            new LinkedHashMap() {{
            }},
            new ArrayList>() {{
              add(new ArrayList() {{
                add("URLEncode()");
                add("URLEncode using the default UTF-8 charset.");
              }});
            }}
          ));
        }};
  }
}