src/share/classes/javax/sql/rowset/serial/SerialStruct.java

Print this page
rev 10065 : 8046389: Add missing @since tag under javax.sql.**
Reviewed-by:


  40  * structured type. Each attribute that is not already serialized
  41  * is mapped to a serialized form, and if an attribute is itself
  42  * a structured type, each of its attributes that is not already
  43  * serialized is mapped to a serialized form.
  44  * <P>
  45  * In addition, the structured type is custom mapped to a class in the
  46  * Java programming language if there is such a mapping, as are
  47  * its attributes, if appropriate.
  48  * <P>
  49  * The <code>SerialStruct</code> class provides a constructor for creating
  50  * an instance from a <code>Struct</code> object, a method for retrieving
  51  * the SQL type name of the SQL structured type in the database, and methods
  52  * for retrieving its attribute values.
  53  *
  54  * <h3> Thread safety </h3>
  55  *
  56  * A SerialStruct is not safe for use by multiple concurrent threads.  If a
  57  * SerialStruct is to be used by more than one thread then access to the
  58  * SerialStruct should be controlled by appropriate synchronization.
  59  *

  60  */
  61 public class SerialStruct implements Struct, Serializable, Cloneable {
  62 
  63 
  64     /**
  65      * The SQL type name for the structured type that this
  66      * <code>SerialStruct</code> object represents.  This is the name
  67      * used in the SQL definition of the SQL structured type.
  68      *
  69      * @serial
  70      */
  71     private String SQLTypeName;
  72 
  73     /**
  74      * An array of <code>Object</code> instances in  which each
  75      * element is an attribute of the SQL structured type that this
  76      * <code>SerialStruct</code> object represents.  The attributes are
  77      * ordered according to their order in the definition of the
  78      * SQL structured type.
  79      *




  40  * structured type. Each attribute that is not already serialized
  41  * is mapped to a serialized form, and if an attribute is itself
  42  * a structured type, each of its attributes that is not already
  43  * serialized is mapped to a serialized form.
  44  * <P>
  45  * In addition, the structured type is custom mapped to a class in the
  46  * Java programming language if there is such a mapping, as are
  47  * its attributes, if appropriate.
  48  * <P>
  49  * The <code>SerialStruct</code> class provides a constructor for creating
  50  * an instance from a <code>Struct</code> object, a method for retrieving
  51  * the SQL type name of the SQL structured type in the database, and methods
  52  * for retrieving its attribute values.
  53  *
  54  * <h3> Thread safety </h3>
  55  *
  56  * A SerialStruct is not safe for use by multiple concurrent threads.  If a
  57  * SerialStruct is to be used by more than one thread then access to the
  58  * SerialStruct should be controlled by appropriate synchronization.
  59  *
  60  * @since 1.5
  61  */
  62 public class SerialStruct implements Struct, Serializable, Cloneable {
  63 
  64 
  65     /**
  66      * The SQL type name for the structured type that this
  67      * <code>SerialStruct</code> object represents.  This is the name
  68      * used in the SQL definition of the SQL structured type.
  69      *
  70      * @serial
  71      */
  72     private String SQLTypeName;
  73 
  74     /**
  75      * An array of <code>Object</code> instances in  which each
  76      * element is an attribute of the SQL structured type that this
  77      * <code>SerialStruct</code> object represents.  The attributes are
  78      * ordered according to their order in the definition of the
  79      * SQL structured type.
  80      *