Skip to content

Commit 0c0765d

Browse files
koentsjekoentsje
committed
HBX-2984: Create Reference Guide for Ant
 - Add an example for the 'property' and 'propertySet' configurations Signed-off-by: Koen Aers <[email protected]>
1 parent 3fbb9e6 commit 0c0765d

File tree

7 files changed

+156
-1
lines changed

7 files changed

+156
-1
lines changed

‎ant/docs/examples/classpath/build.xml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@
3434
</target>
3535

3636
<target name="reveng" depends="compile">
37-
<hibernatetool destdir="generated-sources">
37+
<hibernatetool destdir="dummy">
3838
<!-- The classpath to be used by the 'hibernatetool' task to look up additional classes or resources -->
3939
<classpath location="additional/classes"/>
4040
<!-- Dummy configuration, as it is needed for any 'hibernatetool' task -->

‎ant/docs/examples/common/included.xml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,7 @@
3636
<path id="classpath">
3737
<path refid="hibernate-tools.path"/>
3838
<path refid="jdbc-driver.path"/>
39+
<path location="."/>
3940
</path>
4041

4142
<taskdef

‎ant/docs/examples/properties/.gitignore‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
############################################################################
2+
# Hibernate Tools, Tooling for your Hibernate Projects #
3+
# #
4+
# Copyright 2004-2025 Red Hat, Inc. #
5+
# #
6+
# Licensed under the Apache License, Version 2.0 (the "License"); #
7+
# you may not use this file except in compliance with the License. #
8+
# You may obtain a copy of the License at #
9+
# #
10+
# http://www.apache.org/licenses/LICENSE-2.0 #
11+
# #
12+
# Unless required by applicable law or agreed to in writing, software #
13+
# distributed under the License is distributed on an "AS IS" basis, #
14+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. #
15+
# See the License for the specific language governing permissions and #
16+
# limitations under the License. #
17+
############################################################################
18+
*.class

‎ant/docs/examples/properties/HelloExporter.java‎

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
/*
2+
* Hibernate Tools, Tooling for your Hibernate Projects
3+
*
4+
* Copyright 2004-2025 Red Hat, Inc.
5+
*
6+
* Licensed under the Apache License, Version 2.0 (the "License");
7+
* you may not use this file except in compliance with the License.
8+
* You may obtain a copy of the License at
9+
*
10+
* http://www.apache.org/licenses/LICENSE-2.0
11+
*
12+
* Unless required by applicable law or agreed to in writing, software
13+
* distributed under the License is distributed on an "AS IS" basis,
14+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15+
* See the License for the specific language governing permissions and
16+
* limitations under the License.
17+
*/
18+
import org.hibernate.tool.api.export.Exporter;
19+
20+
import java.util.Properties;
21+
22+
public class HelloExporter implements Exporter {
23+
24+
private Properties properties = new Properties();
25+
26+
@Override
27+
public Properties getProperties() {
28+
return properties;
29+
}
30+
31+
@Override
32+
public void start() {
33+
System.out.println("Hello, " + getGreetedOne());
34+
}
35+
36+
private Object getGreetedOne() {
37+
Object result = getProperties().get("greetedOne");
38+
return (result == null ? "World" : result) + "!" ;
39+
}
40+
}

‎ant/docs/examples/properties/README.md‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
<!--
2+
~ Copyright 2004 - 2025 Red Hat, Inc.
3+
~
4+
~ Licensed under the Apache License, Version 2.0 (the "License");
5+
~ you may not use this file except in compliance with the License.
6+
~ You may obtain a copy of the License at
7+
~
8+
~ http://www.apache.org/licenses/LICENSE-2.0
9+
~
10+
~ Unless required by applicable law or agreed to in writing, software
11+
~ distributed under the License is distributed on an "AS IS" basis,
12+
~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13+
~ See the License for the specific language governing permissions and
14+
~ limitations under the License.
15+
-->
16+
To run this example:
17+
- Have [Apache Ant](https://ant.apache.org) installed
18+
- Issue `ant` from a command-line window

‎ant/docs/examples/properties/build.xml‎

Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
<!--
2+
~ Copyright 2004 - 2025 Red Hat, Inc.
3+
~
4+
~ Licensed under the Apache License, Version 2.0 (the "License");
5+
~ you may not use this file except in compliance with the License.
6+
~ You may obtain a copy of the License at
7+
~
8+
~ http://www.apache.org/licenses/LICENSE-2.0
9+
~
10+
~ Unless required by applicable law or agreed to in writing, software
11+
~ distributed under the License is distributed on an "AS IS" basis,
12+
~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13+
~ See the License for the specific language governing permissions and
14+
~ limitations under the License.
15+
-->
16+
<project name="properties" default="reveng">
17+
18+
<!-- Include the 'hibernatetool' task definition from the file '../common/included.xml' -->
19+
<include file="../common/included.xml"/>
20+
21+
<target name="clean">
22+
<!-- Delete the compiled class for 'HelloExporter.java' if it exists -->
23+
<delete file="HelloExporter.class"/>
24+
</target>
25+
26+
<target name="compile" depends="clean">
27+
<!-- Compile the custom exporter 'HelloExporter.java' -->
28+
<javac classpathref="classpath" srcdir="." />
29+
</target>
30+
31+
<target name="reveng" depends="compile">
32+
<!-- Property to use in the propertySet case -->
33+
<property name="thingOne" value="Bar"/>
34+
<echo message="First try without any property set"/>
35+
<hibernatetool destdir="dummy">
36+
<!-- Dummy configuration, as it is needed for any 'hibernatetool' task -->
37+
<configuration />
38+
<!-- Custom exporter 'HelloExporter' will say 'Hello, World!' -->
39+
<hbmtemplate exporterclass="HelloExporter"/>
40+
</hibernatetool>
41+
<echo message="Now try with a property element: 'greetedOne' is set to 'Foo'"/>
42+
<hibernatetool destdir="dummy">
43+
<!-- <property> element to be used by the HelloExporter below -->
44+
<property key="greetedOne" value="Foo"/>
45+
<!-- Dummy configuration, as it is needed for any 'hibernatetool' task -->
46+
<configuration />
47+
<!-- Custom exporter of class 'HelloExporter' to be found on the specified classpath -->
48+
<hbmtemplate exporterclass="HelloExporter"/>
49+
</hibernatetool>
50+
<echo message="Lastly try with a propertySet element: 'greetedOne' is set to 'Bar'"/>
51+
<hibernatetool destdir="dummy">
52+
<!-- <propertySet> element to be used by the HelloExporter below -->
53+
<!-- The property 'thingOne' defined above is mapped to 'greetedOne' and subsequently used -->
54+
<propertySet>
55+
<propertyref prefix="thing"/>
56+
<mapper type="glob" from="thing*" to="greeted*"/>
57+
</propertySet>
58+
<!-- Dummy configuration, as it is needed for any 'hibernatetool' task -->
59+
<configuration />
60+
<!-- Custom exporter of class 'HelloExporter' to be found on the specified classpath -->
61+
<hbmtemplate exporterclass="HelloExporter"/>
62+
</hibernatetool>
63+
</target>
64+
65+
</project>
66+

‎ant/docs/reference-guide.md‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -123,6 +123,18 @@ for classes and/or resources that are used e.g. by the configured exporters.
123123
All the usual configuration possibilities for [Ant path-like structures](https://ant.apache.org/manual/using.html#path)
124124
are applicable.
125125

126+
### 1.2.4 The `<property>` and `<propertySet>` elements
127+
128+
129+
130+
### 1.2.5 The Configuration Elements
131+
132+
133+
134+
### 1.2.6 The Exporter Elements
135+
136+
137+
126138
## 2. The Hibernate Tools Configurations
127139

128140
The reverse engineering and generation of artefacts with Hibernate Tools is based on a

0 commit comments

Comments
 (0)