AntObject.java

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

import java.net.URL;

import org.eclipse.ant.core.IAntClasspathEntry;

public abstract class AntObject {

	protected String fClassName;
	protected URL fLibrary;
	protected IAntClasspathEntry fLibraryEntry;
	protected String fName;
	private String fPluginLabel;
	private boolean eclipseRuntime = true;
	private String fURI = null;

	/**
	 * Returns the class name.
	 * 
	 * @return Returns a String
	 */
	public String getClassName() {
		return fClassName;
	}

	/**
	 * Sets the className.
	 * 
	 * @param className
	 *            The className to set
	 */
	public void setClassName(String className) {
		fClassName = className;
	}

	/**
	 * Gets the library.
	 * 
	 * @return Returns a URL
	 * @deprecated use #getLibraryEntry()
	 */
	@Deprecated
	public URL getLibrary() {
		if (fLibrary != null) {
			return fLibrary;
		}
		return fLibraryEntry.getEntryURL();
	}

	/**
	 * Sets the library.
	 * 
	 * @param library
	 *            The library to set
	 * @deprecated use #setLibraryEntry(IAntClasspathEntry)
	 */
	@Deprecated
	public void setLibrary(URL library) {
		fLibrary = library;
	}

	/**
	 * Gets the library classpath entry.
	 * 
	 * @return Returns a classpath entry for the library of this Ant object
	 */
	public IAntClasspathEntry getLibraryEntry() {
		if (fLibraryEntry != null) {
			return fLibraryEntry;
		}
		fLibraryEntry = new AntClasspathEntry(fLibrary);
		return fLibraryEntry;
	}

	/**
	 * Sets the library classpath entry.
	 * 
	 * @param libraryEntry
	 *            The library entry to set
	 */
	public void setLibraryEntry(IAntClasspathEntry libraryEntry) {
		fLibraryEntry = libraryEntry;
	}

	/*
	 * (non-Javadoc)
	 * 
	 * @see java.lang.Object#toString()
	 */
	@Override
	public String toString() {
		if (fURI == null || fURI.equals(IAntCoreConstants.EMPTY_STRING) || fURI.equals("antlib:org.apache.tools.ant")) { //$NON-NLS-1$
			return fName;
		}
		return fURI + ':' + fName;
	}

	/**
	 * Returns whether this Ant object has been created because of an extension point definition.
	 * 
	 * @return boolean
	 */
	public boolean isDefault() {
		return fPluginLabel != null;
	}

	/**
	 * Sets that this Ant object has been created by the appropriate extension point.
	 * 
	 * @param isDefault
	 *            Whether this Ant object has been created because of an extension point definition.
	 * @deprecated Since 3.0 Set the plugin label to indicate a default object
	 */
	@Deprecated
	public void setIsDefault(boolean isDefault) {
		if (!isDefault) {
			fPluginLabel = null;
		}
	}

	/**
	 * Sets the label of the plugin that contributed this Ant object via an extension point.
	 * 
	 * @param pluginLabel
	 *            The label of the plugin
	 * @since 3.0
	 */
	public void setPluginLabel(String pluginLabel) {
		fPluginLabel = pluginLabel;
	}

	/**
	 * Returns the label of the plugin that contributed this Ant object via an extension point.
	 * 
	 * @return pluginLabel The label of the plugin
	 * @since 3.0
	 */
	public String getPluginLabel() {
		return fPluginLabel;
	}

	/**
	 * Returns whether this Ant object requires the Eclipse runtime to be relevant. Defaults value is <code>true</code>
	 * 
	 * @return whether this Ant object requires the Eclipse runtime
	 * @since 3.0
	 */
	public boolean isEclipseRuntimeRequired() {
		return eclipseRuntime;
	}

	public void setEclipseRuntimeRequired(boolean eclipseRuntime) {
		this.eclipseRuntime = eclipseRuntime;
	}

	/**
	 * Returns the URI namespace that this Ant object should live in. Default value is <code>null</code>
	 * 
	 * @return The URI that this Ant object should live in
	 * @since 3.2
	 */
	public String getURI() {
		return fURI;
	}

	public void setURI(String uri) {
		fURI = uri;
	}
}