[hibernate-commits] Hibernate SVN: r19328 - in validator/trunk/hibernate-validator/src/main: java/org/hibernate/validator and 2 other directories.

hibernate-commits at lists.jboss.org hibernate-commits at lists.jboss.org
Fri Apr 30 04:43:33 EDT 2010 

Author: hardy.ferentschik
Date: 2010-04-30 04:43:32 -0400 (Fri, 30 Apr 2010)
New Revision: 19328

Added:
   validator/trunk/hibernate-validator/src/main/java/org/hibernate/validator/package.html
Modified:
   validator/trunk/hibernate-validator/src/main/docbook/en-US/modules/furtherreading.xml
   validator/trunk/hibernate-validator/src/main/docbook/en-US/modules/integration.xml
   validator/trunk/hibernate-validator/src/main/java/org/hibernate/validator/messageinterpolation/package.html
   validator/trunk/hibernate-validator/src/main/java/org/hibernate/validator/resourceloading/package.html
Log:
HV-310 Updated package.html files and docs.

Modified: validator/trunk/hibernate-validator/src/main/docbook/en-US/modules/furtherreading.xml
===================================================================
--- validator/trunk/hibernate-validator/src/main/docbook/en-US/modules/furtherreading.xml	2010-04-30 08:11:15 UTC (rev 19327)
+++ validator/trunk/hibernate-validator/src/main/docbook/en-US/modules/furtherreading.xml	2010-04-30 08:43:32 UTC (rev 19328)
@@ -34,9 +34,10 @@
 
   <para>If you have any furhter questions to Hibernate Validator or want to
   share some of your use cases have a look at the <ulink
-  url="http://www.hibernate.org/469.html">Hibernate Validator Wiki</ulink> and
-  the <ulink url="https://forum.hibernate.org/viewforum.php?f=9">Hibernate
-  Validator Forum</ulink>.</para>
+  url="http://community.jboss.org/en/hibernate/validator">Hibernate Validator
+  Wiki</ulink> and the <ulink
+  url="https://forum.hibernate.org/viewforum.php?f=9">Hibernate Validator
+  Forum</ulink>.</para>
 
   <para>In case you would like to report a bug use <ulink
   url="http://opensource.atlassian.com/projects/hibernate/browse/HV">Hibernate's

Modified: validator/trunk/hibernate-validator/src/main/docbook/en-US/modules/integration.xml
===================================================================
--- validator/trunk/hibernate-validator/src/main/docbook/en-US/modules/integration.xml	2010-04-30 08:11:15 UTC (rev 19327)
+++ validator/trunk/hibernate-validator/src/main/docbook/en-US/modules/integration.xml	2010-04-30 08:43:32 UTC (rev 19328)
@@ -26,6 +26,19 @@
   annotated domain model) and checked in various different layers of the
   application.</para>
 
+  <section>
+    <title>OSGi</title>
+
+    <para>The Hibernate Validator jar file is conform to the OSGi
+    specification and can be used within any OSGi container. The classes in
+    the following packages are exported by Hibernate Validator and are
+    considered part of the public API -
+    <package>org.hibernate.validator</package>,
+    <package>org.hibernate.validator.constraints</package>,
+    <package>org.hibernate.validator.messageinterpolation</package> and
+    <package>org.hibernate.validator.resourceloading</package>.</para>
+  </section>
+
   <section id="validator-checkconstraints-db">
     <title>Database schema-level validation</title>
 
@@ -102,7 +115,7 @@
         <title>Manual configuration of
         <classname>BeanValidationEvenListener</classname></title>
 
-        <programlisting role="XML" language="XML">&lt;hibernate-configuration&gt;
+        <programlisting language="XML" role="XML">&lt;hibernate-configuration&gt;
     &lt;session-factory&gt;
        ...
        &lt;property name="javax.persistence.validation.group.pre-persist"&gt;javax.validation.groups.Default&lt;/property&gt;
@@ -124,7 +137,7 @@
     </section>
 
     <section>
-      <title>JPA </title>
+      <title>JPA</title>
 
       <para>If you are using JPA 2 and Hibernate Validator is in the classpath
       the JPA2 specification requires that Bean Validation gets enabled. The
@@ -138,7 +151,7 @@
       <filename>persistence.xml</filename> also defines a node validation-mode
       while can be set to <constant>AUTO</constant>,
       <constant>CALLBACK</constant>, <constant>NONE</constant>. The default is
-      <constant>AUTO</constant>. </para>
+      <constant>AUTO</constant>.</para>
 
       <para>In a JPA 1 you will have to create and register Hibernate
       Validator yourself. In case you are using Hibernate EntityManager you

Modified: validator/trunk/hibernate-validator/src/main/java/org/hibernate/validator/messageinterpolation/package.html
===================================================================
--- validator/trunk/hibernate-validator/src/main/java/org/hibernate/validator/messageinterpolation/package.html	2010-04-30 08:11:15 UTC (rev 19327)
+++ validator/trunk/hibernate-validator/src/main/java/org/hibernate/validator/messageinterpolation/package.html	2010-04-30 08:43:32 UTC (rev 19328)
@@ -20,26 +20,10 @@
 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
 <html>
 <head>
-    <!--
-
-  JBoss, Home of Professional Open Source
-  Copyright 2010, Red Hat, Inc. and/or its affiliates, and individual contributors
-  by the @authors tag. See the copyright.txt in the distribution for a
-  full listing of individual contributors.
-
-  Licensed under the Apache License, Version 2.0 (the "License");
-  you may not use this file except in compliance with the License.
-  You may obtain a copy of the License at
-  http://www.apache.org/licenses/LICENSE-2.0
-  Unless required by applicable law or agreed to in writing, software
-  distributed under the License is distributed on an "AS IS" BASIS,
-  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-  See the License for the specific language governing permissions and
-  limitations under the License.
-
--->
 </head>
 <body>
-This package contains implementations of the MessageInterpolator interface.
+Classes in this package are part of the public Hibernate Validator API. The package contains implementations of the
+MessageInterpolator interface in particular ResourceBundleMessageInterpolator which can be used by custom implementations
+of the interface for delegation.
 </body>
 </html>

Copied: validator/trunk/hibernate-validator/src/main/java/org/hibernate/validator/package.html (from rev 19326, validator/trunk/hibernate-validator/src/main/java/org/hibernate/validator/messageinterpolation/package.html)
===================================================================
--- validator/trunk/hibernate-validator/src/main/java/org/hibernate/validator/package.html	                        (rev 0)
+++ validator/trunk/hibernate-validator/src/main/java/org/hibernate/validator/package.html	2010-04-30 08:43:32 UTC (rev 19328)
@@ -0,0 +1,28 @@
+<!--
+  ~ $Id:$
+  ~
+  ~ JBoss, Home of Professional Open Source
+  ~ Copyright 2010, Red Hat, Inc. and/or its affiliates, and individual contributors
+  ~ by the @authors tag. See the copyright.txt in the distribution for a
+  ~ full listing of individual contributors.
+  ~
+  ~ Licensed under the Apache License, Version 2.0 (the "License");
+  ~ you may not use this file except in compliance with the License.
+  ~ You may obtain a copy of the License at
+  ~ http://www.apache.org/licenses/LICENSE-2.0
+  ~ Unless required by applicable law or agreed to in writing, software
+  ~ distributed under the License is distributed on an "AS IS" BASIS,
+  ~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+  ~ See the License for the specific language governing permissions and
+  ~ limitations under the License.
+  -->
+
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<html>
+<head>
+</head>
+<body>
+This package contains the classes HibernateValidator and HibernateValidatorConfiguration. These classes are used to
+bootstrap and configure Hibernate Validator and form part of the public Hibernate Validator API.
+</body>
+</html>

Modified: validator/trunk/hibernate-validator/src/main/java/org/hibernate/validator/resourceloading/package.html
===================================================================
--- validator/trunk/hibernate-validator/src/main/java/org/hibernate/validator/resourceloading/package.html	2010-04-30 08:11:15 UTC (rev 19327)
+++ validator/trunk/hibernate-validator/src/main/java/org/hibernate/validator/resourceloading/package.html	2010-04-30 08:43:32 UTC (rev 19328)
@@ -21,6 +21,7 @@
 -->
 </head>
 <body>
-This package contains the ResourceBundleLocator interface and different implementations.
+This package contains the ResourceBundleLocator interface and different implementations. It is part of the Hibernate
+Validator public API.
 </body>
 </html>

More information about the hibernate-commits mailing list