org.gecko.emf.rest.annotations.AnnotationConverter Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of org.gecko.emf.rest.jakartars Show documentation

Extension to load and save EMF EObjects using a MessageBodyReader or -Writer

There is a newer version: 2.3.0

Show newest version

/**
 * Copyright (c) 2012 - 2022 Data In Motion and others.
 * All rights reserved. 
 * 
 * This program and the accompanying materials are made available under the terms of the 
 * Eclipse Public License v2.0 which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v20.html
 * 
 * Contributors:
 *     Data In Motion - initial API and implementation
 */
package org.gecko.emf.rest.annotations;

import java.lang.annotation.Annotation;
import java.util.Map;

/**
 * API to handle custom Annotations to create EMF Load or Save Options
 * @author Juergen Albert
 * @since 29 May 2018
 */
public interface AnnotationConverter {
	
	
	/**
	 * Checks if the {@link Annotation} can be handled
	 * @param annotation the {@link Annotation} to handle
	 * @param serialize if true, this annotation is used while serializing, false means deserialization
	 * @return true if the converter should be applied.
	 */
	boolean canHandle(Annotation annotation, boolean serialize);
	
	/**
	 * Converts the given {@link Annotation} and adds the Putput to the given options {@link Map}
	 * @param annotation the {@link Annotation} to convert
	 * @param serialize if true, this annotation is used while serializing, false means deserialization
	 * @param options the {@link Map} with the EMF Options
	 */
	void convertAnnotation(Annotation annotation, boolean serialize, Map options);

}