Fixes asciidoctor#492. Deprecate Processor.CONTENT_MODEL_* and moved @…

…ContentModel to org.asciidoctor.ast.
robertpanzer · Jul 25, 2016 · d759bcd · d759bcd
1 parent 63a2823
commit d759bcd
Show file tree

Hide file tree

Showing 7 changed files with 23 additions and 5 deletions.
diff --git a/...g/asciidoctor/extension/ContentModel.java → ...ava/org/asciidoctor/ast/ContentModel.java b/...g/asciidoctor/extension/ContentModel.java → ...ava/org/asciidoctor/ast/ContentModel.java
@@ -1,4 +1,4 @@
-package org.asciidoctor.extension;
+package org.asciidoctor.ast;
 
 import java.lang.annotation.Documented;
 import java.lang.annotation.ElementType;

diff --git a/asciidoctorj-core/src/main/java/org/asciidoctor/extension/Processor.java b/asciidoctorj-core/src/main/java/org/asciidoctor/extension/Processor.java
@@ -40,42 +40,59 @@ public class Processor {
      * </verbatim>
      * </pre>
      * </p>
+     *
+     * @deprecated Use the annotation {@link ContentModel} instead to describe this Processor
      */
+    @Deprecated
     public static final String CONTENT_MODEL = "content_model";
 
     /**
      * Predefined constant to let Asciidoctor know that this BlockProcessor creates zero or more child blocks.
+     * @deprecated Use {@link ContentModel#COMPOUND} instead.
      */
+    @Deprecated
     public static final String CONTENT_MODEL_COMPOUND = ":compound";
 
     /**
      * Predefined constant to let Asciidoctor know that this BlockProcessor creates simple paragraph content.
+     * @deprecated Use {@link ContentModel#SIMPLE} instead.
      */
+    @Deprecated
     public static final String CONTENT_MODEL_SIMPLE =":simple";
 
     /**
      * Predefined constant to let Asciidoctor know that this BlockProcessor creates literal content.
+     * @deprecated Use {@link ContentModel#VERBATIM} instead.
      */
+    @Deprecated
     public static final String CONTENT_MODEL_VERBATIM =":verbatim";
 
     /**
      * Predefined constant to make Asciidoctor pass through the content unprocessed.
+     * @deprecated Use {@link ContentModel#RAW} instead.
      */
+    @Deprecated
     public static final String CONTENT_MODEL_RAW =":raw";
 
     /**
      * Predefined constant to make Asciidoctor drop the content.
+     * @deprecated Use {@link ContentModel#SKIP} instead.
      */
+    @Deprecated
     public static final String CONTENT_MODEL_SKIP =":skip";
 
     /**
      * Predefined constant to make Asciidoctor not expect any content.
+     * @deprecated Use {@link ContentModel#EMPTY} instead.
      */
+    @Deprecated
     public static final String CONTENT_MODEL_EMPTY =":empty";
 
     /**
      * Predefined constant to make Asciidoctor parse content as attributes.
+     * @deprecated Use {@link ContentModel#ATTRIBUTES} instead.
      */
+    @Deprecated
     public static final String CONTENT_MODEL_ATTRIBUTES =":attributes";
 
 

diff --git a/...core/src/main/java/org/asciidoctor/extension/processorproxies/AbstractProcessorProxy.java b/...core/src/main/java/org/asciidoctor/extension/processorproxies/AbstractProcessorProxy.java
@@ -1,7 +1,7 @@
 package org.asciidoctor.extension.processorproxies;
 
 import org.asciidoctor.ast.impl.ContentNodeImpl;
-import org.asciidoctor.extension.ContentModel;
+import org.asciidoctor.ast.ContentModel;
 import org.asciidoctor.extension.Contexts;
 import org.asciidoctor.extension.DefaultAttribute;
 import org.asciidoctor.extension.DefaultAttributes;

diff --git a/asciidoctorj-core/src/test/groovy/org/asciidoctor/extension/AnnotatedBlockProcessor.groovy b/asciidoctorj-core/src/test/groovy/org/asciidoctor/extension/AnnotatedBlockProcessor.groovy
@@ -1,6 +1,7 @@
 package org.asciidoctor.extension
 
 import groovy.transform.CompileStatic
+import org.asciidoctor.ast.ContentModel
 import org.asciidoctor.ast.StructuralNode
 
 @CompileStatic

diff --git a/asciidoctorj-documentation/src/main/asciidoc/integrator-guide.adoc b/asciidoctorj-documentation/src/main/asciidoc/integrator-guide.adoc
@@ -563,7 +563,7 @@ The AST is built from the following types:
   .. `literal`
   .. `open`
   .. `example`
-  .. `pass``
+  .. `pass`
 
 `org.asciidoctor.ast.List`::
   The list node is the container for ordered and unordered lists.

diff --git a/...entation/src/test/java/org/asciidoctor/integrationguide/extension/YellBlockProcessor.java b/...entation/src/test/java/org/asciidoctor/integrationguide/extension/YellBlockProcessor.java
@@ -2,7 +2,7 @@
 
 import org.asciidoctor.ast.StructuralNode;
 import org.asciidoctor.extension.BlockProcessor;
-import org.asciidoctor.extension.ContentModel;
+import org.asciidoctor.ast.ContentModel;
 import org.asciidoctor.extension.Contexts;
 import org.asciidoctor.extension.Name;
 import org.asciidoctor.extension.Reader;

diff --git a/docs/integrator-guide.adoc b/docs/integrator-guide.adoc
@@ -682,7 +682,7 @@ The AST is built from the following types:
   .. `literal`
   .. `open`
   .. `example`
-  .. `pass``
+  .. `pass`
 
 `org.asciidoctor.ast.List`::
   The list node is the container for ordered and unordered lists.