org.apache.poi.hssf.record.HeaderRecord Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of poi Show documentation

Apache POI - Java API To Access Microsoft Format Files

There is a newer version: 5.2.5

/* ====================================================================
   Licensed to the Apache Software Foundation (ASF) under one or more
   contributor license agreements.  See the NOTICE file distributed with
   this work for additional information regarding copyright ownership.
   The ASF licenses this file to You under the Apache License, Version 2.0
   (the "License"); you may not use this file except in compliance with
   the License.  You may obtain a copy of the License at

       http://www.apache.org/licenses/LICENSE-2.0

   Unless required by applicable law or agreed to in writing, software
   distributed under the License is distributed on an "AS IS" BASIS,
   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   See the License for the specific language governing permissions and
   limitations under the License.
==================================================================== */

package org.apache.poi.hssf.record;

/**
 * Title:        Header Record
 * Description:  Specifies a header for a sheet

 * REFERENCE:  PG 321 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
 * @author Andrew C. Oliver (acoliver at apache dot org)
 * @author Shawn Laubach (slaubach at apache dot org) Modified 3/14/02
 * @author Jason Height (jheight at chariot dot net dot au)
 */
public final class HeaderRecord extends HeaderFooterBase implements Cloneable {
	public final static short sid = 0x0014;

	public HeaderRecord(String text) {
		super(text);
	}

	public HeaderRecord(RecordInputStream in) {
		super(in);
	}

	public String toString() {
		StringBuffer buffer = new StringBuffer();

		buffer.append("[HEADER]\n");
		buffer.append("    .header = ").append(getText()).append("\n");
		buffer.append("[/HEADER]\n");
		return buffer.toString();
	}

	public short getSid() {
		return sid;
	}

	@Override
	public HeaderRecord clone() {
		return new HeaderRecord(getText());
	}
}