ant/org.eclipse.ant.ui/Ant Tools Support/org/eclipse/ant/ui/internal/views/elements/AntNode.java

/*******************************************************************************
 * Copyright (c) 2000, 2003 IBM Corporation and others.
 * All rights reserved. This program and the accompanying materials 
 * are made available under the terms of the Common Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/cpl-v10.html
 * 
 * Contributors:
 *     IBM Corporation - initial API and implementation
 *******************************************************************************/
package org.eclipse.ant.ui.internal.views.elements;


public abstract class AntNode {
	
	private AntNode parent= null;
	private String name= null;
	private String description= null;
	
	/**
	 * Creates a new node with no parent
	 */
	private AntNode() {
	}
	
	/**
	 * Creates a new node with the given name
	 * 
	 * @param name the new node's name
	 */
	public AntNode(String name) {
		this(null, name);
	}
	
	/**
	 * Creates a new node with the given parent and the given name
	 * 
	 * @param parent the new node's parent node
	 * @param name the new node's name
	 */
	public AntNode(AntNode parent, String name) {
		this.parent= parent;
		this.name= name;
	}
	
	/**
	 * Returns this node's parent or <code>null</code> if none.
	 * 
	 * @return AntNode this node's parent node
	 */
	public AntNode getParent() {
		return parent;
	}
	
	/**
	 * Sets this node's parent node to the given node
	 * 
	 * @param parent the parent node
	 */
	public void setParent(AntNode parent) {
		this.parent= parent;
	}
	
	/**
	 * Returns this node's name or <code>null</code> if none. Subclasses which
	 * represent an ant build element that has a required name must override
	 * this method to never return <code>null</code>
	 * 
	 * @return String this node's name or <code>null</code> if the name
	 * attribute is optional for this node.
	 */
	public String getName() {
		return name;
	}
	
	/**
	 * Sets this node's name to the given name
	 * 
	 * @param name the new name
	 */
	public void setName(String name) {
		this.name= name;
	}
	
	public String toString() {
		if (getName() != null) {
			return getName();
		}
		return super.toString();
	}
	
	/**
	 * Sets this node's description to the given description
	 * 
	 * @param description the new description
	 */
	public void setDescription(String description) {
		this.description= description;
	}
	
	/**
	 * Returns this node's description or <code>null</code> if none. Subclasses
	 * which represent an ant build element that has a required description must
	 * override this method to never return <code>null</code>
	 * 
	 * @return String this node's description or <code>null</code> if the
	 * description attribute is optional for this node.
	 */
	public String getDescription() {
		return description;
	}
}