Skip to content

Commit

Permalink
Update the plugins used to generate the spec to their latest versions
Browse files Browse the repository at this point in the history
Note that the final release of the 2.0.0 plugin has different defaults
and requirements for setting things like the image dir.

The configuration and the documents have been adjusted for that.

Signed-off-by: arjantijms <[email protected]>
  • Loading branch information
arjantijms authored and lukasj committed Sep 4, 2023
1 parent d4e2dc1 commit feda7e3
Show file tree
Hide file tree
Showing 8 changed files with 41 additions and 33 deletions.
44 changes: 26 additions & 18 deletions spec/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -18,59 +18,65 @@
-->

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>

<parent>
<groupId>org.eclipse.ee4j</groupId>
<artifactId>project</artifactId>
<version>1.0.6</version>
<relativePath/>
</parent>
<modelVersion>4.0.0</modelVersion>

<groupId>jakarta.xml.bind</groupId>
<artifactId>xml-binding-spec</artifactId>
<version>4.0-SNAPSHOT</version>
<packaging>pom</packaging>
<version>4.0</version>
<name>Jakarta XML Binding Specification</name>

<properties>
<site.output.dir>${project.build.directory}/staging</site.output.dir>
<maven.site.skip>true</maven.site.skip>
<asciidoctor.maven.plugin.version>2.2.4</asciidoctor.maven.plugin.version>
<asciidoctorj.pdf.version>2.3.9</asciidoctorj.pdf.version>
<spec.name>jakarta-${project.artifactId}-${project.version}</spec.name>
<!-- status: DRAFT, BETA, etc., or blank for final -->
<status>DRAFT</status>
<maven.build.timestamp.format>MMMM dd, yyyy</maven.build.timestamp.format>
<revisiondate>${maven.build.timestamp}</revisiondate>
</properties>
<name>Jakarta XML Binding Specification</name>

<scm>
<connection>scm:git:git://github.com/eclipse-ee4j/jaxb-api.git</connection>
<developerConnection>scm:git:[email protected]:eclipse-ee4j/jaxb-api.git</developerConnection>
<url>https://github.com/eclipse-ee4j/jaxb-api.git</url>
<tag>HEAD</tag>
</scm>

<distributionManagement>
<site>
<url>scm:git:[email protected]:eclipse-ee4j/jaxb-api.git</url>
</site>
</distributionManagement>

<properties>
<site.output.dir>${project.build.directory}/staging</site.output.dir>
<maven.site.skip>true</maven.site.skip>
<asciidoctor.maven.plugin.version>2.2.4</asciidoctor.maven.plugin.version>
<asciidoctorj.pdf.version>2.3.9</asciidoctorj.pdf.version>
<spec.name>jakarta-${project.artifactId}-${project.version}</spec.name>
<!-- status: DRAFT, BETA, etc., or blank for final -->
<status>DRAFT</status>
<maven.build.timestamp.format>MMMM dd, yyyy</maven.build.timestamp.format>
<revisiondate>${maven.build.timestamp}</revisiondate>
</properties>

<build>
<defaultGoal>package</defaultGoal>
<plugins>
<!-- Sets minimal Maven version -->
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-enforcer-plugin</artifactId>
<version>3.4.0</version>
<executions>
<execution>
<id>enforce-versions</id>
<id>enforce-env</id>
<goals>
<goal>enforce</goal>
</goals>
<configuration>
<rules>
<requireMavenVersion>
<version>3.6.0</version>
</requireMavenVersion>
<requireJavaVersion>
<version>[11,)</version>
<message>You need Java SE 11 or newer</message>
Expand Down Expand Up @@ -146,12 +152,14 @@
<configuration>
<sourceDocumentName>${project.artifactId}.adoc</sourceDocumentName>
<attributes>
<revnumber>${project.version}</revnumber>
<sourceDirectory>${basedir}/src/main/asciidoc</sourceDirectory>
<imagesdir>images</imagesdir>
<source-highlighter>coderay</source-highlighter>
<revremark>${status}</revremark>
<revdate>${revisiondate}</revdate>
<revnumber>${project.version}</revnumber>
</attributes>
</configuration>

</plugin>
<!--
This is the rule that builds the zip file for download.
Expand Down
2 changes: 1 addition & 1 deletion spec/src/main/asciidoc/appH-binary_data.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -243,5 +243,5 @@ schema customization @attachmentRef of <jaxb:property>, specified in

.JAXB marshal/unmarshalling of optimized binary content.
[[opbin]]
image::images/xmlb-23.svg[image]
image::xmlb-23.png[image]

2 changes: 1 addition & 1 deletion spec/src/main/asciidoc/ch01-introduction.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -120,7 +120,7 @@ to check incoming XML documents for validity with respect to the
schema. +

.Binding XML to Java objects
image::images/xmlb-2.svg[image]
image::xmlb-2.png[image]

To sum up: Schemas describe the structure and
meaning of an XML document, in much the same way that a class describes
Expand Down
4 changes: 2 additions & 2 deletions spec/src/main/asciidoc/ch03-architecture.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ between concepts introduced in this section.

.Non-Normative Jakarta XML Binding Architecture diagram
[[a210]]
image::images/xmlb-3.svg[image]
image::xmlb-3.png[image]

JAXB-annotated classes are common to both
binding schemes. They are either generated by a schema compiler or the
Expand All @@ -62,7 +62,7 @@ within the schema or they can appear in an external binding file that is
associated with the source schema.

.JAXB 1.0 style binding of schema to interface/implementation classes.
image::images/xmlb-4.svg[image]
image::xmlb-4.png[image]

Note that the application accesses only the
schema-derived interfaces, factory methods and `jakarta.xml.bind` APIs
Expand Down
12 changes: 6 additions & 6 deletions spec/src/main/asciidoc/ch05-java_representation.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -636,7 +636,7 @@ value.

.States of a Property Value
[[a623]]
image::images/xmlb-8.svg[image]
image::xmlb-8.png[image]

*_Example:_* +
In the purchase order schema, the `partNum`
Expand Down Expand Up @@ -873,13 +873,13 @@ illustrate the binding changes for the following schema fragment:
----

.JAXB 1.0: isA Relationship between generated element interface and its type
image::images/xmlb-9.svg[image]
image::xmlb-9.png[image]

.Jakarta XML Binding: hasA Relationship between element instance and its type as described in <<Named Java Element instance>>
image::images/xmlb-10.svg[image]
image::xmlb-10.png[image]

.Jakarta XML Binding: hasA Relationship between generated element class and its type as described in <<Java Element Class>>
image::images/xmlb-11.svg[image]
image::xmlb-11.png[image]

While a JAXB 1.0 Element interface implemented its type’s interface,
a Jakarta XML Binding Element instance has a
Expand All @@ -902,10 +902,10 @@ Java components introduced in this section are reflected in the
following diagram.

.UML diagram of Java Representationfootnote:[See next figure fordefault binding for anonymous type definition.]
image::images/xmlb-12.svg[image]
image::xmlb-12.png[image]

.UML diagram when xs:element is bound to schema-derived Element class
image::images/xmlb-13.svg[image]
image::xmlb-13.png[image]

See also <<table614>>.

Expand Down
6 changes: 3 additions & 3 deletions spec/src/main/asciidoc/ch06-binding_xml_schema.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -107,7 +107,7 @@ The base type is derived upon the XML
built-in type hierarchy [XSD PART2, Section 3] reproduced below.

.XML Built-In Type Hierarchy
image::images/xmlb-15.png[image]
image::xmlb-15.png[image]


The above diagram is the same as the one in
Expand Down Expand Up @@ -1045,7 +1045,7 @@ illustrated in <<a999>>.

.Binding for a reference to a model group definition.
[[a999]]
image::images/xmlb-16.svg[image]
image::xmlb-16.png[image]

This binding style results in the same
properties occurring within both Java value class’s A and C to represent
Expand Down Expand Up @@ -1155,7 +1155,7 @@ is bound to a Java value class with the name _FooBar_. The following
figure illustrates this example.

.Default binding for anonymous type def within a model group definition.
image::images/xmlb-17.svg[image]
image::xmlb-17.png[image]


Note that even customization specified Java
Expand Down
2 changes: 1 addition & 1 deletion spec/src/main/asciidoc/ch07-customize_xml_schema.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -287,7 +287,7 @@ applies only to the schema element that was annotated with the binding
declaration.

.Scoping Inheritance and Overriding For Binding Declarations
image:images/xmlb-18.svg[image]
image::xmlb-18.png[image]

The different scopes form a taxonomy. The
taxonomy defines both the inheritance and overriding semantics of
Expand Down
2 changes: 1 addition & 1 deletion spec/src/main/asciidoc/xml-binding-spec.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
ifdef::backend-pdf[]
:pagenums:
:numbered:
:title-logo-image: image:images/jakarta_ee_logo_schooner_color_stacked_default.png[pdfwidth=4.25in,align=right]
:title-logo-image: image:jakarta_ee_logo_schooner_color_stacked_default.png[pdfwidth=4.25in,align=right]
endif::[]

// == License
Expand Down

0 comments on commit feda7e3

Please sign in to comment.