com.acrolinx.sidebar.pojo.document.externalcontent.ExternalContentBuilder Maven / Gradle / Ivy

Go to download
/* Copyright (c) 2018 Acrolinx GmbH */
package com.acrolinx.sidebar.pojo.document.externalcontent;

import java.util.ArrayList;
import java.util.List;

/** This serves as a builder to create an object of External content */
public class ExternalContentBuilder {
  private List textReplacements = new ArrayList<>();
  private List entities = new ArrayList<>();
  private List ditaReferences = new ArrayList<>();
  private List xincludeReferences = new ArrayList<>();

  public ExternalContentBuilder() {
    // nothing required here
  }

  /**
   * External content which doesn't require parsing.
   *
   * @param id Key of referenced entity
   * @param content Resolved content of entity
   * @return ExternalContentBuilder
   */
  public ExternalContentBuilder addTextReplacement(String id, String content) {
    this.textReplacements.add(new ExternalContentField(id, content));
    return this;
  }

  /**
   * External content which requires parsing.
   *
   * @param id Key of referenced entity
   * @param content Resolved content of entity
   * @return ExternalContentBuilder
   */
  public ExternalContentBuilder addEntity(String id, String content) {
    this.entities.add(new ExternalContentField(id, content));
    return this;
  }

  /** External content which requires parsing. */
  public ExternalContentBuilder addEntity(ExternalContentField externalContentField) {
    this.entities.add(externalContentField);
    return this;
  }

  /**
   * Dita references like conref, keyref, conkeyref which represent a placeholder for external
   * content. Content will be parsed.
   *
   * @param id Key of referenced entity
   * @param content Resolved content of entity
   * @return ExternalContentBuilder
   */
  public ExternalContentBuilder addDitaReference(String id, String content) {
    this.ditaReferences.add(new ExternalContentField(id, content));
    return this;
  }

  /**
   * Dita references like conref, keyref, conkeyref which represent a placeholder for external
   * content. Content will be parsed.
   */
  public ExternalContentBuilder addDitaReference(ExternalContentField externalContentField) {
    this.ditaReferences.add(externalContentField);
    return this;
  }

  /**
   * XInclude references
   *
   * @param id Key of referenced entity
   * @param content Resolved content of entity
   * @return ExternalContentBuilder
   */
  public ExternalContentBuilder addXIncludeReference(String id, String content) {
    this.xincludeReferences.add(new ExternalContentField(id, content));
    return this;
  }

  /**
   * Get the external content object.
   *
   * @return ExternalContent
   */
  public ExternalContent build() {
    return new ExternalContent(textReplacements, entities, ditaReferences, xincludeReferences);
  }
}