001: /*
002: * Licensed to the Apache Software Foundation (ASF) under one or more
003: * contributor license agreements. See the NOTICE file distributed with
004: * this work for additional information regarding copyright ownership.
005: * The ASF licenses this file to You under the Apache License, Version 2.0
006: * (the "License"); you may not use this file except in compliance with
007: * the License. You may obtain a copy of the License at
008: *
009: * http://www.apache.org/licenses/LICENSE-2.0
010: *
011: * Unless required by applicable law or agreed to in writing, software
012: * distributed under the License is distributed on an "AS IS" BASIS,
013: * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014: * See the License for the specific language governing permissions and
015: * limitations under the License.
016: */
017: package org.apache.poi.hslf.record;
018:
019: import java.io.IOException;
020: import java.io.OutputStream;
021:
022: import org.apache.poi.util.LittleEndian;
023: import org.apache.poi.util.StringUtil;
024:
025: /**
026: * A CString (type 4026). Holds a unicode string, and the first two bytes
027: * of the record header normally encode the count. Typically attached to
028: * some complex sequence of records, eg Commetns.
029: *
030: * @author Nick Burch
031: */
032:
033: public class CString extends RecordAtom {
034: private byte[] _header;
035: private static long _type = 4026l;
036:
037: /** The bytes that make up the text */
038: private byte[] _text;
039:
040: /** Grabs the text. */
041: public String getText() {
042: return StringUtil.getFromUnicodeLE(_text);
043: }
044:
045: /** Updates the text in the Atom. */
046: public void setText(String text) {
047: // Convert to little endian unicode
048: _text = new byte[text.length() * 2];
049: StringUtil.putUnicodeLE(text, _text, 0);
050:
051: // Update the size (header bytes 5-8)
052: LittleEndian.putInt(_header, 4, _text.length);
053: }
054:
055: /**
056: * Grabs the count, from the first two bytes of the header.
057: * The meaning of the count is specific to the type of the parent record
058: */
059: public int getCount() {
060: return (int) LittleEndian.getShort(_header);
061: }
062:
063: /**
064: * Sets the count
065: * The meaning of the count is specific to the type of the parent record
066: */
067: public void setCount(int count) {
068: LittleEndian.putShort(_header, (short) count);
069: }
070:
071: /* *************** record code follows ********************** */
072:
073: /**
074: * For the CStrubg Atom
075: */
076: protected CString(byte[] source, int start, int len) {
077: // Sanity Checking
078: if (len < 8) {
079: len = 8;
080: }
081:
082: // Get the header
083: _header = new byte[8];
084: System.arraycopy(source, start, _header, 0, 8);
085:
086: // Grab the text
087: _text = new byte[len - 8];
088: System.arraycopy(source, start + 8, _text, 0, len - 8);
089: }
090:
091: /**
092: * Create an empty CString
093: */
094: public CString() {
095: // 0 length header
096: _header = new byte[] { 0, 0, 0xBA - 256, 0x0f, 0, 0, 0, 0 };
097: // Empty text
098: _text = new byte[0];
099: }
100:
101: /**
102: * We are of type 4026
103: */
104: public long getRecordType() {
105: return _type;
106: }
107:
108: /**
109: * Write the contents of the record back, so it can be written
110: * to disk
111: */
112: public void writeOut(OutputStream out) throws IOException {
113: // Header - size or type unchanged
114: out.write(_header);
115:
116: // Write out our text
117: out.write(_text);
118: }
119:
120: /**
121: * Gets a string representation of this object, primarily for debugging.
122: * @return a string representation of this object.
123: */
124: public String toString() {
125: return getText();
126: }
127: }
|