io.wisetime.connector.template.TemplateFormatterConfig Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of wisetime-connector Show documentation
WiseTime Connector Library
There is a newer version: 2.2.6
/*
 * Copyright (c) 2017 Practice Insight Pty Ltd. All Rights Reserved.
 */

package io.wisetime.connector.template;

import com.google.common.base.Preconditions;

/**
 * Immutable configuration for {@link TemplateFormatter}. Already populated with default configuration.
 * If you need to change one value use:
 *
 * ActivityTextTemplateConfig.builder()
 *     .withWindownsClr(true)
 *     .build();
 *
 * @author vadym
 */
public class TemplateFormatterConfig {

  /**
   * Default max length of user activity.
   * @see #getMaxLength()
   */
  public static final int DEFAULT_MAX_LENGTH = 0;
  /**
   * Default flag to use Windows compatible line delimiter.
   * @see #isUseWinclr()
   */
  public static final boolean DEFAULT_USE_WINCLR = false;
  /**
   * Default Freemarker template.
   * @see #getTemplatePath()
   */
  public static final String DEFAULT_TEMPLATE_PATH = "classpath:default-template.ftl";

  private final boolean useWinclr;
  private final int maxLength;
  private final String templatePath;

  private TemplateFormatterConfig(Builder builder) {
    this.useWinclr = builder.winclr;
    this.maxLength = builder.maxLength;
    this.templatePath = builder.templatePath;
  }

  public static Builder builder() {
    return new Builder();
  }

  /**
   * return whether or not use Windows-style CLR (\r\n) instead of \n.
   */
  public boolean isUseWinclr() {
    return useWinclr;
  }

  /**
   * 0 or negative value - no limit. Otherwise activity text return by {@link TemplateFormatter} guaranteed
   * to not exceed provided value (if longer - activity text will end with ...).
   */
  public int getMaxLength() {
    return maxLength;
  }

  /**
   * Path to Freemarker template. It can reference classpath or file system.
   * @see io.wisetime.connector.template.loader.TemplateLoaderHelperFactory
   */
  public String getTemplatePath() {
    return templatePath;
  }

  /**
   * Builder for {@link TemplateFormatterConfig}. Recommended to use:
   * ActivityTextTemplateConfig.builder() to obtain instance.
   */
  public static class Builder {

    private boolean winclr = DEFAULT_USE_WINCLR;
    private int maxLength = DEFAULT_MAX_LENGTH;
    private String templatePath = DEFAULT_TEMPLATE_PATH;

    public Builder withWindowsClr(boolean useWinclr) {
      this.winclr = useWinclr;
      return this;
    }

    public Builder withMaxLength(int maxLength) {
      this.maxLength = maxLength;
      return this;
    }

    public Builder withTemplatePath(String templatePath) {
      this.templatePath = templatePath;
      return this;
    }

    public TemplateFormatterConfig build() {
      Preconditions.checkNotNull(templatePath, "template path is required");
      return new TemplateFormatterConfig(this);
    }
  }
}