io.virtdata.libbasics.shared.from_long.to_time_types.StartingEpochMillisAutoDocsInfo 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.from_long.to_time_types;

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

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

  public String getClassJavadoc() {
    return "This function sets the minimum long value to the equivalent\n"
            + "unix epoch time in milliseconds. It simply adds the input\n"
            + "value to this base value as determined by the provided\n"
            + "time specifier. It wraps any overflow within this range as well.\n";
  }

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

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

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

  public List getCtors() {
    return new ArrayList() {{
          add(new DocForFuncCtor("StartingEpochMillis", "", 
            new LinkedHashMap() {{
              put("baseTimeSpec","java.lang.String");
            }},
            new ArrayList>() {{
              add(new ArrayList() {{
                add("StartingEpochMillis('2017-01-01 23:59:59')");
                add("add the millisecond epoch time of 2017-01-01 23:59:59 to all input values");
              }});
            }}
          ));
        }};
  }
}