io.virtdata.libbasics.shared.formatting.FormatAutoDocsInfo 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.formatting;

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

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

  public String getClassJavadoc() {
    return "Apply the Java String.format method to an incoming object.\n"
            + "@see Java 8 String.format(...) javadoc\n"
            + "Note: This function can often be quite slow, so more direct methods are generally preferrable.\n";
  }

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

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

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

  public List getCtors() {
    return new ArrayList() {{
          add(new DocForFuncCtor("Format", "", 
            new LinkedHashMap() {{
              put("format","java.lang.String");
            }},
            new ArrayList>() {{
              add(new ArrayList() {{
                add("Format('Y')");
                add("Yield the formatted year from a Java date object.");
              }});
            }}
          ));
        }};
  }
}