/*******************************************************************************
 *  Copyright (c) 2011  Oracle. 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: 
 *  	Oracle - initial API and implementation
 *******************************************************************************/
package org.eclipse.jpt.common.core.utility.jdt;

import org.eclipse.jdt.core.dom.Expression;

/**
 * Provide clients with a pluggable way to manipulate an <i>indexed</i> annotation 
 * element modifying a "declaration".
 * T[] is the type of the object to be passed to and returned by the adapter.
 * T is the sub-value of the value object.
 * 
 * Provisional API: This interface is part of an interim API that is still
 * under development and expected to change significantly before reaching
 * stability. It is available at this early stage to solicit feedback from
 * pioneering adopters on the understanding that any code that uses this API
 * will almost certainly be broken (repeatedly) as the API evolves.
 * 
 * This interface is not intended to be implemented by clients.
 */
public interface IndexedDeclarationAnnotationElementAdapter<T>
		extends DeclarationAnnotationElementAdapter<T[]> {
	
	/**
	 * Given the specified declaration, return the expression for the element's subvalue 
	 * at the given index.
	 * @throws IndexOutOfBoundsException if the index is out of range
	 */
	Expression getSubvalueExpression(int index, ModifiedDeclaration declaration);
}