org.refcodes.mixin.TableBody Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of refcodes-mixin Show documentation
Artifact for mixins of general interest.
There is a newer version: 3.3.8
// /////////////////////////////////////////////////////////////////////////////
// REFCODES.ORG
// /////////////////////////////////////////////////////////////////////////////
// This code is copyright (c) by Siegfried Steiner, Munich, Germany and licensed
// under the following (see "http://en.wikipedia.org/wiki/Multi-licensing")
// licenses:
// -----------------------------------------------------------------------------
// GNU General Public License, v3.0 ("http://www.gnu.org/licenses/gpl-3.0.html")
// -----------------------------------------------------------------------------
// Apache License, v2.0 ("http://www.apache.org/licenses/LICENSE-2.0")
// -----------------------------------------------------------------------------
// Please contact the copyright holding author(s) of the software artifacts in
// question for licensing issues not being covered by the above listed licenses,
// also regarding commercial licensing models or regarding the compatibility
// with other open source licenses.
// /////////////////////////////////////////////////////////////////////////////

package org.refcodes.mixin;

/**
 * Defines the table elements for a table body (with for example the table's
 * rows).
 *
 * @param  The type of the "character", may be a char or a sprite or a byte
 *        array.
 */
public interface TableBody extends BottomDividerEdgeAccessor, BottomRightEdgeAccessor, BottomLeftEdgeAccessor {

	/**
	 * Returns the table body's top left edge character, for example "├" / the
	 * table header's top left edge character, for example "╒".
	 * 
	 * @return The top left edge character.
	 */
	T getLeftEdge();
	
	/**
	 * Returns the table body's top left edge character, for example "├" / the
	 * table header's top left edge character, for example "╒".
	 * 
	 * @return The top left edge character.
	 */
	T getTopLeftEdge();
	
	/**
	 * Returns the table body's top divider edge character, for example "┼" /
	 * the table body's top divider edge character, for example "╤".
	 * 
	 * @return The top left edge character.
	 */
	T getDividerEdge();
	
	/**
	 * Returns the table row's bottom divider edge character, for example "╪"
	 * (head) or "╧" (tail).
	 * 
	 * @return The bottom divider edge character.
	 */
	T getTopDividerEdge();
	
	/**
	 * Returns the table body's top right edge character, for example "┤" / the
	 * table header's top right edge character, for example "╕".
	 * 
	 * @return The top left edge character.
	 */
	T getTopRightEdge();

	/**
	 * Returns the table body's top right edge character, for example "┤" / the
	 * table header's top right edge character, for example "╕".
	 * 
	 * @return The top left edge character.
	 */
	T getRightEdge();

	/**
	 * Returns the table row's left line character, for example "│".
	 * 
	 * @return The left line character.
	 */
	T getLeftLine();

	/**
	 * Returns the table row's divider line character, for example "│".
	 * 
	 * @return The divider line character.
	 */
	T getDividerLine();

	/**
	 * Returns the table row's right line character, for example "│".
	 * 
	 * @return The right line character.
	 */
	T getRightLine();

	/**
	 * Returns the table row's top line character, for example "─" (body) or "═"
	 * (head).
	 * 
	 * @return The top line character.
	 */
	T getTopLine();

}