org.eclipse.osbp.runtime.common/src/org/eclipse/osbp/runtime/common/annotations/TargetEnumConstraint.java

/**
 * Copyright (c) 2011, 2015 - Lunifera GmbH (Gross Enzersdorf, Austria), Loetz GmbH&Co.KG (69115 Heidelberg, Germany)
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License 2.0 
 * which accompanies this distribution, and is available at
 * https://www.eclipse.org/legal/epl-2.0/
 *
 * SPDX-License-Identifier: EPL-2.0
 *
 * Contributors:
 *         Florian Pirchner - Initial implementation
 */
package org.eclipse.osbp.runtime.common.annotations;

import static java.lang.annotation.ElementType.FIELD;
import static java.lang.annotation.RetentionPolicy.RUNTIME;

import java.lang.annotation.Retention;
import java.lang.annotation.Target;

// TODO: Auto-generated Javadoc
/**
 * This annotation adds a constraint on a relation. Only references to objects
 * are allowed, that match the constraint.
 */
@Target({ FIELD })
@Retention(RUNTIME)
public @interface TargetEnumConstraint {

	/**
	 * The property of the target type of the reference that must match the enum
	 * literal.
	 *
	 * @return the string
	 */
	String targetProperty();

	/**
	 * The enum class used to get the enum literal.
	 *
	 * @return the class
	 */
	Class<?> enumClass();

	/**
	 * The name of the enum literal that is used as a filter.
	 *
	 * @return the string
	 */
	String enumLiteral();

	/**
	 * The compareType used to execute the filter.
	 *
	 * @return the compare type
	 */
	CompareType compareType() default CompareType.EQUALS;

}