br.com.objectos.latest.Template Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of objectos-latest Show documentation
The ObjectosLatest annotation processor generates code and helps the generation of Java-release-specific JARs
The newest version!
/*
 * Copyright (C) 2020-2022 Objectos Software LTDA.
 *
 * 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 br.com.objectos.latest;

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;

/**
 * Indicates that the annotated interface should be used as the template for a
 * generated interface. Unlike the case of the {@link Concrete} annotation, the
 * generated interface will not extend the annotated interface.
 *
 * Example
 *
 * 
 * The processing of the following hierarchy:
 *
 * 

 * package com.example;
 * public interface PublicInterface {}
 *
 * @Template(simpleName = "Example", extendsClause = "PublicInterface")
 * interface ExampleJavaAny {
 *   /**
 *    * Method a
 *    */
 *   void a();
 * }
 *
 * @Template.Bridge
 * interface ExampleJava6 extends ExampleJavaAny {}
 *
 * @Template.Bridge
 * interface ExampleJava8 extends ExampleJavaAny {
 *   /**
 *    * Method b
 *    */
 *   void b();
 * }
 * 
 *
 * 
 * Would generate the following interface:
 *
 * 

 * package com.example;
 * import br.com.objectos.latest.Generated;
 * @Generated("br.com.objectos.latest.processor.TemplateProcessor")
 * public interface Example extends PublicInterface {
 *   /**
 *    * Method a
 *    */
 *   void a();
 *
 *   /**
 *    * Method b
 *    */
 *   void b();
 * }
 * 
 *
 * 
 * As the processor would choose, among the available bridges, the one that
 * represents the latest version.
 *
 * @since 2
 */
@Retention(RetentionPolicy.SOURCE)
@Target(ElementType.TYPE)
public @interface Template {

  /**
   * A string value to be added to the generated interface as the
   * {@code extends} clause or the empty string meaning the generated interface
   * will not extend any other interface.
   *
   * @return the {@code extends} clause
   */
  String extendsClause();

  /**
   * The simple name of the generated interface.
   *
   * @return the simple name
   */
  String simpleName();

  /**
   * Indicates that the annotated interface, a subinterface of the template
   * interface, should be considered as a candidate.
   */
  @Documented
  @Retention(RetentionPolicy.SOURCE)
  @Target(ElementType.TYPE)
  public @interface Bridge {}

}