SerialClob (Java Platform SE 8 )

java.lang.Object
- javax.sql.rowset.serial.SerialClob

All Implemented Interfaces:

Serializable ， Cloneable ， Clob
```
public class SerialClob
extends Object
implements Clob, Serializable, Cloneable
```
在Java编程语言中的序列化映射为SQL CLOB值。
SerialClob类提供了一个用于从Clob对象创建实例的Clob函数。请注意， Clob对象应该在将SerialClob对象从其构造之前将SQL CLOB的数据带到客户端。 SQL CLOB值的数据可以作为Unicode字符流在客户端上实现。

SerialClob方法使得可以从SerialClob对象获取子SerialClob或找到字符模式的开始。

线程安全

SerialClob不能安全地被多个并发线程使用。如果一个SerialClob要由多个线程使用，则应该通过适当的同步来控制对SerialClob的访问。

另请参见：

Serialized Form

构造方法摘要

构造方法
Constructor and Description
`SerialClob(char[] ch)` 构造一个 `SerialClob`对象，它是给定的 `char`数组的序列化版本。
`SerialClob(Clob clob)` 构造一个 `SerialClob`对象，它是给定的 `Clob`对象的序列化版本。

方法摘要

所有方法接口方法具体的方法
Modifier and Type	Method and Description
`Object`	`clone()` 返回此 `SerialClob`的克隆。
`boolean`	`equals(Object obj)` 将此SerialClob与指定对象进行比较。
`void`	`free()` 此方法可以释放 `SeriableClob`对象并释放它所拥有的资源。
`InputStream`	`getAsciiStream()` 将此 `SerialClob`对象指定的 `CLOB`值作为ascii流 `SerialClob` 。
`Reader`	`getCharacterStream()` 将此 `SerialClob`对象的数据作为Unicode字符流返回。
`Reader`	`getCharacterStream(long pos, long length)` 返回一个包含部分 `SerialClob`值的 `Reader`对象，以pos指定的字符开头，长度为长度字符。
`String`	`getSubString(long pos, int length)` 返回此 `SerialClob`对象中包含的子字符串的副本，从给定位置开始，并继续指定的数字或字符。
`int`	`hashCode()` 返回此 `SerialClob`的哈希码。
`long`	`length()` 检索此 `SerialClob`对象的字符数组中的字符数。
`long`	`position(Clob searchStr, long start)` 返回此 `SerialClob`对象的位置，其中给定的 `Clob`签名开始，在指定位置开始搜索。
`long`	`position(String searchStr, long start)` 返回此 `SerialClob`对象中的位置，给定的 `String`对象开始，开始在指定位置的搜索。
`OutputStream`	`setAsciiStream(long pos)` 检索用于将Ascii字符写入 `SerialClob`对象所代表的 `CLOB`值的流，从位置 `pos`开始。
`Writer`	`setCharacterStream(long pos)` 检索用于将Unicode字符流写入此 `SerialClob`对象表示的 `CLOB`值的流，位置为 `pos` 。
`int`	`setString(long pos, String str)` 将给定的Java `String`写入 `SerialClob`对象表示的 `CLOB`值，位于位置 `pos` 。
`int`	`setString(long pos, String str, int offset, int length)` 写入 `len`的字符 `str` ，起始于字符 `offset`到 `CLOB`值，这 `Clob`表示。
`void`	`truncate(long length)` 截断此 `SerialClob`对象所代表的 `CLOB`值，使其长度为 `len`字符。

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, toString, wait, wait, wait

- 构造方法详细信息
  - SerialClob
```
public SerialClob(char[] ch)
           throws SerialException,
                  SQLException
```
    构造一个SerialClob对象，它是给定的char数组的序列化版本。
    新的SerialClob对象使用char阵列的数据char ，从而允许断开的RowSet对象建立一个序列化的Clob对象，而不用触摸数据源。
    
    参数
    
    ch - 表示要序列化的 Clob对象的char数组
    
    异常
    
    SerialException - 如果在序列化期间发生错误
    
    SQLException - 如果发生SQL错误
  - SerialClob
```
public SerialClob(Clob clob)
           throws SerialException,
                  SQLException
```
    构造一个SerialClob对象，该对象是给定Clob对象的序列化版本。
    新的SerialClob对象使用SerialClob对象的数据进行Clob ; 因此， Clob对象之前应该已经将SQL CLOB的数据从数据库提交给客户端。否则，新的SerialClob对象对象将不包含任何数据。
    
    注意：提供给此构造函数的Clob对象必须为Clob.getCharacterStream()和Clob.getAsciiStream方法返回非空值。这SerialClob构造函数不能序列化Clob在这个实例对象，将抛出SQLException对象。
    
    参数
    
    clob - 要Clob此SerialClob对象的SerialClob对象; 不能为空
    
    异常
    
    SerialException - 如果在序列化期间发生错误
    
    SQLException - 如果在捕获CLOB时发生SQL错误; 如果Clob对象为空; 或者如果满足Clob.getCharacterStream()和Clob.getAsciiStream()的方法Clob返回一个空
    
    另请参见：
    
    Clob
- 方法详细信息
  - length
```
public long length()
            throws SerialException
```
    检索此 SerialClob对象的字符数组中的字符数。
    
    Specified by:
    
    length在界面 Clob
    
    结果
    
    一个 long表示这个 SerialClob对象的字符数组的字符长度
    
    异常
    
    SerialException - 如果发生错误; 如果free以前曾被调用此对象
  - getCharacterStream
```
public Reader getCharacterStream()
                          throws SerialException
```
    将此SerialClob对象的数据作为Unicode字符流返回。与相关方法getAsciiStream不同，无论SerialClob对象是使用Clob对象还是char数组创建，都会生成流。
    
    Specified by:
    
    getCharacterStream在界面 Clob
    
    结果
    
    一个 java.io.Reader此 SerialClob对象数据的 SerialClob对象
    
    异常
    
    SerialException - 如果发生错误; 如果free以前已经被调用了这个对象
    
    另请参见：
    
    Clob.setCharacterStream(long)
  - getAsciiStream
```
public InputStream getAsciiStream()
                           throws SerialException,
                                  SQLException
```
    获取此SerialClob对象指定的CLOB值作为ascii流。此方法转发getAsciiStream呼叫到底层Clob在事件对象，这SerialClob对象被实例化与Clob对象。如果此SerialClob对象使用char数组实例化，则抛出SerialException对象。
    
    Specified by:
    
    getAsciiStream在界面 Clob
    
    结果
    
    一个 java.io.InputStream此 SerialClob对象数据的 SerialClob对象
    
    异常
    
    SerialException - 如果此SerialClob对象未被实例Clob对象; 如果free以前已经被调用了这个对象
    
    SQLException - 如果访问由用于创建此 SerialClob对象的 Clob对象表示的 CLOB值存在错误
    
    另请参见：
    
    Clob.setAsciiStream(long)
  - getSubString
```
public String getSubString(long pos,
                           int length)
                    throws SerialException
```
    返回此 SerialClob对象中包含的子字符串的副本，从给定位置开始，并继续指定的数字或字符。
    
    Specified by:
    
    getSubString在界面 Clob
    
    参数
    
    pos - 要复制的子串中第一个字符的位置; SerialClob对象的第一个字符在位置1 ; 不得小于1 ，并且1的起始位置和长度的总和必须小于此SerialClob对象的长度
    
    length - 要返回的子字符串中的字符数; 不能大于此SerialClob对象的长度，并且子字符串的起始位置和长度之和必须小于此SerialClob对象的长度
    
    结果
    
    一个 String对象，该对象包含该给定位置开始的并包含指定数量的连续字符的 SerialClob对象的子字符串
    
    异常
    
    SerialException - 如果任一参数超出范围; 如果free以前已经被调用了这个对象
  - position
```
public long position(String searchStr,
                     long start)
              throws SerialException,
                     SQLException
```
    返回此SerialClob对象中的位置，给定的String对象开始，开始在指定位置的搜索。如果找不到该模式，此方法返回-1 。
    
    Specified by:
    
    position在界面 Clob
    
    参数
    
    searchStr - 要搜索的 String对象
    
    start - 在此SerialClob对象中的位置开始搜索; 第一名是1 ; 不得小于1也不得大于此SerialClob对象的长度
    
    结果
    
    给定String对象开始的位置，在指定位置开始搜索; -1如果给定的String对象未找到或起始位置超出范围; 返回值的位置编号从1开始
    
    异常
    
    SerialException - 如果 free方法以前是在此对象上调用的
    
    SQLException - 如果从数据库访问Clob值时出错。
  - position
```
public long position(Clob searchStr,
                     long start)
              throws SerialException,
                     SQLException
```
    返回此SerialClob对象的位置，其中给定的Clob签名开始，在指定位置开始搜索。如果找不到该模式，此方法返回-1 。
    
    Specified by:
    
    position在界面 Clob
    
    参数
    
    searchStr - 要搜索的 Clob对象
    
    start - 在此SerialClob对象中的位置开始搜索; 第一名是1 ; 不得小于1也不得大于此SerialClob对象的长度
    
    结果
    
    给定的 Clob对象在指定的起始位置或之后在该 SerialClob对象中开始的位置
    
    异常
    
    SerialException - 如果定位Clob签名出现错误; 如果free方法以前曾被调用此对象
    
    SQLException - 从数据库访问Clob值时是否存在错误
  - setString
```
public int setString(long pos,
                     String str)
              throws SerialException
```
    将给定的Java String写入 SerialClob对象表示的 CLOB值，位于位置 pos 。
    
    Specified by:
    
    setString在界面 Clob
    
    参数
    
    pos - 开始写入这个SerialClob对象所代表的CLOB值的位置; 第一名是1 ; 不得小于1也不得大于此SerialClob对象的长度
    
    str -字符串写入到 CLOB值，这 SerialClob对象表示
    
    结果
    
    写入的字符数
    
    异常
    
    SerialException - 访问CLOB值时是否有错误; 如果设置无效位置; 如果设置了无效的偏移值; 要写入的字节数大于SerialClob长度; 或长度和偏移的组合值大于Clob缓冲区; 如果free方法以前曾被调用此对象
  - setString
```
public int setString(long pos,
                     String str,
                     int offset,
                     int length)
              throws SerialException
```
    写入 len的字符 str ，起始于字符 offset到 CLOB值，这 Clob表示。
    
    Specified by:
    
    setString在界面 Clob
    
    参数
    
    pos - 开始写入此SerialClob对象所代表的CLOB值的位置; 第一名是1 ; 不得低于1也不得大于此SerialClob对象的长度
    
    str - 要写入 Clob对象代表的 CLOB值的字符串
    
    offset - 偏移到 str开始读取要写入的字符
    
    length - 要写入的字符数
    
    结果
    
    写入的字符数
    
    异常
    
    SerialException -如果有访问误差CLOB值; 如果设置无效位置; 如果设置了无效的偏移值; 要写入的字节数大于SerialClob长度; 或长度和偏移的组合值大于Clob缓冲区; 如果free方法以前曾被调用此对象
  - setAsciiStream
```
public OutputStream setAsciiStream(long pos)
                            throws SerialException,
                                   SQLException
```
    检索用于将Ascii字符写入SerialClob对象表示的CLOB值的流，从位置pos开始。此方法转发setAsciiStream()呼叫到底层Clob在事件对象，这SerialClob对象被实例化与Clob对象。如果此SerialClob对象使用char数组实例化，则抛出SerialException对象。
    
    Specified by:
    
    setAsciiStream在界面 Clob
    
    参数
    
    pos - 开始写入 CLOB对象的位置
    
    结果
    
    可以写入ASCII编码字符的流
    
    异常
    
    SerialException - 如果没有使用Clob对象实例化SerialClob; 如果free方法以前曾被调用此对象
    
    SQLException - 访问 CLOB值时是否存在错误
    
    另请参见：
    
    getAsciiStream()
  - setCharacterStream
```
public Writer setCharacterStream(long pos)
                          throws SerialException,
                                 SQLException
```
    检索用于将Unicode字符流写入SerialClob对象所代表的CLOB值的流，位置为pos 。此方法转发setCharacterStream()呼叫到底层Clob在事件对象，这SerialClob对象被实例化与Clob对象。如果此SerialClob对象使用char数组SerialException则抛出SerialException 。
    
    Specified by:
    
    setCharacterStream在界面 Clob
    
    参数
    
    pos - 开始写入 CLOB值的位置
    
    结果
    
    可编写Unicode编码字符的流
    
    异常
    
    SerialException - 如果SerialClob未用Clob对象实例化; 如果free方法以前曾被调用此对象
    
    SQLException - 访问 CLOB值时是否存在错误
    
    另请参见：
    
    getCharacterStream()
  - truncate
```
public void truncate(long length)
              throws SerialException
```
    截断此SerialClob对象所代表的CLOB值，以使其长度为len字符。
    将SerialClob对象SerialClob为0，具有清除其内容的效果。
    
    Specified by:
    
    truncate在界面 Clob
    
    参数
    
    length - 应截断 CLOB值的长度（以字节为单位）
    
    异常
    
    SerialException - 访问CLOB值时是否有错误; 如果free方法以前曾被调用此对象
  - getCharacterStream
```
public Reader getCharacterStream(long pos,
                                 long length)
                          throws SQLException
```
    返回一个包含部分 SerialClob值的 Reader对象，以pos指定的字符开头，长度为长度字符。
    
    Specified by:
    
    getCharacterStream在界面 Clob
    
    参数
    
    pos - 要检索的部分值的第一个字符的偏移量。在第一个字符SerialClob是在位置1。
    
    length - 要检索的部分值的字符长度。
    
    结果
    
    Reader可以读取部分 SerialClob值。
    
    异常
    
    SQLException - 如果pos小于1或pos大于SerialClob中的 SerialClob数，或者如果pos +长度大于SerialClob中的 SerialClob ;
    
    SerialException - 如果 free方法以前是在此对象上调用的
    
    从以下版本开始：
    
    1.6
  - free
```
public void free()
          throws SQLException
```
    此方法可以释放SeriableClob对象并释放其拥有的资源。调用free方法后，该对象无效。
    如果free被多次调用，在后续调用free被视为无操作。
    
    Specified by:
    
    free在界面 Clob
    
    异常
    
    SQLException - 如果发生错误，释放Clob的资源
    
    从以下版本开始：
    
    1.6
  - equals
```
public boolean equals(Object obj)
```
    将此SerialClob与指定对象进行比较。其结果是true当且仅当该参数不是null并且是SerialClob对象，表示相同的字符序列作为该对象。
    
    重写：
    
    equals在类别 Object
    
    参数
    
    obj - 对比这个 SerialClob的对象
    
    结果
    
    true如果给定的对象代表一个 SerialClob相当于此SerialClob， false否则
    
    另请参见：
    
    Object.hashCode() ， HashMap
  - hashCode
```
public int hashCode()
```
    返回这个 SerialClob的哈希码。
    
    重写：
    
    hashCode在类 Object
    
    结果
    
    该对象的哈希码值。
    
    另请参见：
    
    Object.equals(java.lang.Object) ， System.identityHashCode(java.lang.Object)
  - clone
```
public Object clone()
```
    返回此SerialClob的克隆。该副本将包含对内部字符数组的克隆的引用，而不是对此SerialClob对象的原始内部字符数组的引用。底层的Clob对象将被设置为null。
    
    重写：
    
    clone在类别 Object
    
    结果
    
    该SerialClob的克隆
    
    另请参见：
    
    Cloneable

Class SerialClob

线程安全

构造方法摘要

方法摘要

Methods inherited from class java.lang.Object

构造方法详细信息

SerialClob

SerialClob

方法详细信息

length

getCharacterStream

getAsciiStream

getSubString

position

position

setString

setString

setAsciiStream

setCharacterStream

truncate

getCharacterStream

free

equals

hashCode

clone