de.vandermeer.asciitable.v2.themes.V2_RowTheme Maven / Gradle / Ivy

Go to download
/* Copyright 2014 Sven van der Meer 
 *
 * 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 de.vandermeer.asciitable.v2.themes;

import org.apache.commons.lang3.text.StrBuilder;

/**
 * Interface for themes of table rows.
 *
 * @author     Sven van der Meer <[email protected]>
 * @version    v1.0.0 build 160319 (19-Mar-16) for Java 1.7
 * @since      v0.0.3
 */
public interface V2_RowTheme {

	/**
	 * Returns the character for a left border.
	 * @return left border character
	 */
	char getLeftBorder();

	/**
	 * Returns the character for a mid border (top and bottom).
	 * @return mid border character (top and bottom)
	 */
	char getMidBorderAll();

	/**
	 * Returns the character for a mid border (top).
	 * @return mid border character (top)
	 */
	char getMidBorderUp();

	/**
	 * Returns the character for a mid border (bottom).
	 * @return mid border character (bottom)
	 */
	char getMidBorderDown();

	/**
	 * Returns the character for a right border.
	 * @return left right character
	 */
	char getRightBorder();

	/**
	 * Returns the character for a middle position (no border).
	 * @return middle position character
	 */
	char getMid();

	/**
	 * Returns a description of the row theme
	 * @return description
	 */
	Object getDescription();

	/**
	 * Returns a representation of the row theme useful for documentation
	 * @return documentation representation of the row theme
	 */
	StrBuilder toDoc();

}