org.apache.poi.hwpf.model

Class TextPiece

java.lang.Object

org.apache.poi.hwpf.model.PropertyNode<TextPiece>

org.apache.poi.hwpf.model.TextPiece

All Implemented Interfaces:

java.lang.Comparable< TextPiece>, Duplicatable

Direct Known Subclasses:

OldTextPiece, SinglentonTextPiece

@Internal
public class TextPiece
extends PropertyNode<TextPiece>

Lightweight representation of a text piece. Works in the character domain, not the byte domain, so you need to have turned byte references into character references before getting here. (文本片段的轻量级表示。在字符域中工作，而不是在字节域中工作，因此您需要在到达这里之前将字节引用转换为字符引用。)

Field Summary

Fields inherited from class org.apache.poi.hwpf.model.PropertyNode

_buf, EndComparator, StartComparator

Constructor Summary

Constructors

Constructor and Description
TextPiece(int start, int end, byte[] text, PieceDescriptor pd)
TextPiece(int start, int end, byte[] text, PieceDescriptor pd, int cpStart)
TextPiece(TextPiece other)

Method Summary

Modifier and Type	Method and Description
void	adjustForDelete(int start, int length) Deprecated. (已弃用。)
int	bytesLength() Returns the length, in bytes (返回长度，以字节为单位)
int	characterLength() Deprecated. (已弃用。)
TextPiece	copy()
boolean	equals(java.lang.Object o)
int	getCP() Returns the character position we start at. (返回我们开始的字符位置。)
PieceDescriptor	getPieceDescriptor()
byte[]	getRawBytes()
java.lang.StringBuffer	getStringBuffer() Deprecated. (已弃用。)
java.lang.StringBuilder	getStringBuilder()
int	hashCode()
boolean	isUnicode()
java.lang.String	substring(int start, int end) Deprecated. (已弃用。)
java.lang.String	toString()

Methods inherited from class org.apache.poi.hwpf.model.PropertyNode

compareTo, getEnd, getStart, limitsAreEqual, setEnd, setStart

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

TextPiece

public TextPiece(TextPiece other)

TextPiece

public TextPiece(int start,
                 int end,
                 byte[] text,
                 PieceDescriptor pd,
                 int cpStart)

Parameters:

start - Beginning offset in main document stream, in characters. (start - 主文档流中的起始偏移量，以字符为单位。)

end - Ending offset in main document stream, in characters. (end - 主文档流中的结束偏移量，以字符为单位。)

text - The raw bytes of our text instead (text - 我们文本的原始字节)

TextPiece

public TextPiece(int start,
                 int end,
                 byte[] text,
                 PieceDescriptor pd)

Parameters:

start - Beginning offset in main document stream, in characters. (start - 主文档流中的起始偏移量，以字符为单位。)

end - Ending offset in main document stream, in characters. (end - 主文档流中的结束偏移量，以字符为单位。)

text - The raw bytes of our text (text - 我们文本的原始字节)

Method Detail

isUnicode

public boolean isUnicode()

Returns:

If this text piece is unicode (如果此文本是 unicode)

getPieceDescriptor

public PieceDescriptor getPieceDescriptor()

getStringBuffer

@Deprecated
public java.lang.StringBuffer getStringBuffer()

Deprecated. (已弃用。)

getStringBuilder

public java.lang.StringBuilder getStringBuilder()

getRawBytes

public byte[] getRawBytes()

substring

@Deprecated
public java.lang.String substring(int start,
                                              int end)

Deprecated.

Returns part of the string. Works only in characters, not in bytes! (返回字符串的一部分。仅适用于字符，而不适用于字节！)

Parameters:

start - Local start position, in characters (start - 本地开始位置，以字符为单位)

end - Local end position, in characters (end - 本地结束位置，以字符为单位)

adjustForDelete

@Deprecated
public void adjustForDelete(int start,
                                        int length)

Deprecated.

Adjusts the internal string for deletinging some characters within this. (调整内部字符串以删除其中的一些字符。)

Overrides:

adjustForDelete in class PropertyNode<TextPiece>

Parameters:

start - The start position for the delete, in characters (start - 删除的开始位置，以字符为单位)

length - The number of characters to delete (length - 要删除的字符数)

characterLength

@Deprecated
public int characterLength()

Deprecated.

Returns the length, in characters (返回长度，以字符为单位)

bytesLength

public int bytesLength()

Returns the length, in bytes (返回长度，以字节为单位)

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class PropertyNode<TextPiece>

hashCode

public int hashCode()

Overrides:

hashCode in class PropertyNode<TextPiece>

getCP

public int getCP()

Returns the character position we start at. (返回我们开始的字符位置。)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

copy

public TextPiece copy()

Specified by:

copy in interface Duplicatable (复制到界面 Duplicatable)

Specified by:

copy in class PropertyNode<TextPiece> (在类 PropertyNode 中复制 )

Returns:

a deep copy of the implementing class / instance (实现类/实例的深层副本)