com.github.TKnudsen.ComplexDataObject.data.interfaces.ISelfDescription Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of complex-data-object Show documentation

A library that models real-world objects in Java, referred to as ComplexDataObjects. Other features: IO and preprocessing of ComplexDataObjects.

There is a newer version: 0.2.13

Show newest version

package com.github.TKnudsen.ComplexDataObject.data.interfaces;

/**
 * 
 * Title: ISelfDescription
 * 
 * 
 * 
 * Description: ability to provide textual information about the class and
 * actual instance. Beneficial, e.g., when objects are used in
 * visual-interactive interfaces.
 * 
 * 
 * 
 * Copyright: Copyright (c) 2011-2016
 * 
 * 
 * @author Juergen Bernard
 * @version 1.07
 */
public interface ISelfDescription {

	/**
	 * Short name of the instance that shall describe itself.
	 * 
	 * @return
	 */
	public String getName();

	/**
	 * Long name of the instance that shall describe itself.
	 * 
	 * @return
	 */
	public String getDescription();

	/**
	 * Redundant but beneficial: override toString().
	 * 
	 * @return
	 */
	public abstract String toString();
}