HHH-7037 formatting, javadocs

This commit is contained in:
Hardy Ferentschik 2012-03-05 17:03:57 +01:00
parent 211d72b0c1
commit 1657f9f605
6 changed files with 86 additions and 12 deletions

View File

@ -22,6 +22,7 @@
* Boston, MA 02110-1301 USA * Boston, MA 02110-1301 USA
*/ */
package org.hibernate.annotations; package org.hibernate.annotations;
import java.lang.annotation.Retention; import java.lang.annotation.Retention;
import java.lang.annotation.Target; import java.lang.annotation.Target;
@ -35,16 +36,22 @@ import static java.lang.annotation.RetentionPolicy.RUNTIME;
* *
* @author Emmanuel Bernard * @author Emmanuel Bernard
*/ */
@Target({TYPE, METHOD, FIELD}) @Target({ TYPE, METHOD, FIELD })
@Retention(RUNTIME) @Retention(RUNTIME)
public @interface Cache { public @interface Cache {
/** concurrency strategy chosen */
CacheConcurrencyStrategy usage();
/** cache region name */
String region() default "";
/** /**
* whether or not lazy-properties are included in the second level cache * @return Returns the concurrency strategy chosen
* default all, other value: non-lazy */
CacheConcurrencyStrategy usage();
/**
* @return Returns the cache region name
*/
String region() default "";
/**
* @return Returns whether or not lazy-properties are included in the second level cache.
* Default is <i>all</i>, other value: <i>non-lazy</i>.
*/ */
String include() default "all"; String include() default "all";
} }

View File

@ -22,6 +22,7 @@
* Boston, MA 02110-1301 USA * Boston, MA 02110-1301 USA
*/ */
package org.hibernate.annotations; package org.hibernate.annotations;
import java.lang.annotation.Retention; import java.lang.annotation.Retention;
import java.lang.annotation.Target; import java.lang.annotation.Target;
@ -36,7 +37,7 @@ import static java.lang.annotation.RetentionPolicy.RUNTIME;
* *
* @author Emmanuel Bernard * @author Emmanuel Bernard
*/ */
@Target({TYPE, METHOD, FIELD}) @Target({ TYPE, METHOD, FIELD })
@Retention(RUNTIME) @Retention(RUNTIME)
public @interface Check { public @interface Check {
String constraints(); String constraints();

View File

@ -0,0 +1,34 @@
<!--
~ Hibernate, Relational Persistence for Idiomatic Java
~
~ Copyright (c) 2008, Red Hat Middleware LLC 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 Middleware LLC.
~
~ 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
~
-->
<html>
<head></head>
<body>
<p>
This package contains classes related to mapped attributes and associations of a mapped entity. It also contains the
attribute related source implementations.
</p>
</body>
</html>

View File

@ -0,0 +1,33 @@
<!--
~ Hibernate, Relational Persistence for Idiomatic Java
~
~ Copyright (c) 2008, Red Hat Middleware LLC 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 Middleware LLC.
~
~ 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
~
-->
<html>
<head></head>
<body>
<p>
This package contains classes related to mapped entities and their hierarchy structure.
</p>
</body>
</html>

View File

@ -29,8 +29,7 @@ import java.util.List;
/** /**
* @author Steve Ebersole * @author Steve Ebersole
*/ */
public interface ManyToManyPluralAttributeElementSource public interface ManyToManyPluralAttributeElementSource extends PluralAttributeElementSource, CascadeStyleSource {
extends PluralAttributeElementSource, CascadeStyleSource {
public String getReferencedEntityName(); public String getReferencedEntityName();
public String getReferencedEntityAttributeName(); public String getReferencedEntityAttributeName();

View File

@ -26,8 +26,8 @@ package org.hibernate.metamodel.spi.source;
/** /**
* @author Steve Ebersole * @author Steve Ebersole
*/ */
public interface OneToManyPluralAttributeElementSource public interface OneToManyPluralAttributeElementSource extends PluralAttributeElementSource, CascadeStyleSource {
extends PluralAttributeElementSource, CascadeStyleSource {
public String getReferencedEntityName(); public String getReferencedEntityName();
public boolean isNotFoundAnException(); public boolean isNotFoundAnException();
} }