/*******************************************************************************
*   Copyright 2012 Analog Devices, Inc.
*
*   Licensed under the Apache License, Version 2.0 (the "License");
*   you may not use this file except in compliance with the License.
*   You may obtain a copy of the License at
*
*       http://www.apache.org/licenses/LICENSE-2.0
*
*   Unless required by applicable law or agreed to in writing, software
*   distributed under the License is distributed on an "AS IS" BASIS,
*   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
*   See the License for the specific language governing permissions and
*   limitations under the License.
********************************************************************************/

package com.analog.lyric.util.misc;

import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * This annotation is used to mark public Java members that are expected to be invoked
 * directly from MATLAB. Such members cannot be removed or refactored without taking its
 * potential MATLAB use into account. When applied to a class, the assumption should be that
 * all or most of its public members may be accessed from MATLAB.
 * <p>
 * @see #wrapper()
 */
@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.CONSTRUCTOR, ElementType.FIELD, ElementType.METHOD, ElementType.TYPE})
public @interface Matlab
{
	/**
	 * If non-empty, specifies the name of the MATLAB wrapper function to be used to convert
	 * instances of the annotated type or its subclasses.
	 * <p>
	 * This attribute is only applicable for annotations on classes.
	 * @since 0.08
	 */
	public String wrapper() default "";
}
