Update of /cvsroot/hibernate/Hibernate2/src/net/sf/hibernate/type In directory sc8-pr-cvs1:/tmp/cvs-serv29107/hibernate/type Modified Files: AbstractComponentType.java AbstractType.java AssociationType.java BigDecimalType.java ComponentType.java CompositeCustomType.java CurrencyType.java CustomType.java DiscriminatorType.java DynaBeanType.java EntityType.java IdentifierType.java ImmutableType.java LiteralType.java ManyToOneType.java MutableType.java NullableType.java ObjectType.java OneToOneType.java PersistentCollectionType.java PersistentEnumType.java Type.java TypeFactory.java VersionType.java Log Message: JavaDoc refresh, including @author tags Index: AbstractComponentType.java =================================================================== RCS file: /cvsroot/hibernate/Hibernate2/src/net/sf/hibernate/type/AbstractComponentType.java,v retrieving revision 1.7 retrieving revision 1.8 diff -C2 -d -r1.7 -r1.8 *** AbstractComponentType.java 6 Apr 2003 02:28:58 -0000 1.7 --- AbstractComponentType.java 25 Apr 2003 03:40:37 -0000 1.8 *************** *** 8,11 **** --- 8,16 ---- /** * Enables other Component-like types to hold collections and have cascades, etc. + * + * @see ComponentType + * @see DynaBeanType + * @see ObjectType + * @author Gavin King */ public interface AbstractComponentType extends Type { Index: AbstractType.java =================================================================== RCS file: /cvsroot/hibernate/Hibernate2/src/net/sf/hibernate/type/AbstractType.java,v retrieving revision 1.8 retrieving revision 1.9 diff -C2 -d -r1.8 -r1.9 *** AbstractType.java 6 Apr 2003 10:11:12 -0000 1.8 --- AbstractType.java 25 Apr 2003 03:40:37 -0000 1.9 *************** *** 10,14 **** /** ! * Mapping of the built in Type hierarchy. */ public abstract class AbstractType implements Type { --- 10,15 ---- /** ! * Abstract superclass of the built in Type hierarchy. ! * @author Gavin King */ public abstract class AbstractType implements Type { Index: AssociationType.java =================================================================== RCS file: /cvsroot/hibernate/Hibernate2/src/net/sf/hibernate/type/AssociationType.java,v retrieving revision 1.3 retrieving revision 1.4 diff -C2 -d -r1.3 -r1.4 *** AssociationType.java 5 Jan 2003 02:11:24 -0000 1.3 --- AssociationType.java 25 Apr 2003 03:40:37 -0000 1.4 *************** *** 7,10 **** --- 7,11 ---- * A type that represents some kind of association between entities. * @see net.sf.hibernate.engine.Cascades + * @author Gavin King */ public interface AssociationType { Index: BigDecimalType.java =================================================================== RCS file: /cvsroot/hibernate/Hibernate2/src/net/sf/hibernate/type/BigDecimalType.java,v retrieving revision 1.4 retrieving revision 1.5 diff -C2 -d -r1.4 -r1.5 *** BigDecimalType.java 19 Jan 2003 11:47:08 -0000 1.4 --- BigDecimalType.java 25 Apr 2003 03:40:37 -0000 1.5 *************** *** 48,52 **** /** ! * @see net.sf.hibernate.type.Type#returnedClass() */ public Class getReturnedClass() { --- 48,52 ---- /** ! * @see net.sf.hibernate.type.Type#getReturnedClass() */ public Class getReturnedClass() { Index: ComponentType.java =================================================================== RCS file: /cvsroot/hibernate/Hibernate2/src/net/sf/hibernate/type/ComponentType.java,v retrieving revision 1.13 retrieving revision 1.14 diff -C2 -d -r1.13 -r1.14 *** ComponentType.java 10 Apr 2003 09:49:18 -0000 1.13 --- ComponentType.java 25 Apr 2003 03:40:37 -0000 1.14 *************** *** 25,28 **** --- 25,32 ---- import net.sf.hibernate.util.ReflectHelper; + /** + * Handles "component" mappings + * @author Gavin King + */ public class ComponentType extends AbstractType implements AbstractComponentType { Index: CompositeCustomType.java =================================================================== RCS file: /cvsroot/hibernate/Hibernate2/src/net/sf/hibernate/type/CompositeCustomType.java,v retrieving revision 1.3 retrieving revision 1.4 diff -C2 -d -r1.3 -r1.4 *** CompositeCustomType.java 8 Apr 2003 09:49:34 -0000 1.3 --- CompositeCustomType.java 25 Apr 2003 03:40:37 -0000 1.4 *************** *** 19,22 **** --- 19,26 ---- import net.sf.hibernate.loader.OuterJoinLoader; + /** + * Adapts <tt>CompositeUserType</tt> to <tt>Type</tt> interface + * @author Gavin King + */ public class CompositeCustomType extends AbstractType implements AbstractComponentType { Index: CurrencyType.java =================================================================== RCS file: /cvsroot/hibernate/Hibernate2/src/net/sf/hibernate/type/CurrencyType.java,v retrieving revision 1.4 retrieving revision 1.5 diff -C2 -d -r1.4 -r1.5 *** CurrencyType.java 19 Jan 2003 11:47:08 -0000 1.4 --- CurrencyType.java 25 Apr 2003 03:40:37 -0000 1.5 *************** *** 97,101 **** /** ! * @see net.sf.hibernate.type.Type#returnedClass() */ public Class getReturnedClass() { --- 97,101 ---- /** ! * @see net.sf.hibernate.type.Type#getReturnedClass() */ public Class getReturnedClass() { Index: CustomType.java =================================================================== RCS file: /cvsroot/hibernate/Hibernate2/src/net/sf/hibernate/type/CustomType.java,v retrieving revision 1.8 retrieving revision 1.9 diff -C2 -d -r1.8 -r1.9 *** CustomType.java 6 Apr 2003 10:11:12 -0000 1.8 --- CustomType.java 25 Apr 2003 03:40:37 -0000 1.9 *************** *** 20,23 **** --- 20,24 ---- * * @see net.sf.hibernate.UserType + * @author Gavin King */ *************** *** 71,75 **** /** ! * @see net.sf.hibernate.type.Type#returnedClass() */ public Class getReturnedClass() { --- 72,76 ---- /** ! * @see net.sf.hibernate.type.Type#getReturnedClass() */ public Class getReturnedClass() { Index: DiscriminatorType.java =================================================================== RCS file: /cvsroot/hibernate/Hibernate2/src/net/sf/hibernate/type/DiscriminatorType.java,v retrieving revision 1.3 retrieving revision 1.4 diff -C2 -d -r1.3 -r1.4 *** DiscriminatorType.java 5 Jan 2003 02:11:24 -0000 1.3 --- DiscriminatorType.java 25 Apr 2003 03:40:37 -0000 1.4 *************** *** 4,7 **** --- 4,8 ---- /** * A <tt>Type</tt> that may be used for a discriminator column. + * @author Gavin King */ Index: DynaBeanType.java =================================================================== RCS file: /cvsroot/hibernate/Hibernate2/src/net/sf/hibernate/type/DynaBeanType.java,v retrieving revision 1.5 retrieving revision 1.6 diff -C2 -d -r1.5 -r1.6 *** DynaBeanType.java 6 Apr 2003 02:28:59 -0000 1.5 --- DynaBeanType.java 25 Apr 2003 03:40:37 -0000 1.6 *************** *** 17,20 **** --- 17,24 ---- import net.sf.hibernate.util.ArrayHelper; + /** + * Handles Jakarta commons-beanutils <tt>DynaBean</tt>s + * @author Gavin King + */ public class DynaBeanType extends AbstractType implements AbstractComponentType { *************** *** 42,62 **** - /** - * @see net.sf.hibernate.type.AbstractComponentType#cascade(int) - */ public Cascades.CascadeStyle cascade(int i) { return cascade[i]; } - /** - * @see net.sf.hibernate.type.AbstractComponentType#enableJoinedFetch(int) - */ public int enableJoinedFetch(int i) { return joinedFetch[i]; } - /** - * @see net.sf.hibernate.type.AbstractComponentType#getPropertyNames() - */ public String[] getPropertyNames() { return propertyNames; --- 46,57 ---- *************** *** 73,79 **** } - /** - * @see net.sf.hibernate.type.AbstractComponentType#getPropertyValue(java.lang.Object, int) - */ public Object getPropertyValue(Object component, int i) throws HibernateException { --- 68,71 ---- *************** *** 81,87 **** } - /** - * @see net.sf.hibernate.type.AbstractComponentType#getPropertyValues(java.lang.Object) - */ public Object[] getPropertyValues(Object component) throws HibernateException { --- 73,76 ---- *************** *** 94,107 **** } - /** - * @see net.sf.hibernate.type.AbstractComponentType#getSubtypes() - */ public Type[] getSubtypes() { return propertyTypes; } - /** - * @see net.sf.hibernate.type.AbstractComponentType#instantiate(java.lang.Object) - */ public Object instantiate() throws HibernateException { try { --- 83,90 ---- *************** *** 113,119 **** } - /** - * @see net.sf.hibernate.type.AbstractComponentType#setPropertyValues(java.lang.Object, java.lang.Object) - */ public void setPropertyValues(Object component, Object[] values) throws HibernateException { --- 96,99 ---- *************** *** 124,130 **** } - /** - * @see net.sf.hibernate.type.Type#deepCopy(java.lang.Object) - */ public Object deepCopy(Object component) throws HibernateException { if (component==null) return null; --- 104,107 ---- *************** *** 139,145 **** } - /** - * @see net.sf.hibernate.type.Type#equals(java.lang.Object, java.lang.Object) - */ public boolean equals(Object x, Object y) throws HibernateException { if (x==y) return true; --- 116,119 ---- *************** *** 164,170 **** } - /** - * @see net.sf.hibernate.type.Type#getColumnSpan(net.sf.hibernate.engine.Mapping) - */ public int getColumnSpan(Mapping mapping) throws MappingException { int span = 0; --- 138,141 ---- *************** *** 175,195 **** } - /** - * @see net.sf.hibernate.type.Type#getName() - */ public String getName() { return clazz.getName(); } - /** - * @see net.sf.hibernate.type.Type#hasNiceEquals() - */ public boolean hasNiceEquals() { return false; } - /** - * @see net.sf.hibernate.type.Type#isMutable() - */ public boolean isMutable() { return true; --- 146,157 ---- *************** *** 205,211 **** } - /** - * @see net.sf.hibernate.type.Type#nullSafeGet(java.sql.ResultSet, java.lang.String, net.sf.hibernate.engine.SessionImplementor, java.lang.Object) - */ public Object nullSafeGet( ResultSet rs, --- 167,170 ---- *************** *** 217,223 **** } - /** - * @see net.sf.hibernate.type.Type#nullSafeGet(java.sql.ResultSet, java.lang.String, net.sf.hibernate.engine.SessionImplementor, java.lang.Object) - */ public Object nullSafeGet( ResultSet rs, --- 176,179 ---- *************** *** 251,257 **** } - /** - * @see net.sf.hibernate.type.Type#nullSafeSet(java.sql.PreparedStatement, java.lang.Object, int, net.sf.hibernate.engine.SessionImplementor) - */ public void nullSafeSet( PreparedStatement st, --- 207,210 ---- *************** *** 269,282 **** } - /** - * @see net.sf.hibernate.type.Type#returnedClass() - */ public Class getReturnedClass() { return DynaBean.class; } - /** - * @see net.sf.hibernate.type.Type#sqlTypes(net.sf.hibernate.engine.Mapping) - */ public int[] sqlTypes(Mapping mapping) throws MappingException { //Not called at runtime so doesn't matter if its slow :) --- 222,229 ---- *************** *** 292,298 **** } - /** - * @see net.sf.hibernate.type.Type#toXML(java.lang.Object, net.sf.hibernate.engine.SessionFactoryImplementor) - */ public String toXML(Object value, SessionFactoryImplementor factory) throws HibernateException { --- 239,242 ---- Index: EntityType.java =================================================================== RCS file: /cvsroot/hibernate/Hibernate2/src/net/sf/hibernate/type/EntityType.java,v retrieving revision 1.8 retrieving revision 1.9 diff -C2 -d -r1.8 -r1.9 *** EntityType.java 6 Apr 2003 10:11:12 -0000 1.8 --- EntityType.java 25 Apr 2003 03:40:37 -0000 1.9 *************** *** 15,18 **** --- 15,19 ---- /** * A reference to an entity class + * @author Gavin King */ Index: IdentifierType.java =================================================================== RCS file: /cvsroot/hibernate/Hibernate2/src/net/sf/hibernate/type/IdentifierType.java,v retrieving revision 1.3 retrieving revision 1.4 diff -C2 -d -r1.3 -r1.4 *** IdentifierType.java 5 Jan 2003 02:11:24 -0000 1.3 --- IdentifierType.java 25 Apr 2003 03:40:37 -0000 1.4 *************** *** 4,7 **** --- 4,8 ---- /** * A <tt>Type</tt> that may be used as an identifier. + * @author Gavin King */ public interface IdentifierType extends Type { Index: ImmutableType.java =================================================================== RCS file: /cvsroot/hibernate/Hibernate2/src/net/sf/hibernate/type/ImmutableType.java,v retrieving revision 1.3 retrieving revision 1.4 diff -C2 -d -r1.3 -r1.4 *** ImmutableType.java 5 Jan 2003 02:11:24 -0000 1.3 --- ImmutableType.java 25 Apr 2003 03:40:37 -0000 1.4 *************** *** 6,9 **** --- 6,10 ---- /** * Superclass of nullable immutable types. + * @author Gavin King */ Index: LiteralType.java =================================================================== RCS file: /cvsroot/hibernate/Hibernate2/src/net/sf/hibernate/type/LiteralType.java,v retrieving revision 1.3 retrieving revision 1.4 diff -C2 -d -r1.3 -r1.4 *** LiteralType.java 5 Jan 2003 02:11:24 -0000 1.3 --- LiteralType.java 25 Apr 2003 03:40:37 -0000 1.4 *************** *** 4,7 **** --- 4,8 ---- /** * A type that may appear as an SQL literal + * @author Gavin King */ public interface LiteralType { Index: ManyToOneType.java =================================================================== RCS file: /cvsroot/hibernate/Hibernate2/src/net/sf/hibernate/type/ManyToOneType.java,v retrieving revision 1.6 retrieving revision 1.7 diff -C2 -d -r1.6 -r1.7 *** ManyToOneType.java 6 Apr 2003 10:11:13 -0000 1.6 --- ManyToOneType.java 25 Apr 2003 03:40:37 -0000 1.7 *************** *** 14,19 **** /** * A many-to-one association to an entity */ - public class ManyToOneType extends EntityType implements AssociationType { --- 14,19 ---- /** * A many-to-one association to an entity + * @author Gavin King */ public class ManyToOneType extends EntityType implements AssociationType { Index: MutableType.java =================================================================== RCS file: /cvsroot/hibernate/Hibernate2/src/net/sf/hibernate/type/MutableType.java,v retrieving revision 1.3 retrieving revision 1.4 diff -C2 -d -r1.3 -r1.4 *** MutableType.java 5 Jan 2003 02:11:24 -0000 1.3 --- MutableType.java 25 Apr 2003 03:40:37 -0000 1.4 *************** *** 4,7 **** --- 4,8 ---- /** * Superclass for mutable nullable types + * @author Gavin King */ public abstract class MutableType extends NullableType { Index: NullableType.java =================================================================== RCS file: /cvsroot/hibernate/Hibernate2/src/net/sf/hibernate/type/NullableType.java,v retrieving revision 1.3 retrieving revision 1.4 diff -C2 -d -r1.3 -r1.4 *** NullableType.java 5 Jan 2003 02:11:24 -0000 1.3 --- NullableType.java 25 Apr 2003 03:40:37 -0000 1.4 *************** *** 17,20 **** --- 17,21 ---- /** * Superclass of single-column nullable types. + * @author Gavin King */ public abstract class NullableType extends AbstractType { Index: ObjectType.java =================================================================== RCS file: /cvsroot/hibernate/Hibernate2/src/net/sf/hibernate/type/ObjectType.java,v retrieving revision 1.10 retrieving revision 1.11 diff -C2 -d -r1.10 -r1.11 *** ObjectType.java 11 Apr 2003 07:15:54 -0000 1.10 --- ObjectType.java 25 Apr 2003 03:40:37 -0000 1.11 *************** *** 19,22 **** --- 19,26 ---- import net.sf.hibernate.util.ArrayHelper; + /** + * Handles "any" mappings and the old deprecated "object" type + * @author Gavin King + */ public class ObjectType extends AbstractType implements AbstractComponentType, AssociationType { *************** *** 126,130 **** /** ! * @see net.sf.hibernate.type.Type#returnedClass() */ public Class getReturnedClass() { --- 130,134 ---- /** ! * @see net.sf.hibernate.type.Type#getReturnedClass() */ public Class getReturnedClass() { Index: OneToOneType.java =================================================================== RCS file: /cvsroot/hibernate/Hibernate2/src/net/sf/hibernate/type/OneToOneType.java,v retrieving revision 1.7 retrieving revision 1.8 diff -C2 -d -r1.7 -r1.8 *** OneToOneType.java 6 Apr 2003 10:11:13 -0000 1.7 --- OneToOneType.java 25 Apr 2003 03:40:37 -0000 1.8 *************** *** 15,18 **** --- 15,19 ---- /** * A one-to-one association to an entity + * @author Gavin King */ public class OneToOneType extends EntityType implements AssociationType { Index: PersistentCollectionType.java =================================================================== RCS file: /cvsroot/hibernate/Hibernate2/src/net/sf/hibernate/type/PersistentCollectionType.java,v retrieving revision 1.9 retrieving revision 1.10 diff -C2 -d -r1.9 -r1.10 *** PersistentCollectionType.java 6 Apr 2003 10:11:13 -0000 1.9 --- PersistentCollectionType.java 25 Apr 2003 03:40:37 -0000 1.10 *************** *** 17,20 **** --- 17,25 ---- import net.sf.hibernate.engine.SessionImplementor; + /** + * A type that handles Hibernate <tt>PersistentCollections</tt> and + * arrays. + * @author Gavin King + */ public abstract class PersistentCollectionType extends AbstractType implements AssociationType { Index: PersistentEnumType.java =================================================================== RCS file: /cvsroot/hibernate/Hibernate2/src/net/sf/hibernate/type/PersistentEnumType.java,v retrieving revision 1.5 retrieving revision 1.6 diff -C2 -d -r1.5 -r1.6 *** PersistentEnumType.java 19 Jan 2003 11:47:08 -0000 1.5 --- PersistentEnumType.java 25 Apr 2003 03:40:37 -0000 1.6 *************** *** 17,20 **** --- 17,25 ---- import net.sf.hibernate.util.ReflectHelper; + /** + * A type for Hibernate <tt>PersistentEnum</tt> + * @see net.sf.hibernate.PersistentEnum + * @author Gavin King + */ public class PersistentEnumType extends ImmutableType implements LiteralType { Index: Type.java =================================================================== RCS file: /cvsroot/hibernate/Hibernate2/src/net/sf/hibernate/type/Type.java,v retrieving revision 1.9 retrieving revision 1.10 diff -C2 -d -r1.9 -r1.10 *** Type.java 6 Apr 2003 10:11:13 -0000 1.9 --- Type.java 25 Apr 2003 03:40:37 -0000 1.10 *************** *** 18,21 **** --- 18,22 ---- * <br> * Implementors should usually be immutable and <b>must</b> definately be threadsafe. + * @author Gavin King */ public interface Type extends Serializable { *************** *** 217,221 **** * Retrieve an instance of the mapped class, or the identifier of an entity or collection, from a JDBC resultset. * This is useful for 2-phase property initialization - the second phase is a call to <tt>resolveIdentifier()</tt>. ! * @see Type#resolveIdentifier(Object, SessionImplementor) * @param rs * @param names the column names --- 218,222 ---- * Retrieve an instance of the mapped class, or the identifier of an entity or collection, from a JDBC resultset. * This is useful for 2-phase property initialization - the second phase is a call to <tt>resolveIdentifier()</tt>. ! * @see Type#resolveIdentifier(Object, SessionImplementor, Object) * @param rs * @param names the column names Index: TypeFactory.java =================================================================== RCS file: /cvsroot/hibernate/Hibernate2/src/net/sf/hibernate/type/TypeFactory.java,v retrieving revision 1.7 retrieving revision 1.8 diff -C2 -d -r1.7 -r1.8 *** TypeFactory.java 6 Apr 2003 02:28:59 -0000 1.7 --- TypeFactory.java 25 Apr 2003 03:40:37 -0000 1.8 *************** *** 30,33 **** --- 30,34 ---- * use static methods and constants on <tt>net.sf.hibernate.Hibernate</tt>. * @see net.sf.hibernate.Hibernate + * @author Gavin King */ Index: VersionType.java =================================================================== RCS file: /cvsroot/hibernate/Hibernate2/src/net/sf/hibernate/type/VersionType.java,v retrieving revision 1.3 retrieving revision 1.4 diff -C2 -d -r1.3 -r1.4 *** VersionType.java 5 Jan 2003 02:11:24 -0000 1.3 --- VersionType.java 25 Apr 2003 03:40:37 -0000 1.4 *************** *** 3,6 **** --- 3,7 ---- /** * A <tt>Type</tt> that may be used to version data. + * @author Gavin King */ public interface VersionType extends Type { |