bundles/org.eclipse.core.runtime/src/org/eclipse/core/runtime/model/LibraryModel.java

package org.eclipse.core.runtime.model;

/*
 * (c) Copyright IBM Corp. 2000, 2001.
 * All Rights Reserved.
 */

/**
 * A runtime library declared in a plug-in.  Libraries contribute elements to the search path.
 * These contributions are specified as a path to a directory or Jar file.  This path is always
 * considered to be relative to the containing plug-in.  
 * <p>
 * Libraries are typed.  The type is used to determine to which search path the library's
 * contribution should be added.  The valid types are: <code>CODE</code> and
 * <code>RESOURCE</code>.  
 * </p>
 * <p>
 * This class may be instantiated, or further subclassed.
 * </p>
 */
public class LibraryModel extends PluginModelObject {

	// DTD properties (included in plug-in manifest)
	private String[] exports = null;
	private String type = CODE;

	// transient properties (not included in plug-in manifest)
	private boolean isExported = false;
	private boolean isFullyExported = false;

	/**
	 * Constant string (value "code") indicating the code library type.
	 */
	public static final String CODE = "code";
	
	/**
	 * Constant string (value "resource") indicating the resource library type.
	 */
	public static final String RESOURCE = "resource";
	
/**
 * Creates a new library model in which all fields
 * are <code>null</code>.
 */
public LibraryModel() {}
/**
 * Returns this library's export mask.
 *
 * @return this library's export mask or <code>null</code>
 */
public String[] getExports() {
	return exports;
}
/**
 * Returns this library's type.  
 *
 * @return the type of this library.  The valid types are: <code>CODE</code> and <code>RESOURCE</code>.
 * @see #CODE
 * @see #RESOURCE
 */
public String getType() {
	return type;
}
/**
 * Returns whether or not any of the code in this library is exported.
 *
 * @return whether or not any of the code in this library represents is exported
 */
public boolean isExported() {
	return isExported;
}
/**
 * Returns whether or not all of the code in this library is exported.
 *
 * @return whether or not all of the code in this library is exported
 */
public boolean isFullyExported() {
	return isFullyExported;
}
/**
 * Sets this library's export mask.
 * This object must not be read-only.
 *
 * @param value this library's export mask.  May be <code>null</code>.
 */
public void setExports(String[] value) {
	assertIsWriteable();
	exports = value;
	if (value == null) {
		isExported = false;
		isFullyExported = false;
	} else {
		for (int i = 0; i < value.length; i++) {
			if (!value[i].equals(""))
				isExported = true;
			if (value[i].equals("*"))
				isFullyExported = true;
		}
	}
}
/**
 * Sets this library's type. The valid types are: <code>CODE</code> and <code>RESOURCE</code>.
 * The given type value is canonicalized before being set.
 * This object must not be read-only.
 *
 * @param value the type of this library.
 * @see #CODE
 * @see #RESOURCE
 */
public void setType(String value) {
	assertIsWriteable();
	type = value.toLowerCase();
}
}