AnnotationProposalComputer.java

/*******************************************************************************
 *  Copyright (c) 2012-2014 Pivotal Software Inc.
 *  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:
 *      Pivotal Software Inc. - initial API and implementation
 *******************************************************************************/
package org.springframework.ide.eclipse.quickfix.jdt.computers;

import java.util.ArrayList;
import java.util.List;

import org.eclipse.jdt.core.IAnnotation;
import org.eclipse.jdt.core.JavaModelException;
import org.eclipse.jdt.core.dom.StringLiteral;
import org.eclipse.jdt.internal.core.SourceField;
import org.eclipse.jdt.internal.core.SourceMethod;
import org.eclipse.jdt.internal.core.SourceType;
import org.eclipse.jdt.internal.ui.text.java.JavaCompletionProposalComputer;
import org.eclipse.jdt.ui.text.java.JavaContentAssistInvocationContext;
import org.eclipse.jface.text.contentassist.ICompletionProposal;

/**
 * @author Terry Denney
 * @author Martin Lippert
 * @since 2.6
 */
public abstract class AnnotationProposalComputer extends JavaCompletionProposalComputer {

	/**
	 * Default is to return empty list of proposals. Subclass should overwrite
	 * if proposals are available for methods
	 * @param method
	 * @param value argument value
	 * @param annotation
	 * @param javaContext
	 * @return list of completion proposal for the method and javaContext
	 * @throws JavaModelException
	 */
	protected List<ICompletionProposal> computeCompletionProposals(SourceMethod method, String value,
			IAnnotation annotation, JavaContentAssistInvocationContext javaContext) throws JavaModelException {
		return new ArrayList<ICompletionProposal>();
	}

	/**
	 * Default is to return empty list of proposals. Subclass should overwrite
	 * if proposals are available for methods
	 * @param type
	 * @param value argument value
	 * @param annotation
	 * @param javaContext
	 * @return list of completion proposal for the method and javaContext
	 * @throws JavaModelException
	 */
	protected List<ICompletionProposal> computeCompletionProposals(SourceType type, String value,
			IAnnotation annotation, JavaContentAssistInvocationContext javaContext) throws JavaModelException {
		return new ArrayList<ICompletionProposal>();
	}

	/**
	 * Default is to return empty list of proposals. Subclass should overwrite
	 * if proposals are available for fields
	 * @param field
	 * @param value argument value
	 * @param annotation
	 * @param javaContext
	 * @return list of completion proposal for the field and javaContext
	 * @throws JavaModelException
	 */
	protected List<ICompletionProposal> computeCompletionProposals(SourceField field, String value,
			IAnnotation annotation, JavaContentAssistInvocationContext javaContext) throws JavaModelException {
		return new ArrayList<ICompletionProposal>();
	}

	protected LocationInformation getLocationInformation(StringLiteral value,
			JavaContentAssistInvocationContext javaContext) {
		int startPos = value.getStartPosition();
		int invocationOffset = javaContext.getInvocationOffset();
		String literalValue = value.getLiteralValue();
		int length = invocationOffset - startPos;
		if (length > literalValue.length()) {
			length = literalValue.length();
			invocationOffset = startPos + length;
		}

		if (length >= 0) {
			String filter = literalValue.substring(0, length);
			return new LocationInformation(startPos, invocationOffset, filter, value);
		}
		else {
			return null;
		}
	}

}