[#1704] Document the behaviour of Factory.newRecord(Table<?>, Object),

and Record.from(Object) with respect to UpdatableRecord.store()
This commit is contained in:
Lukas Eder 2012-08-12 11:37:00 +02:00
parent ebec89e97d
commit b6e9e06f20
2 changed files with 13 additions and 0 deletions

View File

@ -966,6 +966,12 @@ public interface FactoryOperations extends Configuration {
* <p>
* This performs roughly the inverse operation of {@link Record#into(Class)}
* <p>
* The resulting record will have its internal "changed" flags set to true
* for all values. This means that {@link UpdatableRecord#store()} will
* perform an <code>INSERT</code> statement. If you wish to store the record
* using an <code>UPDATE</code> statement, use
* {@link #executeUpdate(UpdatableRecord)} instead.
* <p>
* The resulting record is attached to this {@link Configuration} by
* default. Use {@link Settings#isAttachRecords()} to override this
* behaviour.

View File

@ -49,6 +49,7 @@ import javax.persistence.Column;
import org.jooq.exception.DataTypeException;
import org.jooq.exception.MappingException;
import org.jooq.impl.Factory;
import org.jooq.tools.Convert;
import org.jooq.tools.reflect.Reflect;
@ -1275,6 +1276,12 @@ public interface Record extends FieldProvider, Store<Object> {
* <ul>
* <li>primitive types are supported.</li>
* </ul>
* <h3>General notes</h3>
* The resulting record will have its internal "changed" flags set to true
* for all values. This means that {@link UpdatableRecord#store()} will
* perform an <code>INSERT</code> statement. If you wish to store the record
* using an <code>UPDATE</code> statement, use
* {@link Factory#executeUpdate(UpdatableRecord)} instead.
*
* @param source The source object to copy data from
* @throws MappingException wrapping any reflection exception that might