org.jppf.utils.TextPropertiesTableFormat Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of jppf-common Show documentation

JPPF, the open source grid computing solution

There is a newer version: 6.3-alpha

/*
 * JPPF.
 * Copyright (C) 2005-2015 JPPF Team.
 * http://www.jppf.org
 *
 * 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 org.jppf.utils;


/**
 * Formatter that print the contents of a {@link java.util.Properties Properties} object as a plain-text string.
 * @author Laurent Cohen
 */
public class TextPropertiesTableFormat extends PropertiesTableFormat {
  /**
   * Initialize this formatter with the specified title.
   * @param docTitle the title of the whole document.
   */
  public TextPropertiesTableFormat(final String docTitle) {
    super(docTitle);
  }

  /**
   * Write the prologue for the formatted text.
   */
  @Override
  public void start() {
    sb.append(docTitle).append('\n');
  }

  /**
   * Write the prologue of a table.
   * @param title the title for the table.
   */
  @Override
  public void tableStart(final String title) {
    sb.append("\n\n").append(title).append("\n\n");
  }

  /**
   * Write the prologue of a table row.
   */
  @Override
  public void rowEnd() {
    sb.append('\n');
  }

  /**
   * Write the separator between 2 cells.
   */
  @Override
  public void cellSeparator() {
    sb.append(" = ");
  }
}