jsweet.lang.Mixin Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of jsweet-core Show documentation

JavaScript API for JSweet

The newest version!

/* 
 * JSweet - http://www.jsweet.org
 * Copyright (C) 2015 CINCHEO SAS 
 * 
 * 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 jsweet.lang;

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 type is used to declare compile-time mixins, which allow for
 * cross-candy interface merging.
 * 
 * 
 * When a mixin targets an interface in another candy, the JSweet transpiler
 * will merge the two interfaces and generate a new one that will precede the
 * two in the classpath.
 * 
 * 
 * This annotation is used for API definitions and most programmers will not
 * have to use it directly.
 */
@Retention(RetentionPolicy.RUNTIME)
@Target({ ElementType.TYPE })
@Documented
public @interface Mixin {
	/**
	 * The target class of this mixin, that it to say the class to which it will
	 * be merged at compile-time so that programmers can use the mixin members
	 * as well.
	 */
	Class target();
}