[hibernate-commits] Hibernate SVN: r19587 - in validator/trunk: hibernate-validator and 15 other directories.

Saturday, 22 May 2010

Author: hardy.ferentschik
Date: 2010-05-22 08:09:58 -0400 (Sat, 22 May 2010)
New Revision: 19587

Added:
   validator/trunk/hibernate-validator/src/main/javadoc/
   validator/trunk/hibernate-validator/src/main/javadoc/package.html
   validator/trunk/hibernate-validator/src/main/javadoc/resources/
   validator/trunk/hibernate-validator/src/main/javadoc/resources/bkg_blkheader.png
   validator/trunk/hibernate-validator/src/main/javadoc/resources/bkg_gradient.gif
   validator/trunk/hibernate-validator/src/main/javadoc/resources/bkgheader.png
   validator/trunk/hibernate-validator/src/main/javadoc/resources/h1_hdr.png
   validator/trunk/hibernate-validator/src/main/javadoc/stylesheet.css
Modified:
   validator/trunk/hibernate-validator/pom.xml
  
validator/trunk/hibernate-validator/src/main/java/org/hibernate/validator/constraints/impl/package.html
  
validator/trunk/hibernate-validator/src/main/java/org/hibernate/validator/constraints/impl/scriptassert/package.html
  
validator/trunk/hibernate-validator/src/main/java/org/hibernate/validator/constraints/package.html
  
validator/trunk/hibernate-validator/src/main/java/org/hibernate/validator/engine/groups/package.html
  
validator/trunk/hibernate-validator/src/main/java/org/hibernate/validator/engine/package.html
  
validator/trunk/hibernate-validator/src/main/java/org/hibernate/validator/engine/resolver/package.html
  
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
  
validator/trunk/hibernate-validator/src/main/java/org/hibernate/validator/resourceloading/package.html
  
validator/trunk/hibernate-validator/src/main/java/org/hibernate/validator/util/annotationfactory/package.html
  
validator/trunk/hibernate-validator/src/main/java/org/hibernate/validator/util/package.html
  
validator/trunk/hibernate-validator/src/main/java/org/hibernate/validator/util/privilegedactions/package.html
   validator/trunk/pom.xml
Log:
HV-325

Modified: validator/trunk/hibernate-validator/pom.xml
===================================================================

--- validator/trunk/hibernate-validator/pom.xml	2010-05-21 21:20:36 UTC (rev 19586)
+++ validator/trunk/hibernate-validator/pom.xml	2010-05-22 12:09:58 UTC (rev 19587)
@@ -204,6 +204,23 @@
                 </executions>
             </plugin>
             <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-javadoc-plugin</artifactId>
+                <configuration>
+                    <docfilessubdirs>true</docfilessubdirs>
+                   
<stylesheetfile>${basedir}/src/main/javadoc/stylesheet.css</stylesheetfile>
+                    <links>
+                       
<link>http://java.sun.com/j2se/1.5.0/docs/api/</link>
+                       
<link>http://docs.jboss.org/hibernate/stable/beanvalidation/api/</li...
+                    </links>
+                    <packagesheader>Hibernate Validator
Packages</packagesheader>
+                    <doctitle>Hibernate Validator
${project.version}</doctitle>
+                    <windowtitle>Hibernate Validator
${project.version}</windowtitle>
+                    <bottom>
+                        <![CDATA[Copyright &copy; ${inceptionYear}-{currentYear}
<a href="http://redhat.com">Red Hat Middleware, LLC.</a>  All Rights
Reserved]]></bottom>
+                </configuration>
+            </plugin>
+            <plugin>
                 <groupId>org.jboss.maven.plugins</groupId>
                 <artifactId>maven-jdocbook-plugin</artifactId>
                 <extensions>true</extensions>

Modified:
validator/trunk/hibernate-validator/src/main/java/org/hibernate/validator/constraints/impl/package.html
===================================================================
---
validator/trunk/hibernate-validator/src/main/java/org/hibernate/validator/constraints/impl/package.html	2010-05-21
21:20:36 UTC (rev 19586)
+++
validator/trunk/hibernate-validator/src/main/java/org/hibernate/validator/constraints/impl/package.html	2010-05-22
12:09:58 UTC (rev 19587)
@@ -21,7 +21,7 @@
 -->
 </head>
 <body>
-This package contains the implementations of the built-in as well as Hibernate Validator
specific
+Implementations of the built-in as well as Hibernate Validator specific
 constraints.
 </body>
 </html>

Modified:
validator/trunk/hibernate-validator/src/main/java/org/hibernate/validator/constraints/impl/scriptassert/package.html
===================================================================
---
validator/trunk/hibernate-validator/src/main/java/org/hibernate/validator/constraints/impl/scriptassert/package.html	2010-05-21
21:20:36 UTC (rev 19586)
+++
validator/trunk/hibernate-validator/src/main/java/org/hibernate/validator/constraints/impl/scriptassert/package.html	2010-05-22
12:09:58 UTC (rev 19587)
@@ -21,6 +21,6 @@
 -->
 </head>
 <body>
-This package contains classes related to the evaluation of the @ScriptAssert constraint.
+Classes related to the evaluation of the @ScriptAssert constraint.
 </body>
 </html>

Modified:
validator/trunk/hibernate-validator/src/main/java/org/hibernate/validator/constraints/package.html
===================================================================
---
validator/trunk/hibernate-validator/src/main/java/org/hibernate/validator/constraints/package.html	2010-05-21
21:20:36 UTC (rev 19586)
+++
validator/trunk/hibernate-validator/src/main/java/org/hibernate/validator/constraints/package.html	2010-05-22
12:09:58 UTC (rev 19587)
@@ -21,7 +21,7 @@
 -->
 </head>
 <body>
-This package contains the Hibernate Validator specific constraints. Classes in this
package are part of the public Hibernate
+Hibernate Validator specific constraints. Classes in this package are part of the public
Hibernate
 Validator API.
 </body>
 </html>

Modified:
validator/trunk/hibernate-validator/src/main/java/org/hibernate/validator/engine/groups/package.html
===================================================================
---
validator/trunk/hibernate-validator/src/main/java/org/hibernate/validator/engine/groups/package.html	2010-05-21
21:20:36 UTC (rev 19586)
+++
validator/trunk/hibernate-validator/src/main/java/org/hibernate/validator/engine/groups/package.html	2010-05-22
12:09:58 UTC (rev 19587)
@@ -21,6 +21,6 @@
 -->
 </head>
 <body>
-This package contains helper classes for the processing of groups.
+Helper classes for the processing of groups.
 </body>
 </html>

Modified:
validator/trunk/hibernate-validator/src/main/java/org/hibernate/validator/engine/package.html
===================================================================
---
validator/trunk/hibernate-validator/src/main/java/org/hibernate/validator/engine/package.html	2010-05-21
21:20:36 UTC (rev 19586)
+++
validator/trunk/hibernate-validator/src/main/java/org/hibernate/validator/engine/package.html	2010-05-22
12:09:58 UTC (rev 19587)
@@ -21,6 +21,6 @@
 -->
 </head>
 <body>
-This package contains the implementing classes for the core interfaces of JSR-303.
+Implementations for the core interfaces of JSR-303.
 </body>
 </html>

Modified:
validator/trunk/hibernate-validator/src/main/java/org/hibernate/validator/engine/resolver/package.html
===================================================================
---
validator/trunk/hibernate-validator/src/main/java/org/hibernate/validator/engine/resolver/package.html	2010-05-21
21:20:36 UTC (rev 19586)
+++
validator/trunk/hibernate-validator/src/main/java/org/hibernate/validator/engine/resolver/package.html	2010-05-22
12:09:58 UTC (rev 19587)
@@ -21,6 +21,6 @@
 -->
 </head>
 <body>
-This package contains different implementations of the TraversableResolver interface.
+Various implementations of the TraversableResolver interface.
 </body>
 </html>

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-05-21
21:20:36 UTC (rev 19586)
+++
validator/trunk/hibernate-validator/src/main/java/org/hibernate/validator/messageinterpolation/package.html	2010-05-22
12:09:58 UTC (rev 19587)
@@ -22,8 +22,7 @@
 <head>
 </head>
 <body>
-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.
+Implementations of the MessageInterpolator interface in particular
ResourceBundleMessageInterpolator which can be used
+by custom implementations of the interface for delegation. Classes in this package are
part of the public Hibernate Validator API.
 </body>
 </html>

Modified:
validator/trunk/hibernate-validator/src/main/java/org/hibernate/validator/package.html
===================================================================
---
validator/trunk/hibernate-validator/src/main/java/org/hibernate/validator/package.html	2010-05-21
21:20:36 UTC (rev 19586)
+++
validator/trunk/hibernate-validator/src/main/java/org/hibernate/validator/package.html	2010-05-22
12:09:58 UTC (rev 19587)
@@ -22,7 +22,7 @@
 <head>
 </head>
 <body>
-This package contains the classes HibernateValidator and HibernateValidatorConfiguration.
These classes are used to
+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-05-21
21:20:36 UTC (rev 19586)
+++
validator/trunk/hibernate-validator/src/main/java/org/hibernate/validator/resourceloading/package.html	2010-05-22
12:09:58 UTC (rev 19587)
@@ -21,7 +21,6 @@
 -->
 </head>
 <body>
-This package contains the ResourceBundleLocator interface and different implementations.
It is part of the Hibernate
-Validator public API.
+ResourceBundleLocator interface and its various implementations. Part of the Hibernate
Validator public API.
 </body>
 </html>

Modified:
validator/trunk/hibernate-validator/src/main/java/org/hibernate/validator/util/annotationfactory/package.html
===================================================================
---
validator/trunk/hibernate-validator/src/main/java/org/hibernate/validator/util/annotationfactory/package.html	2010-05-21
21:20:36 UTC (rev 19586)
+++
validator/trunk/hibernate-validator/src/main/java/org/hibernate/validator/util/annotationfactory/package.html	2010-05-22
12:09:58 UTC (rev 19587)
@@ -21,6 +21,6 @@
 -->
 </head>
 <body>
-Classes in this package allow to generate annotation proxies.
+Annotation proxy helper.
 </body>
 </html>

Modified:
validator/trunk/hibernate-validator/src/main/java/org/hibernate/validator/util/package.html
===================================================================
---
validator/trunk/hibernate-validator/src/main/java/org/hibernate/validator/util/package.html	2010-05-21
21:20:36 UTC (rev 19586)
+++
validator/trunk/hibernate-validator/src/main/java/org/hibernate/validator/util/package.html	2010-05-22
12:09:58 UTC (rev 19587)
@@ -21,6 +21,6 @@
 -->
 </head>
 <body>
-This package contains independend helper classes.
+Independent helper classes.
 </body>
 </html>

Modified:
validator/trunk/hibernate-validator/src/main/java/org/hibernate/validator/util/privilegedactions/package.html
===================================================================
---
validator/trunk/hibernate-validator/src/main/java/org/hibernate/validator/util/privilegedactions/package.html	2010-05-21
21:20:36 UTC (rev 19586)
+++
validator/trunk/hibernate-validator/src/main/java/org/hibernate/validator/util/privilegedactions/package.html	2010-05-22
12:09:58 UTC (rev 19587)
@@ -21,6 +21,6 @@
 -->
 </head>
 <body>
-Implementations of {@code PrivilegedAction} in order to execute reflection operations in
a security manager.
+Implementations of PrivilegedAction in order to execute reflection operations in a
security manager.
 </body>
 </html>

Added: validator/trunk/hibernate-validator/src/main/javadoc/package.html
===================================================================
--- validator/trunk/hibernate-validator/src/main/javadoc/package.html	                    
   (rev 0)
+++ validator/trunk/hibernate-validator/src/main/javadoc/package.html	2010-05-22 12:09:58
UTC (rev 19587)
@@ -0,0 +1,54 @@
+<body>
+
+<h2>Hibernate Core (native API) JavaDocs</h2>
+
+In addition to  {@link org.hibernate.SessionFactory} and {@link org.hibernate.Session},
applications using the
+Hibernate native API will often need to utilize the following interfaces:<ul>
+    <li>{@link org.hibernate.cfg.Configuration}</li>
+    <li>{@link org.hibernate.Hibernate}</li>
+    <li>{@link org.hibernate.Transaction}</li>
+    <li>{@link org.hibernate.Query}</li>
+    <li>{@link org.hibernate.Criteria}</li>
+    <li>{@link org.hibernate.criterion.Projection}</li>
+    <li>{@link org.hibernate.criterion.Projections}</li>
+    <li>{@link org.hibernate.criterion.Criterion}</li>
+    <li>{@link org.hibernate.criterion.Restrictions}</li>
+    <li>{@link org.hibernate.criterion.Order}</li>
+    <li>{@link org.hibernate.criterion.Example}</li>
+</ul>
+These interfaces are fully intended to be exposed to application code.
+<hr/>
+
+<h3>Extensions</h3>
+Hibernate defines a number of interfaces that are completely intended to be extendable by
application programmers and/or
+integrators.  Listed below is a (not necessarily exhaustive) list of the most commonly
utilized extension points:<ul>
+    <li>{@link org.hibernate.EntityNameResolver}</li>
+    <li>{@link org.hibernate.Interceptor} / {@link
org.hibernate.EmptyInterceptor}</li>
+    <li>{@link org.hibernate.Transaction} / {@link
org.hibernate.transaction.TransactionFactory}</li>
+    <li>{@link org.hibernate.context.CurrentSessionContext}</li>
+    <li>{@link org.hibernate.dialect.Dialect}</li>
+    <li>{@link org.hibernate.dialect.resolver.DialectResolver}</li>
+    <li>{@link org.hibernate.event event listener} interfaces</li>
+    <li>{@link org.hibernate.id.IdentifierGenerator}</li>
+    <li>{@link org.hibernate.tuple.entity.EntityTuplizer} / {@link
org.hibernate.tuple.component.ComponentTuplizer}</li>
+    <li>{@link org.hibernate.type.Type} / {@link
org.hibernate.usertype}</li>
+</ul>
+Note that there is a large degree of crossover between the notion of extension points and
that of an integration SPI (below).
+<hr/>
+
+<h3>Integration SPI</h3>
+Hibernate provides a number of SPIs intended to integrate itself with various third party
frameworks or application code to provide
+additional capabilities.   The SPIs fall mainly into 2 categories:<ul>
+    <li>Caching - {@link org.hibernate.cache.RegionFactory}</li>
+    <li>JDBC Connection management - {@link
org.hibernate.connection.ConnectionProvider}
+</ul>
+Certainly {@link org.hibernate.dialect.Dialect} could fit in here as well, though we
chose to list it under extensions since application
+developers tend to provide extended dialects rather frequently for various reasons.
+<br/>
+Another SPI that is not yet exposed but is planned for such is the <em>bytecode
provider</em> SPI.  See {@link org.hibernate.bytecode}
+for details.
+<hr/>
+
+Complete Hibernate documentation may be found online at <a
href="http://docs.jboss.org/hibernate/">http://docs.jboss.or...;.
+
+</body>
\ No newline at end of file

Added: validator/trunk/hibernate-validator/src/main/javadoc/resources/bkg_blkheader.png
===================================================================
(Binary files differ)


Property changes on:
validator/trunk/hibernate-validator/src/main/javadoc/resources/bkg_blkheader.png
___________________________________________________________________
Name: svn:mime-type
   + application/octet-stream

Added: validator/trunk/hibernate-validator/src/main/javadoc/resources/bkg_gradient.gif
===================================================================
(Binary files differ)


Property changes on:
validator/trunk/hibernate-validator/src/main/javadoc/resources/bkg_gradient.gif
___________________________________________________________________
Name: svn:mime-type
   + application/octet-stream

Added: validator/trunk/hibernate-validator/src/main/javadoc/resources/bkgheader.png
===================================================================
(Binary files differ)


Property changes on:
validator/trunk/hibernate-validator/src/main/javadoc/resources/bkgheader.png
___________________________________________________________________
Name: svn:mime-type
   + application/octet-stream

Added: validator/trunk/hibernate-validator/src/main/javadoc/resources/h1_hdr.png
===================================================================
(Binary files differ)


Property changes on:
validator/trunk/hibernate-validator/src/main/javadoc/resources/h1_hdr.png
___________________________________________________________________
Name: svn:mime-type
   + application/octet-stream

Added: validator/trunk/hibernate-validator/src/main/javadoc/stylesheet.css
===================================================================
--- validator/trunk/hibernate-validator/src/main/javadoc/stylesheet.css	                  
     (rev 0)
+++ validator/trunk/hibernate-validator/src/main/javadoc/stylesheet.css	2010-05-22
12:09:58 UTC (rev 19587)
@@ -0,0 +1,174 @@
+/*
+ * Hibernate, Relational Persistence for Idiomatic Java
+ *
+ * Copyright (c) 2010, Red Hat Inc. or third-party contributors as
+ * indicated by the @author tags or express copyright attribution
+ * statements applied by the authors.  All third-party contributions are
+ * distributed under license by Red Hat Inc.
+ *
+ * This copyrighted material is made available to anyone wishing to use, modify,
+ * copy, or redistribute it subject to the terms and conditions of the GNU
+ * Lesser General Public License, as published by the Free Software Foundation.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
+ * or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public License
+ * for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this distribution; if not, write to:
+ * Free Software Foundation, Inc.
+ * 51 Franklin Street, Fifth Floor
+ * Boston, MA  02110-1301  USA
+ */
+
+/*
+ * Custom Hibernate javadoc style sheet
+ */
+
+/* Page background color */
+body {
+    background: #FFFFFF url(resources/bkg_gradient.gif) repeat-x;
+    margin:0 auto;
+	font-family:'Lucida Grande', Geneva, Verdana, Arial, sans-serif;
+	font-size:12px;
+	padding:0 2em;
+	color:#333;
+
+ }
+
+/* Common elements */
+
+font {
+	font-family: inherit, sans-serif;
+	font-size: inherit;
+	color: inherit;
+	font-weight: inherit;
+}
+
+hr {
+    border-style: none;
+    border-bottom: 1px solid #CCCCCC;
+}
+
+/* Links */
+a:link {
+    color:#003399;
+}
+a:visited {
+    color:#888888;
+}
+a:hover {
+    color:#6699cc;
+}
+a:active {
+    color: #003399;
+}
+
+/* Headings */
+h1 {
+    background: url(resources/h1_hdr.png) no-repeat;
+    line-height:1.2em;
+	color:#586464;
+	font-size:2em;
+	padding:1.5em;
+	margin-top: 0;
+	text-align:left;
+}
+
+h2 {
+	color:#586464;
+}
+
+
+/* Default Table elements and colors */
+
+th, table {
+	border-collapse:collapse;
+	border-color: #E6E7E8;
+}
+
+
+.TableHeadingColor     {
+	background:#000000 url(resources/bkg_blkheader.png) repeat-x scroll left top;
+	color:#FFFFFF;
+	font-size:12px;
+	font-weight:bold;
+	height:31px;
+	text-align:left;
+	padding:1.5em;
+}
+
+.TableHeadingColor th {
+	padding-left: 10px;
+}
+
+
+.TableSubHeadingColor  {
+    background: #ebe7d7;
+}
+.TableRowColor {
+    background: #FFFFFF;
+    border-color: #E6E7E8;
+}
+.TableRowColor td {
+    line-height: 175%;
+    padding-left: 10px;
+}
+
+/* Font used in left-hand frame lists */
+.FrameTitleFont   {
+    font-size: 125%;
+    font-family: Helvetica, Arial, sans-serif;
+    font-weight: bold;
+    margin-top: 1em;
+    display: block;
+}
+.FrameHeadingFont {
+    font-size: 125%;
+    font-family: 'Lucida Grande', Geneva, Verdana, Arial, sans-serif;
+    font-weight: bold;
+    margin-top: 1em;
+    display: block;
+    color:#586464;
+	border-bottom:1px dotted #CCCCCC;
+}
+.FrameItemFont {
+    font-size: 100%;
+    font-family: Helvetica, Arial, sans-serif
+}
+
+/* Navigation bar fonts and colors */
+
+.NavBarCell1    {
+    background: #ffffff url(resources/bkgheader.png) repeat-x;
+    line-height:3em;
+	padding-left:10px;
+	padding-right:10px;
+}
+
+.NavBarFont1 {
+	color: white;
+}
+.NavBarCell1 a {
+	color: white;
+}
+
+.NavBarCell1Rev {
+    background-color:#FFFFFF;
+    padding-left:6px;
+    padding-right:6px;
+}
+.NavBarFont1 {
+    color:#FFFFFF;
+}
+.NavBarFont1Rev {
+    color:#243446;
+}
+
+.NavBarCell2 {
+    background-color:#FFFFFF;
+}
+.NavBarCell3 {
+    background-color:#FFFFFF;
+}

Modified: validator/trunk/pom.xml
===================================================================
--- validator/trunk/pom.xml	2010-05-21 21:20:36 UTC (rev 19586)
+++ validator/trunk/pom.xml	2010-05-22 12:09:58 UTC (rev 19587)
@@ -35,7 +35,7 @@
             <email&gt;gunnar.morling(a)googlemail.com&lt;/email&gt;
             <organization>Individual</organization>
             <url>http://musingsofaprogrammingaddict.blogspot.com/</url>
-        </developer>        
+        </developer>
     </developers>
 
     <mailingLists>
@@ -297,6 +297,11 @@
                     <artifactId>maven-archetype-plugin</artifactId>
                     <version>2.0-alpha-4</version>
                 </plugin>
+                <plugin>
+                    <groupId>org.apache.maven.plugins</groupId>
+                    <artifactId>maven-javadoc-plugin</artifactId>
+                    <version>2.7</version>
+                </plugin>
             </plugins>
         </pluginManagement>
     </build>
@@ -346,26 +351,6 @@
                 <version>2.0.1</version>
             </plugin>
             <plugin>
-                <artifactId>maven-javadoc-plugin</artifactId>
-                <reportSets>
-                    <reportSet>
-                        <id>html</id>
-                        <configuration>
-                            <tags>
-                                <tag>
-                                    <name>todo</name>
-                                    <placement>a</placement>
-                                    <head>ToDo:</head>
-                                </tag>
-                            </tags>
-                        </configuration>
-                        <reports>
-                            <report>javadoc</report>
-                        </reports>
-                    </reportSet>
-                </reportSets>
-            </plugin>
-            <plugin>
                 <groupId>org.codehaus.mojo</groupId>
                 <artifactId>jxr-maven-plugin</artifactId>
             </plugin>


    

2024

2023

2022

2021

2020

2019

2018

2017

2016

2015

2014

2013

2012

2011

2010

2009

2008

2007

2006

[hibernate-commits] Hibernate SVN: r19587 - in validator/trunk: hibernate-validator and 15 other directories.