Documented.java

/**
 * (c) 2011, Alejandro Serrano
 * Released under the terms of the EPL.
 */
package net.sf.eclipsefp.haskell.browser.items;

import org.json.JSONObject;

/**
 * Elements in tree that have documentation.
 * 
 * @author Alejandro Serrano
 */
public abstract class Documented {
	String doc;
	
	public abstract String getName();
	public abstract String getCompleteDefinition();

	public String getDoc() {
		return this.doc;
	}

	protected void setDoc(String doc) {
		this.doc = doc;
	}
	
	protected void setDoc(JSONObject o) {
		this.doc = o.optString("doc", "");
		if (this.doc.equals("null"))
			this.doc = "";
	}
	
	/**
	 * do we represent a type?
	 * @return
	 */
	public abstract boolean isType();
}