forked from asciidoctor/asciidoctorj
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
v3 migration guide for 'ast' removed methods
Fixes asciidoctor#1204
- Loading branch information
1 parent
d713177
commit c0eb26f
Showing
4 changed files
with
164 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
160 changes: 160 additions & 0 deletions
160
docs/modules/guides/partials/removal-of-deprecated-methods-in-ast-package.adoc
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,160 @@ | ||
== Removal of deprecated methods in `org.asciidoctor.extension` package | ||
|
||
Several methods under `org.asciidoctor.ast` that were marked as `@Deprecated` have been removed. | ||
The new methods align better with Java naming patterns and are easily identifiable. | ||
|
||
Here follows the list of affected interface, describing for each one the removed methods and the substitutions. | ||
|
||
== Block | ||
|
||
[,java] | ||
.Removed deprecated methods | ||
---- | ||
List<String> lines() | ||
String source() | ||
---- | ||
|
||
[,java] | ||
.Final methods | ||
---- | ||
List<String> getLines() | ||
String getSource() | ||
---- | ||
|
||
== DescriptionList | ||
|
||
[,java] | ||
.Removed deprecated method | ||
---- | ||
String render() | ||
---- | ||
|
||
[,java] | ||
.Final method | ||
---- | ||
String convert() | ||
---- | ||
|
||
== ContentNode | ||
|
||
[,java] | ||
.Removed deprecated methods | ||
---- | ||
String id() | ||
ContentNode parent() | ||
String context() | ||
Document document() | ||
String role() | ||
Object getAttr(Object name, Object defaultValue, boolean inherit) | ||
Object getAttr(Object name, Object defaultValue) | ||
Object getAttr(Object name) | ||
boolean hasAttr(Object name) | ||
boolean hasAttr(Object name, boolean inherited) | ||
boolean isAttr(Object name, Object expected) | ||
boolean isAttr(Object name, Object expected, boolean inherit) | ||
boolean setAttr(Object name, Object value, boolean overwrite) | ||
---- | ||
|
||
[,java] | ||
.Final methods | ||
---- | ||
String getId() | ||
ContentNode getParent() | ||
String getContext() | ||
Document getDocument() | ||
String getRole() | ||
Object getAttribute(Object name, Object defaultValue, boolean inherit) | ||
Object getAttribute(Object name, Object defaultValue) | ||
Object getAttribute(Object name) | ||
boolean hasAttribute(Object name) | ||
boolean hasAttribute(Object name, boolean inherited) | ||
boolean isAttribute(Object name, Object expected) | ||
boolean isAttribute(Object name, Object expected, boolean inherit) | ||
boolean setAttribute(Object name, Object value, boolean overwrite) | ||
---- | ||
|
||
== PhraseNode | ||
|
||
[,java] | ||
.Removed deprecated method | ||
---- | ||
String render() | ||
---- | ||
|
||
[,java] | ||
.Final method | ||
---- | ||
String convert() | ||
---- | ||
|
||
== Section | ||
|
||
On top of the methods replaced by Java getters, both `number` and `getNumber` are replaced by `getNumeral`. | ||
This is done to support non-number numerals. | ||
|
||
[,java] | ||
.Removed deprecated methods | ||
---- | ||
int index() | ||
int number() | ||
int getNumber() | ||
String sectname() | ||
boolean special() | ||
---- | ||
|
||
[,java] | ||
.Final methods | ||
---- | ||
int getIndex() | ||
String getNumeral() | ||
String getSectionName() | ||
boolean isSpecial() | ||
boolean numbered() | ||
boolean isNumbered() | ||
?? getNumber() | ||
---- | ||
|
||
== StructuralNode | ||
|
||
[,java] | ||
.Removed deprecated methods | ||
---- | ||
Object content() | ||
String style() | ||
String title() | ||
List<StructuralNode> blocks() | ||
---- | ||
|
||
.Final methods | ||
---- | ||
Object getContent() | ||
String getStyle() | ||
String getTitle() | ||
List<StructuralNode> getBlocks() | ||
---- | ||
|
||
== List | ||
|
||
[,java] | ||
.Removed deprecated method | ||
---- | ||
String render() | ||
---- | ||
|
||
[,java] | ||
.Final method | ||
---- | ||
String convert() | ||
---- |
2 changes: 1 addition & 1 deletion
2
...modules/guides/partials/removal-of-deprecated-methods-in-extension-package.adoc
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters