/*******************************************************************************
 * Copyright (c) 2009, 2010 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.jpa.core.internal.resource.java;

import java.util.Map;
import org.eclipse.jdt.core.dom.CompilationUnit;
import org.eclipse.jpt.common.core.utility.TextRange;
import org.eclipse.jpt.jpa.core.resource.java.Annotation;
import org.eclipse.jpt.jpa.core.resource.java.JavaResourceCompilationUnit;
import org.eclipse.jpt.jpa.core.resource.java.JavaResourceNode;
import org.eclipse.jpt.jpa.core.resource.java.JavaResourcePersistentMember;

/**
 * Simplify null annotation classes.
 */
public abstract class NullAnnotation<A extends Annotation>
	extends AbstractJavaResourceNode
	implements Annotation
{
	protected NullAnnotation(JavaResourceNode parent) {
		super(parent);
	}

	public void initialize(CompilationUnit astRoot) {
		// do nothing
	}

	public org.eclipse.jdt.core.dom.Annotation getAstAnnotation(CompilationUnit astRoot) {
		return null;
	}

	public JavaResourceCompilationUnit getJavaResourceCompilationUnit() {
		throw new UnsupportedOperationException();
	}

	public void newAnnotation() {
		throw new UnsupportedOperationException();
	}

	public void removeAnnotation() {
		throw new UnsupportedOperationException();
	}

	public boolean isUnset() {
		throw new UnsupportedOperationException();
	}

	public void storeOn(Map<String, Object> map) {
		// NOP
	}

	public void restoreFrom(Map<String, Object> map) {
		// NOP
	}

	public TextRange getTextRange(CompilationUnit astRoot) {
		return null;
	}

	public void synchronizeWith(CompilationUnit astRoot) {
		throw new UnsupportedOperationException();
	}

	/**
	 * Convenience method: Cast the annotation's parent to a
	 * persistent member.
	 */
	protected JavaResourcePersistentMember getMember() {
		return (JavaResourcePersistentMember) this.parent;
	}

	/**
	 * Convenience method: Add the type or attribute's annotation
	 * and return it.
	 * <p>
	 * Pre-condition: The annotation's parent must be a persistent member
	 * (type or attribute).
	 */
	@SuppressWarnings("unchecked")
	protected A addAnnotation() {
		return (A) this.addAnnotation_();
	}

	protected Annotation addAnnotation_() {
		return this.getMember().addAnnotation(this.getAnnotationName());
	}
}