Configuration.java

/*
 * Copyright (C) 2011 René Jeschke <rene_jeschke@yahoo.de>
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package io.kaif.kmark;

/**
 * Txtmark configuration.
 *
 * @author René Jeschke <rene_jeschke@yahoo.de>
 * @since 0.7
 */
public class Configuration {

  /**
   * Configuration builder.
   *
   * @author René Jeschke <rene_jeschke@yahoo.de>
   * @since 0.7
   */
  public static class Builder {

    private String encoding = "UTF-8";
    private Decorator decorator = new DefaultDecorator();
    private BlockEmitter codeBlockEmitter = new CodeBlockEmitter();

    /**
     * Constructor.
     */
    Builder() {
      // empty
    }

    /**
     * Sets the character encoding for txtmark.
     * <p>
     * Default: <code>"UTF-8"</code>
     *
     * @param encoding
     *     The encoding
     * @return This builder
     * @since 0.7
     */
    public Builder setEncoding(String encoding) {
      this.encoding = encoding;
      return this;
    }

    /**
     * Sets the code block emitter.
     * <p>
     * Default: <code>null</code>
     *
     * @param emitter
     *     The BlockEmitter
     * @return This builder
     * @see BlockEmitter
     * @since 0.7
     */
    public Builder setCodeBlockEmitter(BlockEmitter emitter) {
      this.codeBlockEmitter = emitter;
      return this;
    }

    /**
     * Builds a configuration instance.
     *
     * @return a Configuration instance
     * @since 0.7
     */
    public Configuration build() {
      return new Configuration(this.encoding, this.decorator, this.codeBlockEmitter);
    }

    public Decorator getDecorator() {
      return decorator;
    }

    /**
     * Sets the decorator for txtmark.
     * <p>
     * Default: <code>DefaultDecorator()</code>
     *
     * @param decorator
     *     The decorator
     * @return This builder
     * @see DefaultDecorator
     * @since 0.7
     */
    public Builder setDecorator(Decorator decorator) {
      this.decorator = decorator;
      return this;
    }
  }

  /**
   * Creates a new Builder instance.
   *
   * @return A new Builder instance.
   */
  public static Builder builder() {
    return new Builder();
  }

  final String encoding;
  final Decorator decorator;
  final BlockEmitter codeBlockEmitter;

  Configuration(String encoding, Decorator decorator, BlockEmitter codeBlockEmitter) {
    this.encoding = encoding;
    this.decorator = decorator;
    this.codeBlockEmitter = codeBlockEmitter;
  }
}