• Home
• org.asciidoctor
• asciidoctorj-api
• 2.4.0
• source code
• Location.java

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

org.asciidoctor.extension.Location Maven / Gradle / Ivy

package org.asciidoctor.extension;

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 defines the location where the content created by a DocinfoProcessor will be added.
 * 
The following example will add a robots meta tag to the head element of the resulting HTML document:
 * 
 * 
 * @Location(LocationType.HEADER)
 * class RobotsDocinfoProcessor extends DocinfoProcessor {
 *
 *     public static final String META_TAG = "<meta name=\"robots\" content=\"index, follow\"/>";
 *
 *     public String process(Document document) {
 *         return META_TAG;
 *     }
 * }
 * 
 * 
 * 
Applicable for:
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
BlockMacroProcessor
BlockProcessor
BlockProcessor
DocInfoProcessor
✓
IncludeProcessor
InlineMacroProcessor
Postprocessor
Preprocessor
Treeprocessor

 */
@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE)
public @interface Location {

    LocationType value() default LocationType.HEADER;

}