IMetadataItem.java

/**
 * This file Copyright (c) 2005-2008 Aptana, Inc. This program is
 * dual-licensed under both the Aptana Public License and the GNU General
 * Public license. You may elect to use one or the other of these licenses.
 * 
 * This program is distributed in the hope that it will be useful, but
 * AS-IS and WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE, TITLE, or
 * NONINFRINGEMENT. Redistribution, except as permitted by whichever of
 * the GPL or APL you select, is prohibited.
 *
 * 1. For the GPL license (GPL), you can redistribute and/or modify this
 * program under the terms of the GNU General Public License,
 * Version 3, as published by the Free Software Foundation.  You should
 * have received a copy of the GNU General Public License, Version 3 along
 * with this program; if not, write to the Free Software Foundation, Inc., 51
 * Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 * 
 * Aptana provides a special exception to allow redistribution of this file
 * with certain other free and open source software ("FOSS") code and certain additional terms
 * pursuant to Section 7 of the GPL. You may view the exception and these
 * terms on the web at http://www.aptana.com/legal/gpl/.
 * 
 * 2. For the Aptana Public License (APL), this program and the
 * accompanying materials are made available under the terms of the APL
 * v1.0 which accompanies this distribution, and is available at
 * http://www.aptana.com/legal/apl/.
 * 
 * You may view the GPL, Aptana's exception and additional terms, and the
 * APL in the file titled license.html at the root of the corresponding
 * plugin containing this source file.
 * 
 * Any modifications to this file must keep this entire header intact.
 */
package com.aptana.ide.metadata;

import java.io.DataInput;
import java.io.DataOutput;
import java.io.IOException;

/**
 * Represents a metadata item. All metadata items have a set of common fields, like description
 * 
 * @author Ingo Muschenetz
 */
public interface IMetadataItem extends IMetadataDescription
{
	/**
	 * Gets the item name
	 * 
	 * @return The item name
	 */
	String getName();

	/**
	 * Set the name of the item
	 * 
	 * @param name
	 *            The name
	 */
	void setName(String name);

	/**
	 * Gets the item hint
	 * 
	 * @return The item hint
	 */
	String getHint();

	/**
	 * Set the hint of the item
	 * 
	 * @param hint
	 *            The hint
	 */
	void setHint(String hint);

	/**
	 * Read a binary representation of this object
	 * 
	 * @param input
	 * @throws IOException
	 */
	void read(DataInput input) throws IOException;

	/**
	 * Write a binary representation of this object
	 * 
	 * @param output
	 * @throws IOException
	 */
	void write(DataOutput output) throws IOException;

	/**
	 * Adds the current user agent to the list of agents
	 * 
	 * @param agent
	 */
	void addUserAgent(UserAgent agent);

	/**
	 * Returns a list of all the platforms this item is supported by
	 * 
	 * @return Returns a list of all the platforms this item is supported by
	 */
	String[] getUserAgentPlatformNames();

	/**
	 * Set the deprecated description of the item
	 * 
	 * @param string
	 * @param description
	 *            The description
	 */
	void setDeprecatedDescription(String string);
}